Docs Placement Quick Guide
Section titled “Docs Placement Quick Guide”Use this before creating a doc.
| Doc type | Location |
|---|---|
| Canonical architecture rule or structure doc | docs/architecture/ |
| ADR | docs/adr/NNNN-short-slug.md |
| Runbook, rollout, playbook | docs/runbooks/ |
| Active plan | docs/plans/ |
| Stable technical reference | docs/reference/ |
| Completed or superseded doc | remove from active docs; fold durable guidance into canonical docs |
| App-local implementation note | apps/{app}/docs/ plus link from docs/README.md |
| Package-local implementation note | near the package plus link from docs/README.md if broadly useful |
- new plans do not go in root
plans/ - architecture docs should update the existing canonical rule when possible
- app-local docs are exceptions, not the default
- remove obsolete docs instead of leaving stale active docs in place
See ../../PLACEMENT-GUIDE.md for the canonical placement rules.