veronica
f0d2dd9920
Applies the document contract from
docs/plans/2026-08-20_stack-docs-flatten-and-alignment.md section 3, partially:
`kind` and `status` only. `parent` is deliberately held until the flatten in
section 4 lands, so that 127 documents do not have to be re-pointed by hand
when docs/fleet/NORTH_STAR.yaml moves to docs/NORTH_STAR.yaml.
Scope, measured on origin/next at 63069149:
127 live docs = all *.md under docs/ minus docs/archive/ minus docs/_old_structure/
104 stamped here
19 held operator judgement (plan section 9), worklist in the same PR
3 held the SUPERSEDED TASKS.md stamps, which cite the moving path
1 untouched docs/fleet/FLEET-DOCTRINE.md, already stamped in W1
Kinds applied: 54 guide, 34 record, 9 spec, 6 tracking, 1 projection.
Every row carries a confidence and a one-line rationale in the worklist.
Two collisions with the existing state, both flagged rather than resolved:
1. docs/README.md:150-160 already documents a front-matter convention
(title/type/audience/status/source_of_truth) with its own allowed values.
It is applied to 4 of 127 files. Its `status` vocabulary is
current|draft|deprecated|historical; the new contract's is active|superseded-by.
The key collides. This commit lets the new contract win and rewrites
`status: current` to `status: active` on those 4 files, keeping their other
legacy keys untouched. No code reads any of them: `git grep source_of_truth`
outside docs/ returns nothing. docs/README.md still prescribes the old
convention and is an operator row, so it is not edited here.
2. Two of the plan's 20 operator rows are YAML files, not markdown
(docs/fleet/examples/roster-v2.yaml, docs/openapi-tess.yaml), and the
contract's front-matter form has no defined meaning for a .yaml document.
That gap also applies to docs/fleet/NORTH_STAR.yaml, the source of truth
itself. Raised in the worklist.
A third row from the plan, docs/fleet/north-star.md, no longer exists: W1
renamed it to docs/fleet/FLEET-DOCTRINE.md.
Verification: 104/104 parse with the expected kind and status in front matter;
the check was shown to reject a wrong kind before it was trusted. The diff
removes 4 lines total, all of them `status: current`.
2.1 KiB
2.1 KiB
kind, status
| kind | status |
|---|---|
| record | active |
#830 Documentation Completion Checklist
Required artifacts
docs/PRD.mdcontains the M1 compaction-refresh trust-lifecycle requirements and acceptance criteria.- Operator behavior and recovery are documented in
docs/guides/lease-broker-operations.md. - Developer architecture and protocol behavior are documented in
docs/architecture/compaction-revocation.md,lease-broker-protocol.md, andmutator-class-gate.md. - Security boundaries and residuals are documented in
docs/architecture/lease-broker-security.mdandcompaction-revocation.md. docs/SITEMAP.mdlinks the new architecture page.- User-guide changes are not applicable: observers are mandatory internal runtime controls with no end-user workflow.
- OpenAPI/endpoint changes are not applicable: the broker remains an internal Unix-socket protocol, not a public HTTP API.
Contract coverage
- Claude and Claudex lifecycle signals, matchers, commands, and fail-closed behavior are documented.
- Pi pre-/post-compaction signals and session replacement reasons are documented.
- Private generation-file ownership, monotonic update, same-PID replacement, and failure fencing are documented.
revoke_leaseinput purpose, broker response state, and denial behavior are documented.- T12b/T30 explicitly names the bounded residual stale window and reports within-TTL ALLOWED / after-TTL DENIED.
- Documentation explicitly disclaims a within-window mutator-action bound.
- T-A, T-C, same-principal, and protected-branch boundaries are retained.
Structure and review
- New architecture content is under
docs/architecture/. - This report is under
docs/reports/compaction-refresh/. - Session evidence is under
docs/scratchpads/. - Documentation changes are in the same logical change set as code and tests.
- Independent exact-head code and Opus security reviews pending coordinator sequencing after the deterministic-main rebase gate.
Publishing
- Canonical documentation remains in-repository.
- No external publishing target is required for this internal M1 control.