3.8 KiB
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.