Skip to content

Latest commit

 

History

History
119 lines (106 loc) · 9.73 KB

README.md

File metadata and controls

119 lines (106 loc) · 9.73 KB

Documentation

Docs are split by the question they answer:

Directory Question Contents
adr/ Why did we choose this? Architecture Decision Records — semantically immutable once accepted; link-only maintenance follows ADR-0033
design/ How does it fit together? Living documents describing the current architecture
specs/ What exactly is the contract? Precise, testable interface definitions
plans/ When/in what order do we build? Roadmaps and phase plans; updated as work lands

Index

Decisions (ADRs)

Design

Specs

Plans

Conventions

  • New docs start from their category's TEMPLATE.md (in each directory).
  • New decision → new ADR with the next number; if it reverses an old one, mark the old one Superseded by NNNN rather than editing it.
  • Link-only repairs to Accepted or Superseded ADRs follow ADR-0033; semantic changes always require a new ADR.
  • Design docs are updated in place to always reflect reality.
  • Specs change only alongside the code that implements them.
  • Cross-links between categories are mandatory in both directions — see the documentation rules in AGENTS.md (CLAUDE.md/GEMINI.md are symlinks to it, ADR-0002).
  • Adding a doc means adding it to the index above.
  • Conformance alias symlinks (docs/quality.md, docs/metrics.md, docs/review-rubric.md — ADR-0029) are not docs and are not indexed — edit their canonical targets.