139 lines
14 KiB
Markdown
139 lines
14 KiB
Markdown
# Documentation Sitemap
|
||
|
||
> **Transition status:** The current structure is listed first. The legacy sections below are retained migration inventory and may contain stale or unresolved paths; they are not a claim that those pages are current.
|
||
|
||
## Current documentation structure
|
||
|
||
- [Documentation atlas](README.md) — placement, source-of-truth, linking, and migration rules.
|
||
- [User guide index](USER-GUIDE/README.md) — end-user documentation and current quickstart.
|
||
- [Administrator guide index](ADMIN-GUIDE/README.md) — operator documentation and current security runbooks.
|
||
- [Developer guide index](DEVELOPER-GUIDE/README.md) — partially migrated contributor and architecture documentation.
|
||
- [Architecture index](DEVELOPER-GUIDE/architecture/README.md) — system design, security contracts, decisions, and RFCs.
|
||
- [Lease-broker protocol](DEVELOPER-GUIDE/architecture/lease-broker-protocol.md) — authenticated runtime lease-broker protocol and persistence boundary.
|
||
- [Lease-broker security notes](DEVELOPER-GUIDE/architecture/lease-broker-security.md) — identity, ancestry, filesystem, and residual security boundaries.
|
||
- [Whole mutator-class gate](DEVELOPER-GUIDE/architecture/mutator-class-gate.md) — default-deny tool authorization and launch choke point.
|
||
- [Compaction revocation lifecycle](DEVELOPER-GUIDE/architecture/compaction-revocation.md) — Claude/Pi lifecycle observers, generation fencing, and residual boundary.
|
||
- [Channel protocol architecture](DEVELOPER-GUIDE/architecture/channel-protocol.md) — shared channel DTOs and current Discord compatibility boundary; future adapters are labeled draft.
|
||
- [Architecture decisions index](DEVELOPER-GUIDE/architecture/decisions/README.md) — approved and implemented architecture decisions.
|
||
- [Mos runtime portability M1](DEVELOPER-GUIDE/architecture/decisions/mos-runtime-portability-m1.md) — logical identity, connector lease, grant, audit, and fencing decision.
|
||
- [Administrator operations index](ADMIN-GUIDE/operations/README.md) — current local procedures and held operational outlines.
|
||
- [Upgrade safety and recovery](ADMIN-GUIDE/operations/upgrade-safety-and-recovery.md) — installed-CLI/local-PGlite upgrade and framework recovery runbook.
|
||
- [Mos connector lease operations](ADMIN-GUIDE/operations/mos-connector-lease-operations.md) — held/non-operative M1 operations outline.
|
||
- [Lease-broker operations and verification](DEVELOPER-GUIDE/testing/lease-broker-operations.md) — safe static/test workflow with live procedures held.
|
||
- [Optional AI egress gateways RFC](DEVELOPER-GUIDE/architecture/rfcs/optional-ai-egress-gateways.md) — draft proposal; no candidate is integrated.
|
||
- [Web dashboard](USER-GUIDE/product/web-dashboard.md) — current routes, views, chat persistence, settings, and admin behavior.
|
||
- [Discord conversations](USER-GUIDE/workflows/discord-conversations.md) — current authorized Discord workflow.
|
||
- [Discord ingress security](ADMIN-GUIDE/security/discord-ingress.md) — current service authentication, allowlist, binding, role, and replay controls.
|
||
- [Channel adapter authoring](DEVELOPER-GUIDE/integrations/channel-adapters.md) — current shared contract and Discord reference boundary.
|
||
- [API documentation index](API/README.md) — scaffold for the consolidated gateway contract.
|
||
- [Reports index](reports/README.md) — review, audit, QA, security, and retained evidence.
|
||
- [Documentation catalog and truth audit](reports/documentation/2026-08-10-docs-catalog-audit.md) — evidence and migration recommendations.
|
||
- [User quickstart](USER-GUIDE/getting-started/quickstart.md) — installed-CLI first-use path.
|
||
- [SSO provider runbook](ADMIN-GUIDE/security/sso-providers.md) — current Authentik, WorkOS, and Keycloak configuration.
|
||
- [P8-003 performance report](reports/qa/p8-003-performance-optimization.md) — historical performance evidence; not a current SLO or runbook.
|
||
- [Archive index](archive/README.md) — retained historical pages; not current guidance.
|
||
|
||
Canonical pages added to a book must be linked from that book's README and this section. Replace or retire legacy entries only after the associated migration slice verifies repository references and claim status.
|
||
|
||
## Compaction refresh lease broker
|
||
|
||
- [Internal broker protocol](DEVELOPER-GUIDE/architecture/lease-broker-protocol.md) — kernel identity, ancestry and generation invariants, framed requests, responses, and persisted cycle bindings.
|
||
- [Broker operations](DEVELOPER-GUIDE/testing/lease-broker-operations.md) — safe static/test workflow; live startup, recovery, mutation, and cleanup remain held.
|
||
- [Constrained recovery skill](../packages/mosaic/framework/skills/mosaic-context-refresh/SKILL.md) — source-resident thin wrapper, receipt scope, C4 replay boundary, and T-C middle-drop disclosure.
|
||
- [Lease-broker security notes](DEVELOPER-GUIDE/architecture/lease-broker-security.md) — identity, whole-class authorization, threat boundaries, and coordinator review requirements.
|
||
- [Whole mutator-class gate](DEVELOPER-GUIDE/architecture/mutator-class-gate.md) — default-deny policy, revoke-first/promote-last state machine, TTL, runtime adapters, and T-B/T-C assurance boundary.
|
||
- [Compaction revocation lifecycle](DEVELOPER-GUIDE/architecture/compaction-revocation.md) — Claude/Pi observer matrix, same-PID generation rollover, failure fencing, and the named bounded residual stale window.
|
||
|
||
## CLI and skill management
|
||
|
||
- [Skill registration user guide](guides/user-guide.md#claude-code-skill-registration) — register, unregister, list statuses, automatic install/update reconciliation, and Claude reload behavior.
|
||
- [Skill bridge developer guide](guides/dev-guide.md#claude-code-skill-bridge) — path-validation, ownership, clobber-protection, install/update wiring, tests, and Pi/Codex scope notes.
|
||
|
||
## Fleet configuration management
|
||
|
||
- [Fleet configuration entry point](fleet/README.md) — desired-versus-observed decision tree and complete operator link map.
|
||
- [Desired, derived, and observed state](fleet/concepts/desired-vs-observed-state.md) — roster authority, generation, ownership, and drift.
|
||
- [Identity, class, and runtime](fleet/concepts/identity-class-runtime.md) — stable name, display alias, class, runtime, provider, and model separation.
|
||
- [Role authority and leases](fleet/concepts/role-authority-and-leases.md) — validator/merge-gate separation and bounded lease authority.
|
||
- [Generated launch chain](fleet/concepts/generated-env-launch-chain.md) — strict data parsing, precedence, and quarantine.
|
||
- [Roster v2 structural contract](fleet/reference/roster-v2-fields.md) — schema, supported values, required fields, defaults, and constraints.
|
||
- [Fleet CLI reference](fleet/reference/cli.md) — local desired-state commands, JSON/exit behavior, and gateway-catalog separation.
|
||
- [Lifecycle transitions](fleet/reference/lifecycle-transitions.md) — create/apply/reboot/migration/rollback boundaries.
|
||
- [Status and drift](fleet/reference/status-and-drift.md) — desired/managed/observed state and current/future classifications.
|
||
- [Safe agent CRUD](fleet/how-to/create-update-delete-agent.md) — expected generation, dry-run, and partial-failure recovery.
|
||
- [Local lifecycle operations](fleet/how-to/start-stop-restart.md) — persisted versus one-shot actions.
|
||
- [Configurable interaction instance](fleet/how-to/configure-tess-interaction.md) and [validator instance](fleet/how-to/configure-ultron-validator.md) — generic identities and protected limits.
|
||
- [Reconcile and recover](fleet/operations/reconcile-and-recover.md) — plan/apply lock and recovery behavior.
|
||
- [Environment quarantine](fleet/operations/env-quarantine.md) — private evidence and value-free diagnostics.
|
||
- [Systemd/tmux troubleshooting](fleet/operations/systemd-tmux-troubleshooting.md) — socket, holder, unmanaged-session, and lock decisions.
|
||
- [Backup/restore boundary](fleet/operations/backup-restore.md) and [upgrade-assets hold](fleet/operations/upgrade-assets.md).
|
||
- [v1-to-v2 migration preview](fleet/migration/v1-to-v2.md) and [executable artifact dispositions](fleet/migration/example-profile-disposition.md).
|
||
- [FCM M5 closure evidence](reports/documentation/758-fleet-config-ia-closure.md) and [approved deferrals](reports/deferred/758-fleet-config-deferrals.md).
|
||
|
||
## Official channel plugins
|
||
|
||
- [Channel protocol architecture](DEVELOPER-GUIDE/architecture/channel-protocol.md) — shared lifecycle, message, stable-route, authorization, and response-target contracts; future adapters are explicitly draft.
|
||
- [Discord administrator configuration](ADMIN-GUIDE/security/discord-ingress.md) — secrets, allowlists, bindings, role policy, and thread permissions.
|
||
- [Discord user workflow](USER-GUIDE/workflows/discord-conversations.md) — in-channel messages, mention-created threads, and runtime-transparent continuity.
|
||
- [Channel plugin authoring](DEVELOPER-GUIDE/integrations/channel-adapters.md) — current shared contract and requirements for future adapters.
|
||
- [Discord package guide](../plugins/discord/README.md) — package behavior, configuration shape, and development commands.
|
||
|
||
## Native Kanban and canonical task SOT
|
||
|
||
- [Canonical requirements](requirements/native-kanban-sot.md) — ratified P0–P3 requirements and acceptance criteria.
|
||
- [Workstream index](native-kanban-sot/INDEX.md) — artifact map, lane partition, and delivery order.
|
||
- [Mission manifest](native-kanban-sot/MISSION-MANIFEST.md) — scope, authority, invariants, and gate model.
|
||
- [Task decomposition](native-kanban-sot/TASKS.md) — dependency-ordered implementation slices and ownership boundaries.
|
||
- [KBN-101 database role split](native-kanban-sot/KBN-101-DB-ROLE-SPLIT.md) — rc.16 direct-Drizzle storage-wrapper hold: legacy N-1/uncertified/non-operative pending -02/-03/-06/-08; exact README/user-guide wrapper forms fail before masking and source-consistency rejects runner-delegation copy; held bootstrap → TLS/roles → run → verify → readiness; plus prior attestation, pgvector owner, classifier, TLS, activation, and certification prerequisite.
|
||
- [Federated tier data migration](guides/migrate-tier.md) — active KBN-101-07 operator route: runner-produced target attestation, dedicated non-DDL importer, and paired credential-/attestation-file references only.
|
||
- [Frozen shared contract](native-kanban-sot/SHARED-CONTRACT.md) — schema, API, Coordinator, health, recovery, and migration contracts.
|
||
- [KBN-101 exact-head security review](reports/native-kanban-sot/kbn-101-contract-security-review-82ce325.md) — retained prior REQUEST CHANGES evidence for `da742ca`; rc.16 awaits independent exact-head re-review after closing the current generic storage-wrapper authority HIGH finding.
|
||
- [Initial independent review](reports/native-kanban-sot/canon-initial-review-no-go.md) — KCR-001–016 findings that blocked the first draft.
|
||
- [Final independent re-review](reports/native-kanban-sot/canon-final-rereview-go.md) — closure evidence and GO verdict.
|
||
- [Ultron final gate](reports/native-kanban-sot/ultron-final-go.md) — final requirements, authority, schema, migration, recovery, and evidence review.
|
||
|
||
## Tess interaction agent
|
||
|
||
### Operator guides
|
||
|
||
- [User guide](tess/USER-GUIDE.md) — authorized session, attach, send, stop, and handoff workflows.
|
||
- [Admin guide](tess/ADMIN-GUIDE.md) — deployment configuration, policy, and approval controls.
|
||
- [Developer guide](tess/DEVELOPER-GUIDE.md) — provider contracts, scope boundaries, and test workflow.
|
||
- [Plugin guide](tess/PLUGIN-GUIDE.md) — adapter, redaction, and identity-as-data requirements.
|
||
- [Operations guide](tess/OPERATIONS-GUIDE.md) — readiness, recovery, and incident-safe procedures.
|
||
|
||
### Architecture and security
|
||
|
||
- [Architecture](tess/ARCHITECTURE.md)
|
||
- [Threat model](tess/THREAT-MODEL.md)
|
||
- [Mos coordination boundary](tess/MOS-COORDINATION.md)
|
||
- [Hermes runtime adapter design](tess/hermes-runtime-adapter-design.md)
|
||
- [Operator plugin sketch](tess/M4-003-OPERATOR-PLUGIN-SKETCH.md)
|
||
|
||
### API contract
|
||
|
||
- [Tess OpenAPI contract](openapi-tess.yaml)
|
||
|
||
### Migration and qualification
|
||
|
||
- [Migration inventory](tess/M5-MIGRATION-INVENTORY.md)
|
||
- [Cutover procedure](tess/M5-MIGRATION-CUTOVER.md)
|
||
- [Rollback procedure](tess/M5-MIGRATION-ROLLBACK.md)
|
||
- [Retention and deprecation evidence](tess/M5-MIGRATION-RETENTION-DEPRECATION.md)
|
||
- [Verification matrix](tess/VERIFICATION-MATRIX.md)
|
||
- [Documentation checklist](tess/M5-003-DOCUMENTATION-CHECKLIST.md)
|
||
- [Independent Option 2 runtime-portability qualification (2026-07-14)](tess/qualification/2026-07-14-option2-runtime-portability.md)
|
||
|
||
## Runtime-neutral Mos portability
|
||
|
||
- [Optional AI egress gateway RFC](DEVELOPER-GUIDE/architecture/rfcs/optional-ai-egress-gateways.md) — draft placement and gates for LiteLLM, Bifrost, and translation proxies; no candidate is integrated.
|
||
- [Runtime-neutral Mos identity and failover mission](https://git.mosaicstack.dev/mosaicstack/stack/issues/754)
|
||
- [Logical identity and connector lease/fencing implementation](https://git.mosaicstack.dev/mosaicstack/stack/issues/755)
|
||
- [M1 logical identity and fencing architecture](DEVELOPER-GUIDE/architecture/decisions/mos-runtime-portability-m1.md)
|
||
- [M1 connector lease operations](ADMIN-GUIDE/operations/mos-connector-lease-operations.md) — held/non-operative.
|
||
|
||
## Comms evolution — Matrix-native MACP (design, draft)
|
||
|
||
- [RFC-001 — MACP: a Mosaic-native, Matrix-native comms layer](rfcs/RFC-001-MACP-MATRIX-NATIVE.md) — Synapse + Mosaic appservice backbone, MACP v1 protocol, presence/escalation, federation, strangler migration off the Hermes MCP bridge.
|
||
- [RFC-002 — Install, configuration & topology for the Matrix/MACP comms system](rfcs/RFC-002-INSTALL-CONFIG-TOPOLOGY.md) — open-source install topology modes, ACME cert provisioning, pluggable secret backend, and config precedence.
|