docs/README.md

Rama main · réplica de lectura del repositorio original.

# docs/ — the map

How to work in the repo: `AGENTS.md` (root). What the product says in public:
`docs/design/positioning.md` (LOCKED). Everything below is where each surface
lives and which document owns it.

| Surface | Route | Code | Owning doc |
|---|---|---|---|
| MCP tools + resources | `/mcp` | `mcp/src/vidtheque_mcp/tools/` | `docs/design/tool-surface.md` |
| Index (SQLite + sqlite-vec + FTS5) | — | `mcp/src/vidtheque_mcp/db/` | `docs/design/index-schema.md` |
| Pipeline + jobs | — | `mcp/src/vidtheque_mcp/{pipeline,jobs}/` | `docs/design/index-schema.md`, `docs/design/DECISIONS.md` |
| Following (channels, budget, ledger) | — | `mcp/src/vidtheque_mcp/follows/` | `docs/design/following.md` |
| Auth (none / token / oauth) | `/{authorize,token,register,revoke}`, `/auth/*`, `/.well-known/*` | `mcp/src/vidtheque_mcp/auth/` | `docs/design/DECISIONS.md` #1 |
| Landing | `/` | `web/src/components/public/landing/`, `web/src/app/(public)/page.tsx` | `DESIGN.md` |
| Demo (read-only projection) | `/demo` | `web/src/app/(public)/demo/` | `docs/design/demo-site.md` |
| Public read facade | `/api/*`, `/videos/{id}/export.md` | `mcp/src/vidtheque_mcp/public/` | `docs/design/demo-site.md` |
| Dashboard | `/dashboard` | `web/src/app/(dashboard)/dashboard/` (pages), `mcp/src/vidtheque_mcp/dashboard/` (JSON + writes) | `docs/design/dashboard.md` |
| Worker HTTP API | `:8081/v1/*` | `worker/` | `worker/openapi.json`, `worker/README.md` |
| Deploy | — | `deploy/`, `deploy/staging/` | `docs/deploy-public.md` |
| Bench | — | `bench/` | `bench/README.md` |

The system is **two processes** — the MCP server (state: SQLite, keyframes,
jobs) and the worker (stateless GPU inference) — talking **HTTP only**. The
landing, the demo and the dashboard's pages are a third
deployable, the Next.js app in
`web/`, over one origin split by path: exact page GETs go to Next, everything
else to the MCP server's own Starlette app — which renders no HTML at all since
2026-09-06 (`docs/design/frontend-migration.md` §1a, §1d). `/api/*` and the
read-only tool surface exist only under `VIDTHEQUE_PUBLIC_READONLY=1`. Every env var is
documented in `deploy/.env.example`, the document of record.

Also here: `docs/ROADMAP.md` (the only list of open work),
`docs/LESSONS.md` (operational rules an incident paid for),
`docs/security.md` (the map of security material), `docs/takedown.md` (creator
removal), `docs/deploy-public.md` (the go-public runbook), `docs/self-host.md`
(running your own, captions only, no GPU).