Documentation
README
Record Knowledge
Record architectural decisions for future reference, and keep related feature specs in sync.
Record a decision
When a significant architectural or design choice is made, create an ADR:
- Choose a decentralized ID in the form
YYYY-MM-DD-short-title. The short title must be specific enough to remain unique among decisions created on the same date. - Confirm that
docs/decisions/<id>.mddoes not already exist. - Create
docs/decisions/<id>.mdusing the template below. - Update
docs/decisions/INDEX.mdwith the new entry. - Reconcile specs โ see "Update or create a spec" below.
Existing numeric ADR IDs remain valid and must not be renamed. References use the complete stable
ID, for example ADR-2026-07-16-project-shell-output.
ADR template
This is the opening of the README. Read the full README on GitHub.