DecisionsPlatform
ADR-0003: The engineering wiki lives in docs/
Page actions
- View as Markdown (opens in a new tab)
- Ask ChatGPT (opens in a new tab)
- Ask Claude (opens in a new tab)
ChatGPT and Claude are third-party services. The link gives them this page's public address and a short instruction. This site records nothing.
Preview: the published page may be older or missing.
Why the engineering wiki is Markdown and Mermaid under docs/, versioned with the code and reviewed in pull requests.
https://docs.gurbanisoul.com/adr/0003-docs-in-repo/
Status: accepted (2026-09-15)
Context
No wiki or diagrams existed; GitHub Wiki needs Pro on a private repo and is not PR-reviewed. 20+ loose audit reports sat at the repo root.
Decision
Keep the wiki as Markdown + Mermaid under docs/, versioned with the
code and reviewed in PRs. Migrate the loose reports into docs/reports/.
Consequences
Diagrams render natively on GitHub in any plan; docs cannot drift
from the code they ship with. External links are checked weekly by docs-links.yml (lychee; a failure opens an issue, never blocks a merge); internal links on every build (ADR-0012).
Sri Guru Granth Sahib Ji — Knowledge Base wiki. Generated from commit c3d9360. Updated 25 September 2026. This copy may be out of date; the page is at https://docs.gurbanisoul.com/adr/0003-docs-in-repo/