Vadym Samoilenko a3b300b76a docs: add canonical documentation + audit cleanup

- 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>

2026-04-29 14:22:51 +01:00

2.2 KiB

Raw Permalink Blame History

Documentation Hub — Accessible Video Processing Platform

This is the central index for all project documentation. Each section links to a specific domain doc.

Project Documentation

Document	Contents
requirements.md	Functional requirements, QC workflow, RBAC matrix
architecture.md	System design, job state machine, data flow, security model
tech_stack.md	All dependency versions, configuration anchors
api_spec.md	REST endpoints, WebSocket, auth flows
database_schema.md	MongoDB collections, indexes, data shapes
infrastructure.md	Server inventory, ports, GCS layout, external services
runbook.md	Local setup, deploy, restart, backup, rollback

Reference Documentation

Directory	Contains
reference/README.md	Index of ADRs, guides, manuals, research
reference/adrs/	Architecture Decision Records
reference/guides/	Developer how-to guides
reference/manuals/	Operator manuals
reference/research/	Technology research notes

Standards and Principles

Document	Contents
documentation_standards.md	60 universal documentation requirements
principles.md	11 development principles (Standards First, YAGNI, KISS, DRY…)

Task and Test Management

Document	Contents
tasks/README.md	Task management rules and conventions
tests/README.md	Test strategy, commands, coverage targets

Canonical Entry Point

All documentation is reachable from ../AGENTS.md. Agents and humans should start there.

Maintenance

Update triggers: New doc added, section moved, external URL changes. Verification: All links in this file resolve. AGENTS.md Quick Navigation matches this hub.

2.2 KiB Raw Permalink Blame History