singularity-forge/docs/adr/README.md

26 lines
836 B
Markdown
Raw Permalink Normal View History

2026-05-04 19:28:39 +02:00
# docs/adr/
Accepted architecture decision records (ADRs).
Start with [ADR-0000: SF Is a Purpose-to-Software Compiler](./0000-purpose-to-software-compiler.md). It is the foundational product/architecture decision; later ADRs refine pieces of that contract.
2026-05-04 19:28:39 +02:00
## What belongs here
- Final, accepted architectural decisions that affect the project.
- Decisions that have been promoted from `.sf/DECISIONS.md`.
## What does NOT belong here
- Draft decisions still under discussion.
- Implementation plans (use `docs/plans/`).
- Specifications (use `docs/specs/`).
## Naming convention
`0001-<slug>.md` — zero-padded four digits, auto-numbered by `sf plan promote --to docs/adr`.
`0000-*` is reserved for foundational doctrine that later ADRs depend on.
2026-05-04 19:28:39 +02:00
## See also
- [AGENTS.md#sf-planning-state](../AGENTS.md#sf-planning-state)