This folder holds the product, behavior, and architecture docs for the shipped app, plus historical migration and spike material.
PRD.md- product goals and simplification intent.BEHAVIOR.md- behavior contract index.ARCHITECTURE.md- runtime ownership and package boundaries.schema.json- source input contract.behavior/README.md- detailed behavior specs.architecture/app.md- composition root and startup ownership.architecture/ui.md- presentation ownership.architecture/source.md- source ingestion, snapshots, and browse ownership.architecture/downloads.md- queue, execution, and output ownership.architecture/realdebrid.md- Real-Debrid boundary ownership.architecture/remotezip.md- remote ZIP boundary ownership.architecture/diagnostics.md- diagnostics ownership.architecture/diagram/diagrams/app-architecture.mmd- canonical high-level runtime diagram.
MIGRATION.md- migration plan and cutover history.architecture/SPIKE.md- spike gates used before the runtime was finalized.spikes/specs/README.md- executable spike specs.spikes/apps/README.md- spike harness docs.spikes/research/README.md- research notes.spikes/fixtures/README.md- fixture inventory and generation workflow.spikes/outputs/README.md- spike result artifacts.
behavior/- behavior contracts.architecture/- runtime ownership docs and the diagram viewer.spikes/- historical spike specs, apps, fixtures, and outputs.
cd docs
just diagramOpen the local Vite URL shown in terminal.
cd docs
just export-docsjust export-docs writes a timestamped zip under docs/exports/.
When run interactively, it also asks whether to include the active ExecPlans and, if you answer yes, adds them under plans/ in the export archive.
- Top navigation links to each diagram.
- Mermaid rendering with fullscreen, zoom in/out, and reset.
- Mouse drag pan and wheel zoom.
- Optional raw Mermaid source view.
architecture/diagram/index.html- viewer shell.architecture/diagram/src/main.js- render logic and controls.architecture/diagram/src/diagrams.js- diagram index.architecture/diagram/diagrams/app-architecture.mmd- canonical architecture diagram.
cd docs/architecture/diagram
npm run check
npm test
npm run buildcheck: offline Mermaid flowchart syntax lint.test: diagram catalog and syntax tests.build: viewer bundle validation.