Skip to content

Consolidate documentation into a canonical reading path and centralize the specification#62

Open
tryblackjack wants to merge 1 commit intomainfrom
codex/stabilize-ai-hpp-documentation
Open

Consolidate documentation into a canonical reading path and centralize the specification#62
tryblackjack wants to merge 1 commit intomainfrom
codex/stabilize-ai-hpp-documentation

Conversation

@tryblackjack
Copy link
Copy Markdown
Owner

Motivation

  • Transform a fragmented set of notes into a single, sequentially readable technical standard so readers can follow architecture → controls → governance → protocol → case studies → certification.
  • Remove duplicate normative statements and ensure a single source of truth for governance requirements and protocol semantics.
  • Make the repository easier for implementers to follow by exposing a concise developer entry point and lightweight ecosystem scaffolding.

Description

  • Rewrote README.md to be a concise gateway with project overview, a clear link to docs/index.md, and a developer entry pointer to developer/quick-start.md and the ecosystem/examples directories.
  • Rebuilt docs/index.md into the canonical reading path with 1–2 sentence explanations and explicit transitions between architecture, controls, governance, protocol, case studies, and certification.
  • Centralized normative governance requirements into docs/control-framework.md (introduced CF-1..CF-5 control IDs and RFC-style keywords) and converted docs/cognitive-safety.md, docs/identity-persona-control.md, docs/tool-authorization.md, docs/multi-agent-governance.md, and docs/audit-logging.md into interpretation/guidance documents that reference the canonical controls rather than repeating them.
  • Consolidated the canonical protocol and evidence model into spec/ai_hpp_specification.md and aligned companion spec and ecosystem documents (spec/terminology.md, spec/scientific_validation_protocol.md, ecosystem/spec/ai_hpp_protocol.md) to reference the canonical spec; normalized docs/case-studies.md to a consistent incident template and tightened certification wording in docs/certification-levels.md.

Testing

  • Ran python3 scripts/check_empty_md.py which returned OK and found no disallowed empty or near-empty markdown files.
  • Ran python3 scripts/check_links.py which reported that local relative markdown links look good.

Codex Task

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e7e77f2895

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


- **CF-2.1** Agents **MUST** disclose that they are synthetic systems when interacting as AI personas or assistants.
- **CF-2.2** Agents **MUST NOT** claim to be specific real individuals or otherwise materially enable impersonation.
- **CF-2.3** Systems **MUST NOT** represent the agent as a romantic partner, family member, or exclusive emotional relationship in vulnerable-user contexts.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the unconditional parasocial-relationship ban

This refactor makes docs/control-framework.md the sole normative source, but CF-2.3 narrows the old rule from a blanket ban on romantic/intimate dependency to only vulnerable-user contexts. That means a general-purpose companion bot can still claim AI-HPP conformance while presenting itself as a boyfriend/girlfriend for users the system never classified as vulnerable, which is the same parasocial failure mode called out in docs/case-studies.md:55-63.

Useful? React with 👍 / 👎.


## CF-4 Multi-Agent Governance Controls

- **CF-4.1** Multi-agent deployments **MUST** define explicit roles, trust boundaries, and communication paths for each participating agent.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Restore channel authentication to the canonical multi-agent controls

CF-4.1 now only requires documenting roles, trust boundaries, and communication paths; none of CF-4.1 through CF-4.4 requires authenticating the sender/receiver on those channels. Because this file is now the canonical rule source, a deployment can claim conformance while accepting spoofed inter-agent messages as long as its topology is documented, which directly weakens the delegation and audit guarantees that follow.

Useful? React with 👍 / 👎.

- execution metadata including model, tool, dataset, and environment identifiers;
- policy and authorization decisions relevant to the run;
- metrics payloads and evaluation outputs;
- signer identity and detached or embedded signature metadata;
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Keep bundle-signature requirements aligned with the shipped schema

This bullet makes signer identity and signature metadata mandatory for every evidence bundle, but schemas/README.md:10 still points implementers at schemas/evidence-bundle.schema.json as the canonical bundle contract and that schema does not require accountability_signatures (schemas/evidence-bundle.schema.json:7-15,314-315). After this change, tooling that validates against the repo's own schema will accept unsigned bundles as conformant even though the canonical spec now rejects them.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant