- AGENTS.md: canonical project entry point (Quick Nav, pipeline, constraints) - docs/: complete docs tree — architecture, API spec, DB schema, infra, runbook, requirements, tech stack, principles, reference ADRs, guides, tasks backlog, testing strategy - tests/README.md: test commands, structure, known gaps - README.md / CLAUDE.md / DEPLOYMENT.md: updated with canonical doc links - .archive/: backup of pre-documentation-pipeline originals - backend/uv.lock: uv dependency lockfile - Delete committed __pycache__ .pyc files (should have been gitignored) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| adrs | ||
| guides | ||
| README.md | ||
Reference Documentation — Accessible Video Processing Platform
This hub indexes all reference documentation: architectural decisions, how-to guides, operator manuals, and research notes.
Architecture Decision Records (ADRs)
ADRs capture significant architectural decisions, their context, and their trade-offs.
| ADR | Title | Status |
|---|---|---|
| ADR-001 | Async Celery bridge via new event loop per task | Accepted |
| ADR-002 | Access tokens stored in JS memory, not localStorage | Accepted |
| ADR-003 | Hybrid exact + vector glossary retrieval | Accepted |
Guides (Developer How-Tos)
| Guide | Description |
|---|---|
| testing-strategy.md | Risk-based testing approach, what to test and how |
Manuals (Operator Procedures)
No operator manuals yet. Add as operational procedures are formalised.
Research
No research notes yet. Add technology evaluations as decisions are made.
Maintenance
Update triggers: New ADR created, new guide written, research note added. Verification: Every ADR in this index has a corresponding file. No files in subdirectories are missing from the index.