cesnimda
13 lines
778 B
Markdown
13 lines
778 B
Markdown
# Documentation rules
|
|
|
|
Current documentation describes verified repository behavior or clearly labels future work. Use one authoritative guide per subject and link to it rather than copying long sections.
|
|
|
|
- `docs/README.md` is the entry point.
|
|
- `docs/architecture/overview.md` is the current system summary.
|
|
- `docs/configuration/environment-variables.md` is the environment-variable index.
|
|
- `docs/roadmap/` contains open work, debt, and known issues.
|
|
- `BLOCKERS.md` contains operator/external dependencies referenced by repository instructions.
|
|
- `docs/_archive/` is historical evidence and is not authoritative.
|
|
|
|
Update behavior documentation in the same change as code. Do not put secrets, private user data, or temporary AI/planning transcripts in active documentation.
|