Decision
Repository Markdown is the canonical documentation source.
Mandatory installation, security, maintenance, migration, testing, recovery, and deployment procedures belong in this repository and change through pull requests with the implementation they describe.
The GitHub Wiki must not become a separately maintained copy of operational documentation. A generated documentation site may improve browsing later, but repository Markdown remains its source.
Presentation requirements
- The root README explains what the project is, why it exists, who needs it, how it works, and where to begin.
docs/README.md provides a task-oriented index of concepts, standards, examples, and how-tos.
- Page and folder names use plain language rather than internal governance terminology.
- Important system choices are explained in the architecture, controller, configuration, security, or operations page where a user would naturally look for them.
- Documentation remains useful in a pinned checkout and can be validated for broken links and examples.
Acceptance
Implemented by #28.
Decision
Repository Markdown is the canonical documentation source.
Mandatory installation, security, maintenance, migration, testing, recovery, and deployment procedures belong in this repository and change through pull requests with the implementation they describe.
The GitHub Wiki must not become a separately maintained copy of operational documentation. A generated documentation site may improve browsing later, but repository Markdown remains its source.
Presentation requirements
docs/README.mdprovides a task-oriented index of concepts, standards, examples, and how-tos.Acceptance
Implemented by #28.