This directory is the canonical home for project documentation.
- Overview: product scope, collected data, and ranking model.
- Monthly Snapshot Architecture: monthly ranking flow, collaborator responsibilities, and architecture guardrails.
- SQLite Data Ownership: table ownership, shared read dependencies, and schema change conventions.
- Development: local setup, quality checks, and day-to-day development commands.
- GitHub Operations: persistent CLI authentication, pull request and Dependabot triage, merge policy, and GitHub Actions incident handling.
- Web App: local web server usage, public routes, Cloudflare purge, and cache expectations.
- Crawl Jobs: monthly and package job behavior, production services, resume semantics, and server commands.
- Deployment: production topology, GitHub Actions deploy flow, and one-step rollback behavior.
- Publication: public snapshot rules, Cloudflare purge after publish or rollback, historical metric semantics, and publication rollback.
- Performance: load profile, SLOs, query-plan checks, and spike response.
- Operations Runbook: Sentry and Cloudflare setup, incident handling, restarts, and backup restore steps.
- User Actions: request paths that write state or call external APIs.