This directory is the canonical home for maintained project documentation.
The repository-wide canonical domain language is maintained in
../CONTEXT.md.
design/— architecture, system design, invariants, and long-lived technical decisions.implementation/— implementation plans, code-level specifications, rollout notes, and validation protocols.
- Put durable design documents in
docs/design/and implementation-facing documents indocs/implementation/; do not add planning documents to feature or benchmark source directories. - Use lowercase kebab-case filenames.
- Start each non-index document with its status, scope, owner, and last-updated
date. Directory
README.mdindex files are exempt. - Link a design document to its implementation documents and link each implementation document back to the governing design.
- Update the relevant directory index when adding, replacing, or retiring a document.
- Keep experiment output and generated reports out of
docs/; documentation may link to evidence stored underbenchmark/.