jason.woltje
3ae1411d5f
Addresses CPS-PRD-REV1-REREVIEW findings on PR #1491 head 13968e9a:
F1 (blocker; the CI test failure): docs/PRD.md is now the permanent shim, so
heading-fragment links into the former PRD body no longer resolve —
fleet-documentation.spec.ts failed on docs/fleet/README.md's FCM anchor. The
Part II workstream contracts live in
docs/PRDs/2026-08-31_PRD_rev1/GOV.4-workstream-contracts.md; all five anchored
links in the tree are repointed there (fleet/README.md, TASKS.md,
release-integrity/TASKS.md, ADMIN-GUIDE mos-connector-lease-operations.md,
DEVELOPER-GUIDE mos-runtime-portability-m1.md). Each anchor verified against
the GOV.4 headings with the spec's slug rule. Bundle content unchanged.
F2 (minor): the rev0 archive README's ./ROADMAP.md row now cites all three
source lines (18, 177, 249).
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.