This directory is the canonical home for NEXUS specifications, SDK guidance,
payment controls, integration notes, release records, and governance documents.
NEXUS-owned documentation must remain inside NEXUS/ so people and agents can
discover the complete implementation from one boundary.
| I need to… | Start here | Then verify with |
|---|---|---|
| Understand what NEXUS protects | Overview | Threat model |
| Install and integrate the SDK | Python SDK | Examples and SDK tests |
| Protect agent-initiated payments | Payment profile | Gateway and controls |
| Decide whether a deployment is ready | Deployment readiness | Sandbox readiness |
| Review security or assurance claims | Security policy | Threat model and Challenge Lab |
| Extend an adapter or payment rail | Adapter guide | Hardening and extension |
| Consume NEXUS with an agent | Agent instructions | Machine manifest and LLM index |
Status is always expressed in text; color is supplemental and never carries meaning by itself.
| Label | Meaning |
|---|---|
| Implemented | Code exists and its stated behavior is covered by repository tests |
| Reference | A working example or contract that still requires deployment-specific controls |
| Requires binding | The interface fails closed until an external verifier, signer, store, or rail is connected |
| Experimental | Useful for evaluation; compatibility or assurance may change |
| Not production-assured | No claim that the complete deployment boundary has passed production acceptance gates |
The legacy runtime pages describe older AI SAFE² shared-engine examples. They are retained for discovery and migration context, but they are not claims that those example engines implement the current NEXUS SDK or payment gateway.
The repository-level docs/ directory remains the home of shared AI SAFE²,
AISM, CLI, evidence, and engineering documentation. A shared document may link
to NEXUS without becoming NEXUS-owned. A document whose primary title or subject
is NEXUS belongs under this directory.
Challenge-local NEXUS treatment material may remain beside the challenge that executes it because its path is part of the challenge evidence boundary. Those exceptions must link back to this documentation map and must not become a second general-purpose NEXUS documentation tree.