veronica
12d5258e20
A - docs/README.md:149-190 rewritten. It prescribed a competing front-matter schema
(title/type/audience/status/source_of_truth) adopted by 4 of 128 live documents. Two
documented conventions in one repo is the defect this pass removes, so the README now
documents the contract and the 4 files convert in the same commit: `type` dropped
(kind replaces it), `title`/`audience`/`source_of_truth` kept.
B - source-of-truth leaves the kind enum, which is now 6 values, and returns as an orthogonal
boolean. kind was carrying two independent facts. docs/requirements/native-kanban-sot.md
is stamped `kind: spec` + `source_of_truth: true`, which is what it always was.
C - status gains `completed`. Applied to the two executed plans, on artifact evidence rather
than on their own say-so: --purpose push|merge ships in ci-queue-wait.sh, and every section
the README plan specifies exists in docs/README.md today.
D - kind follows content, never filename. docs/native-kanban-sot/TASKS.md is `kind: spec`
because its body says "a build plan, not a task tracker". The name stays wrong; that is a
rename and it is out of scope here.
E - the contract covers .md only, written into the README as a decision with vision's
YAML.parse measurement as the reason, so the omission does not read as an oversight.
F - channel-protocol.md guide -> spec. Applied, with a correction the reviewer should see: the
ruling cites "7 normative MUSTs" and there are ZERO uppercase RFC2119 terms in that file.
Control: the identical grep returns 25 lines in docs/requirements/native-kanban-sot.md. The
citation half of the finding does hold and is larger than stated. Consequence recorded in
the worklist: the file's own banner now contradicts its header.
Verified: 128 live .md under docs/ (127 baseline + this PR's worklist), 107 stamped, 0 invalid
kinds, 17 operator-held + 3 supersede-stamp deferrals + 1 generated = 21 unstamped. 107+21=128.
Control: the verifier reports valid=False when a kind is corrupted to `nonsense`, so the
0-invalid result is a real result. prettier --check clean across docs/.
kind, status
| kind | status |
|---|---|
| guide | active |
Developer Guide
Status: Partially migrated. Architecture, lease-broker verification, and channel-adapter authoring pages are current; other contributor chapters remain unmigrated.
This book is the canonical home for architecture, package and application guides, local development, testing, contribution workflow, and integration authoring. User-facing procedures belong in USER-GUIDE/; operator procedures belong in ADMIN-GUIDE/; API contracts belong in API/.
Start here
- Documentation atlas — placement rules and source-of-truth boundaries.
- Architecture index — current architecture chapter scaffold.
- Documentation audit — evidence-based migration inventory.
- Product requirements — normative requirements, currently marked draft.
Chapter map
| Chapter | Scope | Status |
|---|---|---|
architecture/ |
System model, components, data flow, security model, ADRs, and RFCs. | Partially migrated. |
packages/ |
Package- and application-level contracts and guides. | Scaffold only. |
local-development/ |
Safe local setup and development routes. | Scaffold only. |
testing/ |
Test strategy, verification, and quality gates. | Lease-broker verification boundary is current. |
contributing/ |
Contribution, review, and delivery workflow. | Scaffold only. |
integrations/ |
Plugin, provider, and adapter authoring. | Channel-adapter authoring boundary is current. |
Current contributor pages
- Lease-broker operations and verification — safe static/test commands plus explicitly held live operations.
- Channel adapters — current shared contracts and Discord reference boundary; future adapter parity is draft.
Every promoted page must be added to this index and to SITEMAP.md in the same migration slice.
Migration backlog — not current developer guidance
These are source candidates or stale records, not verified current instructions:
archived TUI PRD— contradicted/stale; it references a missingpackages/cli, while current TUI code is underpackages/mosaic.archived TUI task ledger— historical task ledger; its status and worktree claims require revalidation._old_structure/guides/dev-guide.md— quarantined historical source; verify paths and commands before promotion. See the documentation catalog for its disposition.
Do not make a legacy or archived page current by linking it from a chapter as if it were already promoted.
Authoring boundary
New developer documentation belongs under one of the chapter directories above. Architecture decisions and RFCs must identify their status and authority; executable behavior must be checked against current code and tests.