Start here. Docs are grouped by what you are trying to do.
| Doc | What it covers |
|---|---|
| HOW_TO_RUN.md | Docker Compose setup, first boot, the export step for Qwen/OpenVINO |
| RUN_LOCAL.md | Recommended no-Docker launcher, plus source checkout and release-wheel installation |
| MIGRATION.md | Moving a deployment's data between Docker and native |
| ENV_REFERENCE.md | Every environment variable, with defaults |
| api/HTTP_API_REFERENCE.md | Every HTTP endpoint, request and response shapes |
| Doc | What it covers |
|---|---|
| architecture/SYSTEM_OVERVIEW.md | Components, request flow, endpoint map |
| architecture/FRONTEND_OVERVIEW.md | React pages, zustand state, key UI flows |
| architecture/MODEL_SWAP_AND_QUEUEING.md | Backend swapping, request queueing, idle unload |
| architecture/pocket_tts_integration.md | The default CPU backend and its prosody behavior |
| architecture/OMNIVOICE_REFERENCE.md | OmniVoice accent engine, audition flow, licensing |
| architecture/STUDIO_LIBRARIES.md | Voice/segment/project libraries: storage layout, ID scheme, invariants |
| architecture/ACCELERATOR_FAMILIES.md | GPU family resolution and per-family first-boot torch install (Phase A6) |
| architecture/VOICE_DESIGN.md | Qwen VoiceDesign: model, design flow, design→library lifecycle |
| architecture/PERSONA_FORGE_STUDIO.md | Studio UI architecture: layout, panels, cross-cutting flows |
| Doc | What it covers |
|---|---|
| dev/LOCAL_SETUP.md | uv-managed local environment |
| DEV_TEST_LOOP.md | The edit → test → deploy loop |
| TEST_STRATEGY.md | Test tiers and what belongs in each |
| dev/DESIGN_SYSTEM.md | Frontend design tokens and component primitives |
| dev/validation_checks.md | Pre-merge validation commands |
| dev/PROSODY_HARDENING.md | Prosody alignment hardening: shared edit/repair contracts |
| dev/OUTPUT_POLISH_MATRIX.md | Objective invariants delivered audio must satisfy |
| dev/INTERNAL_OPERATIONS.md | Host-specific ops: docker-agent layout, export, deploy |
Compact references written for AI coding agents working in this repo.
| Doc | What it covers |
|---|---|
| agent-reference/RUNTIME_AND_MEMORY.md | Runtime invariants, memory ceilings |
| agent-reference/EXPORT_SYSTEM.md | The OpenVINO export pipeline |
| agent-reference/TRANSFORMERS_COMPAT.md | Transformers 5 compatibility shims |
archive/— dated design, implementation, and analysis plans, grouped by topic, kept as a record once resolved or supersededdev/benchmarks/— benchmark logs from the OpenVINO eraarchive/openvino/OPENVINO_IMPLEMENTATION.mdanddev/benchmarks/OPENVINO_RESULTS.md— Qwen3-TTS/OpenVINO-era implementation and benchmark records (both carry historical banners; AGENTS.md still cites the staged validation gates in the former)plans/— in-flight plans
Docs under the archive are historical. Where they conflict with the current docs above, the current docs win.