cesnimda/jobtrackingapp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: consolidate repository guides and preserve audit history

Browse Source
This commit is contained in:
cesnimda
2026-09-11 14:22:41 +02:00
parent 115441a409
commit 682a3028bb
404 changed files with 3402 additions and 2621 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/documentation-rules.md
+10 -7
View File
@@ -1,9 +1,12 @@
# documentation-rules
# Documentation rules
Active documentation must describe verified current behavior or a clearly labelled future decision.
Prefer one authoritative document plus short topic guides that link to it; do not copy long architecture
sections across files. Update behavior docs in the same change as code.
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.
Use `docs/architecture/current.md` for the verified system, `docs/implementation-roadmap.md` for delivery
status, `docs/MASTER_IMPLEMENTATION_GUIDE.md` for product constraints, and `BLOCKERS.md` for external
decisions or credentials. `docs/_archive` is historical evidence and must not be treated as current work.
- `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.