-
Notifications
You must be signed in to change notification settings - Fork 0
ADR 0006 Versioned Wiki Source
Keshav edited this page Jul 29, 2026
·
1 revision
- Status: Accepted
- Date: 2026-07-30
GitHub Wiki uses a separate Git repository. Product and architecture documentation can drift from implementation if it is reviewed and changed separately from the source repository.
Keep the canonical Markdown source under docs/wiki in the StackCendra repository and publish the same pages to GitHub Wiki.
The README links to both the hosted Wiki and local source. Documentation changes accompany the code or decision they describe.
- Pull requests can review documentation with implementation.
- The project retains documentation history if Wiki settings change.
- Publishing requires a small synchronization step.
- Direct edits in the hosted Wiki should be reconciled back into
docs/wiki.
- Maintain documentation only in GitHub Wiki.
- Maintain only a large README.
- Use an external documentation platform immediately.
Documentation volume or publishing requirements justify a dedicated documentation site and automated publishing pipeline.
StackCendra is currently in Phase 0. The complete Phase 0–13 plan is versioned in the main repository under docs/wiki; later-phase pages describe intended behavior, not current implementation.
- Phase 0 foundation
- Phase 0 backlog
- Release 0.1 discovery
- Phase delivery framework
- Roadmap
- Wiki review guide
- Risks and decisions