Documentation Map

Documentation map

Use this page to find the right level of detail and to understand which artifact wins when documentation and implementation disagree.

Start with the task, not the subsystem

Task	Primary guide	Follow-up
See what Nooklet does	Feature guide	Engineering dossier
Follow a curated setup and usage path	User guide	Getting started
New guided Docker installation	Docker setup builder	First-time setup
New manual Docker installation	Docker installation	First-time setup
Fix storage or path errors	Storage and path mapping	Troubleshooting
Add or verify integrations	Service connections	Indexers
Understand a request end to end	Downloads and import	Data and background jobs
Monitor or archive public YouTube media	YouTube monitoring and downloads	Storage and path mapping
Upgrade or recover	Backup, restore, and upgrades	Health and diagnostics
Change the code	Development guide	Testing and CI
Review design and risk	Architecture	Security model

Documentation authority

When two documents conflict, use this order:

1. Executable code, database schema, tests, and workflows define observed behavior.
2. src/lib/env.ts defines application environment variables.
3. .env.example is the operator template and should mirror the environment schema.
4. docker-compose.yml and the Dockerfile define the shipped container deployment.
5. Architecture decision records explain intent and trade-offs; their delivery notes may age.
6. The Wiki translates current behavior into operator and contributor procedures.
7. The README is a concise entry point, not a complete reference.

The public Pages site adds a visual Feature guide, a curated User guide, and a source-backed engineering dossier. These entry points do not replace the Wiki’s detailed operational runbooks.

Maintenance standard

Every operational change should update the code, tests, .env.example when relevant, the affected Wiki source in docs/wiki, and the README only when the five-minute path changes. See Documentation policy.

---

Installation paths last reviewed: August 19, 2026.