17 lines
1.1 KiB
Markdown
17 lines
1.1 KiB
Markdown
# Documentation authority
|
|
|
|
`docs/authority.toml` is the machine-readable registry. Roles mean:
|
|
|
|
- `canonical`: current user or developer behavior.
|
|
- `architecture`: accepted decisions and constraints.
|
|
- `overview`: a high-level entry point linking to canonical owners.
|
|
- `active-plan`: approved incomplete work.
|
|
- `evidence`: dated acceptance or evaluation, not product specification.
|
|
- `historical`: preserved record no longer used as guidance.
|
|
- `superseded`: replaced material that links to its replacement.
|
|
- `draft`: non-authoritative work.
|
|
|
|
Code, schemas, tests, and deterministic output define actual behavior. Accepted ADRs define architecture. Gitea defines accepted current scope and work state. Canonical docs describe shipped/current workflows. When they conflict, identify and reconcile the conflict; never silently combine old and new claims.
|
|
|
|
Historical, evidence, and superseded files require a visible warning and current canonical link. Active plans require an incomplete-work banner and shipped-behavior link. Session state and raw logs are never documentation.
|