6.7 KiB
6.7 KiB
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 — stale rollup retained pending an orchestrator/maintainer disposition decision.
- Documentation catalog and truth audit — complete baseline inventory, evidence labels, broken-link clusters, and migration recommendations.
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.
- P8-003 performance report — historical implementation evidence, not a current SLO.
- Documentation information-architecture design — approved documentation structure decision.
- Documentation catalog-audit plan — evidence method and migration acceptance criteria.
- 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: quarantined pages have executable source/test consumers and require a coordinated path, authority, and test migration.
- Federation: active-versus-historical workstream status and normative authority require maintainer/orchestrator confirmation.
- Native Kanban/KBN-101: requirements, task state, reports, and held PostgreSQL procedures require product-owner 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: promote only evidence-backed current facts; retain the rest as historical artifacts.
docs/_old_structure/ remains read-only migration quarantine. It is not current navigation and must not be used as command authority.