Skip to content

Latest commit

 

History

History
91 lines (72 loc) · 4.27 KB

File metadata and controls

91 lines (72 loc) · 4.27 KB

docs/

Eighty-odd files live here. This is what's in them.

If what you actually need to know is whether a given file is still true, that's DOC_STATUS.md — it splits everything into current, historical, generated, and standards. Start there when a document surprises you.

Running it

USER_GUIDE.md Using the app
OPERATOR_GUIDE.md Running it on your own hardware — gates, diagnostics, tuning, debugging entry points
runbooks/ 34 incident procedures, one per known failure mode. Written against aura doctor --bundle fields
SLO.md What the runtime promises, measured by slo/ and gated in CI
PLATFORM_POSTURE.md The five deliberate platform decisions (no RBAC, no SSO, single-tenant, manual DR, hash-allowlist plugins) and what enforces each

Understanding it

ARCHITECTURE_MAP.md Generated dependency map — subsystems, edges, boot contract
ONTOLOGY.md The formal ontology: continuants, occurrents, axioms rendered as test invariants
TERMINOLOGY.md Internal poetic name ↔ sober technical label
RUNTIME_CONTRACT.md Generated from health_contract.py
FMEA.md Generated failure-mode registry
ENGINEERING_ADOPTION.md The seven clean-room adoption waves and why each landed

The claim surface

This is the part of the repo that exists to keep it honest.

REALITY_REACH.md Physical claims: typed contracts, reachability proof, and an open ledger. Read "Current Evidence" before crediting any physical result
CLAIM_BOUNDARIES.md · CLAIM_SURFACE.md What may be claimed and where the edges are
ABLATION_LEGIBILITY.md Run it with pieces switched off and see the measured delta — including the no-delta results
BEHAVIORAL_PROOF_STANDARD.md The bar for autonomy and novel-output claims
*_STANDARD.md (12 files) One evidence bar each. Evergreen — they change when the bar changes, not when the code does

Research programmes

Long-running lines of work, each with its own ledger.

Records

evidence/ and every file with a date in its name are point-in-time records. They carry a banner saying so. They are not updated to match the present — editing a July verdict in August is editing the record, not correcting it.

Generated — do not hand-edit

Four files here are rendered from code. A manual edit survives until the next build and then vanishes.

make architecture-map                          # ARCHITECTURE_MAP.md
make fmea-doc                                  # FMEA.md
make contract-doc                              # RUNTIME_CONTRACT.md
python tools/reqproof/progress.py              # AURA_PROGRESS.md

Check for drift without rewriting:

python tools/render_fmea.py --check
python tools/render_health_contract.py --check