Files
stack/docs/DEVELOPER-GUIDE
veronica ff40794bfe
ci/woodpecker/pr/ci Pipeline was successful
docs(W4): revert channel-protocol to guide (F withdrawn), stamp docs/README.md as the contract's source of truth (Q1)
fred withdrew decision F after re-measuring channel-protocol.md with a control:
zero uppercase RFC2119 terms, seven lowercase 'must' all disclaiming authority,
under a banner refusing requirements status. F rested on 'the doc graph outranks
the page's own banner', which contradicts decision D, 'kind follows content'.
D is the rule; F was its counterexample. Neither rescue (vision's adjective edit
on the citing docs, or a banner edit) was taken: a kind that survives only by
editing the evidence around it is not a classification.

Q1 answered: docs/README.md prescribes the contract, so by D its content is a
spec, and by B it is the source of truth for that contract. A plan never
outranks the artifact it planned, so the flatten plan's stale 7-value enum is
corrected there rather than competing here.

128 live docs = 108 stamped + 16 operator-held + 3 supersede deferrals + 1 generated.
2026-08-20 20:21:06 -05:00
..

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

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

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 missing packages/cli, while current TUI code is under packages/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.