README.md

Documentation Index

Source of truth for developer docs in repo.

Read First

• documentation/architecture/ARCHITECTURE.md — runtime architecture overview and live entrypoints
• documentation/architecture/MULTI_TENANCY.md — tenant model, headers, scopes, Casbin domain rules
• documentation/architecture/ARCHITECTURE_VISUAL_AND_SEQUENCE.md — request flows and sequence diagrams
• documentation/guides/GETTING_STARTED.md — local setup and runbook
• documentation/guides/DEVELOPER_FLOW.md — reading order and change workflow for future developers
• documentation/guides/TESTING.md — test strategy and verification order
• documentation/guides/API_USAGE.md — API usage for consumers
• documentation/guides/API_ACCESS_WORKFLOW.md — auth and access workflow
• documentation/guides/REALTIME.md — SSE and WebSocket flow
• documentation/guides/RESUMABLE_UPLOAD.md — TUS upload flow
• documentation/guides/WEBHOOKS.md — webhook behavior and events
• documentation/guides/OBSERVABILITY.md — tracing, metrics, logs

Architecture

• documentation/architecture/ARCHITECTURE.md
• documentation/architecture/SYSTEM_ARCHITECTURE.md
• documentation/architecture/MULTI_TENANCY.md
• documentation/architecture/ARCHITECTURE_VISUAL_AND_SEQUENCE.md

Guides

• documentation/guides/GETTING_STARTED.md
• documentation/guides/DEVELOPER_FLOW.md
• documentation/guides/TESTING.md
• documentation/guides/API_USAGE.md
• documentation/guides/API_ACCESS_WORKFLOW.md
• documentation/guides/ACCESS_RIGHTS_REFERENCE.md
• documentation/guides/FRONTEND_STRUCTURE.md
• documentation/guides/REALTIME.md
• documentation/guides/RESUMABLE_UPLOAD.md
• documentation/guides/SEARCH.md
• documentation/guides/STORAGE.md
• documentation/guides/WEBHOOKS.md
• documentation/guides/OBSERVABILITY.md
• documentation/guides/MAINTENANCE.md

API Contracts

• documentation/api/AI_STREAMING_CONTRACT.md — planned or supporting contract unless matched to live route

Legacy Planning

Docs below are planning material or product ideation. Keep them separate from runtime docs:

• documentation/ops/ORGANIZATION_LIFECYCLE_RUNBOOK.md
• documentation/productplan/*

Use them for backlog, UI direction, and migration notes only. Do not treat them as live runtime source of truth.