feat(docs): living PRDs — generated state sections + staleness gate for pipeline and TUI (#204)
This commit is contained in:
1 parent
3e0b74873f
commit
ed9ec6df71
4 files changed
+14
-5
No files matched your search
@@ -20,14 +20,14 @@ Only use `git commit --no-verify` in a genuine emergency: it bypasses the hooks
|
||||
- The umbrella impact map is complete and truthful — every module mapped, no phantom entries (in ./config/umbrellas.json)
|
||||
- Umbrella canaries exist in the repo — the propagation gate cannot reference ghosts (in ./config/umbrellas.json)
|
||||
- The umbrella dependency graph stays a DAG — reflexive updates cannot cycle (in ./config/umbrellas.json)
|
||||
|
||||
- The bug-fix discharge contract is a governed doc — it exists, is markdown, and changes are deliberate (in ./docs/bugfix-contract.md)
|
||||
- The discharge checker ships with the repo — red-first enforcement is structural (in ./scripts)
|
||||
- Discharge checker and its CI wiring change together
|
||||
- Every workflow is registered in the pipeline registry — new pipeline machinery ships with documentation (in ./.gitea/workflows/*.yml)
|
||||
- Every TUI surface is registered — no silent UI growth (in ./src/rune/*tui*.py)
|
||||
- New rune modules ship with tests or a canary — no ungoverned code surfaces (in ./src/rune/*.py)
|
||||
|
||||
- PRDs are living documents — their generated state sections regenerate identically from governed sources
|
||||
- PRD staleness is a CI failure — docs rot is silent failure (in ./scripts/gen_prd_state.py)
|
||||
|
||||
### Behaviours
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Rune TUI — Product Requirements Document (PRD)
|
||||
|
||||
**Last Updated**: 2026-08-30
|
||||
**Last Updated**: 2026-09-07
|
||||
**Version**: v0.45.1
|
||||
**Status**: Active Development
|
||||
|
||||
@@ -13,7 +13,7 @@ Rune is a stateful coding assistant with a Textual-based TUI. It connects to loc
|
||||
---
|
||||
|
||||
<!-- BEGIN GENERATED: state — edits here are overwritten by scripts/gen_prd_state.py -->
|
||||
**Version**: v0.54.0 · **HEAD**: c00c009 · **Regenerated**: 2026-09-07
|
||||
**Version**: v0.54.0 · **HEAD**: 3e0b748 · **Regenerated**: 2026-09-07
|
||||
|
||||
### Governed TUI surfaces (docs/tui-registry.md)
|
||||
|
||||
|
||||
@@ -42,7 +42,7 @@ the contract surface saying it may.
|
||||
- `henxels.yaml` + `henxels_checks.py` — the auditable contract surface
|
||||
|
||||
<!-- BEGIN GENERATED: state — edits here are overwritten by scripts/gen_prd_state.py -->
|
||||
**Version**: v0.54.0 · **HEAD**: c00c009 · **Regenerated**: 2026-09-07
|
||||
**Version**: v0.54.0 · **HEAD**: 3e0b748 · **Regenerated**: 2026-09-07
|
||||
|
||||
### Impact map (config/umbrellas.json — enforced complete by henxels)
|
||||
|
||||
|
||||
@@ -70,3 +70,12 @@ henxels:
|
||||
in: ./src/rune/*.py
|
||||
new_rune_modules_have_canary_or_test_coverage: true
|
||||
|
||||
|
||||
- henxel: "PRDs are living documents — their generated state sections regenerate identically from governed sources"
|
||||
changed_with:
|
||||
when: ./config/umbrellas.json
|
||||
expect: ./docs/pipeline-prd.md
|
||||
|
||||
- henxel: "PRD staleness is a CI failure — docs rot is silent failure"
|
||||
in: ./scripts/gen_prd_state.py
|
||||
required_files: [gen_prd_state.py]
|
||||
Reference in new issue
Block a user