# Developer Guide

> **Status:** Partially migrated. The architecture chapter contains the promoted lease-broker security-contract pages; 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/`](../USER-GUIDE/); operator procedures belong in [`ADMIN-GUIDE/`](../ADMIN-GUIDE/); API contracts belong in [`API/`](../API/).

## Start here

- [Documentation atlas](../README.md) — placement rules and source-of-truth boundaries.
- [Architecture index](architecture/README.md) — current architecture chapter scaffold.
- [Documentation audit](../reports/documentation/2026-08-10-docs-catalog-audit.md) — evidence-based migration inventory.
- [Product requirements](../PRD.md) — normative requirements, currently marked draft.

## Chapter map

| Chapter                                   | Scope                                                                | Status              |
| ----------------------------------------- | -------------------------------------------------------------------- | ------------------- |
| [`architecture/`](architecture/README.md) | 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.                      | Scaffold only.      |
| `contributing/`                           | Contribution, review, and delivery workflow.                         | Scaffold only.      |
| `integrations/`                           | Plugin, provider, and adapter authoring.                             | Scaffold only.      |

Every promoted page must be added to this index and to [`SITEMAP.md`](../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`](../archive/tui/PRD-TUI_Improvements.md) — contradicted/stale; it references a missing `packages/cli`, while current TUI code is under `packages/mosaic`.
- [`archived TUI task ledger`](../archive/tui/TASKS-TUI_Improvements.md) — historical task ledger; its status and worktree claims require revalidation.
- [`_old_structure/guides/dev-guide.md`](../_old_structure/guides/dev-guide.md) — historical source; verify paths and commands before promotion.
- [`_old_structure/architecture/`](../_old_structure/architecture/) — historical architecture sources; classify each page before migration.

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.

## Related

- [[README|Documentation contract]]
- [[DEVELOPER-GUIDE/architecture/README|Architecture index]]
- [[API/README|API index]]