stack/docs/SITEMAP.md

Documentation Sitemap

Status: Current navigation index. Quarantined and authority-gated material is summarized without being presented as current guidance.

Start here

• Documentation atlas — placement, source-of-truth, linking, and migration rules.
• User guide — end-user workflows and product behavior.
• Administrator guide — installation, configuration, operations, security, and recovery.
• Developer guide — architecture, testing, integrations, and contributor material.
• API documentation — API contract migration status.
• Reports index — review, audit, QA, security, and retained evidence.
• Archive index — superseded historical pages.

Product and delivery control

• Product requirements — normative requirements; currently marked draft and retaining authority-gated legacy references.
• Active task rollup — orchestrator-owned work state; workers do not modify it.
• MVP mission manifest — control-plane mission rollup; activity and status remain under its authorized owner.
• Documentation catalog and truth audit — complete baseline inventory, evidence labels, broken-link clusters, and migration recommendations.

Protected current authority and executable books

These paths remain canonical because current source/tests consume them or because the KBN authority process protects them. Relocation requires an explicitly coordinated authority and consumer migration, not documentation-only cleanup.

• Fleet configuration management — executable roster-v2 operator book, schema, examples, and north-star projections.
• Fleet local canary — protected Fleet validation procedure referenced by the current developer hold-site guide.
• Native Kanban/SOT index — active canonical KBN contract and workstream index.
• Native Kanban/SOT requirements — active ratified requirements surface.
• KBN-101 database role split — active held database authority contract.
• Developer hold-site guide — protected current KBN-101 development boundary.
• Deployment hold-site guide — protected, non-operative PostgreSQL/deployment boundary.
• Tier-migration hold-site guide — protected secure migration route and hold boundary.
• Federation setup hold site — protected KBN-101 setup boundary; follow its explicit holds.

User documentation

• Quickstart — installed-CLI first-use route with local PGlite safety boundaries.
• Web dashboard — current routes, views, chat persistence, settings, and admin behavior.
• Discord conversations — current authorized parent-channel, thread, attachment, and control workflow.

Administrator documentation

• Administrator operations — current local procedures and explicitly held outlines.
• Upgrade safety and recovery — installed-CLI/local-PGlite upgrade and framework recovery.
• Mos connector lease operations — held/non-operative M1 outline while policy remains deny-all.
• Administrator security — current security chapter index.
• SSO providers — Authentik, WorkOS, and Keycloak configuration and discovery.
• Discord ingress security — service authentication, allowlists, bindings, roles, replay, and failure controls.

Developer documentation

• Architecture index — current architecture contracts, decisions, and draft RFCs.
• Channel protocol — shared DTOs and current Discord compatibility boundary; future adapters are draft.
• Lease-broker protocol — authenticated Unix-socket protocol and persistence boundary.
• Lease-broker security — identity, ancestry, filesystem, observer, and residual boundaries.
• Whole mutator-class gate — default-deny tool authorization and launch choke point.
• Compaction revocation — lifecycle observers, generation fencing, and residual stale window.
• Architecture decisions — implemented and accepted boundaries.
• Mos runtime portability M1 — logical identity, connector lease, grants, audit, and fencing.
• Architecture RFCs — draft proposals without operational authority.
• Optional AI egress gateways — draft proposal; LiteLLM and Bifrost are not integrated.
• Lease-broker operations and verification — safe static/test workflow; live procedures remain held.
• Channel adapter authoring — current shared contract and Discord reference boundary.

API transition

• API index — consolidated gateway contract remains planned.
• Legacy Tess-scoped OpenAPI contract — valid OpenAPI 3.1 artifact with incomplete gateway coverage; canonical scope requires maintainer approval.

Evidence and planning

• Reports index — all tracked report categories and evidence boundaries.
• Archived missions — historical CLI, harness, install UX, and storage-abstraction delivery records.
• Archived planning — historical briefs, board reviews, and work-package specifications.
• Archived work records — historical task scratchpads without live consumers.
• P8-003 performance report — historical implementation evidence, not a current SLO.
• Plans index — approved intent and implementation/audit plans.
• Documentation information-architecture design — approved documentation structure decision.
• Documentation catalog-audit plan — evidence method and migration acceptance criteria.
• Scratchpads index — working memory and verification records.
• Documentation migration scratchpad — coordinator progress, verification, and resumability record.

Authority-gated migration backlog

The complete file-level backlog remains in the documentation catalog. The groups below are intentionally not linked as current pages:

• Fleet configuration: the executable book is restored at docs/fleet/; any future audience-book relocation requires coordinated source/test and authority migration.
• Federation: the protected KBN-101 setup hold site remains canonical; disposition of the rest of the workstream requires maintainer/orchestrator confirmation.
• Native Kanban/KBN-101: active SSOT, requirements, and hold-site documents remain canonical; task state and future placement require product-owner, Task-18, and orchestrator decisions.
• Tess: mixed user, administrator, developer, migration, qualification, and API material requires audience splitting and a decision on active versus historical status.
• Gateway API: the Tess-scoped OpenAPI artifact must not be renamed into the canonical full-gateway contract until scope, authentication, errors, schemas, and transport coverage are approved.
• Deployment and tier migration: PostgreSQL, federated, bare-metal, Compose, Gateway/Web activation, and migration-runner procedures remain held under the repository safety policy.
• Mixed legacy guides and scratchpads: remaining records are coupled to control documents, tests/fixtures, mission evidence, or held procedures; migrate them with their owners.
• Compaction-refresh probes: scripts are Mos-gated and path-coupled; do not move or execute them as documentation cleanup.

docs/_old_structure/ remains read-only migration quarantine. It is not current navigation and must not be used as command authority.