scholarr/docs

Documentation Index

Use this directory for project documentation outside README.md and agents.md.

Deploy

• docs/deploy/quickstart.md: deployment modes, local dev startup, and quality command reference.

Reference

• docs/reference/environment.md: complete environment-variable catalog and contract/audit notes.
• docs/reference/api_contract.md: API envelope contract and endpoint semantics.

Architecture

• docs/architecture/domain_boundaries.md: domain boundaries, user-scoped data rules, and frontend behavior notes.

Operations

• docs/ops/scrape_safety_runbook.md: scrape cooldown and blocked-IP operations.
• docs/ops/db_runbook.md: backup, restore, and verification workflows.
• docs/ops/migration_checklist.md: migration planning and rollout checklist.

Frontend

• docs/frontend/theme_phase0_inventory.md: theme-token inventory and adoption notes.

Contribution

• docs/contributing.md: contribution policy and merge checklist.