This folder holds the long-form docs. Root README.md is the entry point for the repo.
The wiki in .github/wiki/ is the primary source for diagram-heavy documentation.
- Secrets: AWS Secrets Manager only (no secrets on disk).
- Runtime: Node.js 22 + npm 11 (LTS).
- Data stack: PostgreSQL 18 + PostGIS, Redis 7.
- Frontend: React 19 + Vite 7 (TypeScript).
- Backend: Express 4 + TypeScript services/repositories.
- Do not add new docs unless they replace an existing page.
- Wiki is the primary source for diagrams; docs are for concise current state.
- If a diagram asset is missing, prefer updating the wiki Mermaid/source doc instead of linking to a dead binary export.
- Repository-wide engineering commandments live in ../AGENTS.md and ../CONTRIBUTING.md. Prefer referencing those instead of restating policy in multiple docs.
- Architecture - System overview and module organization.
- Development - Local dev setup and workflow.
- Deployment - Production deployment guidance.
- Configuration - Environment variables and configuration.
- API Reference - REST endpoints.
- Universal Filters - Detailed filter parameter reference.
- TODO - Shared active backlog and deferred follow-up work.
- Wiki Home - Diagram-heavy documentation hub.
- Wiki Map - Docs ↔ wiki mapping.
- Frontend - React components and client patterns.
- Testing - Test strategy and commands.
- Scripts - Utility scripts and maintenance.
- Database - Schema and data design.
- Configuration - Redis and environment configuration.
- Secrets - Secrets management.
- API Reference - Auth endpoints and API contracts.
- Security Policy - Disclosure and security posture.
- See SECRETS.md and ../SECURITY.md for additional material.
kiro/- Job manifest and execution guides for internal quality passes.fixes/- Targeted fix plans and notes.
docs/
├── README.md
├── API_REFERENCE.md
├── ARCHITECTURE.md
├── CLIENT.md
├── CONFIG.md
├── DATABASE_RADIO_ARCHITECTURE.md
├── DATA_QUALITY_FILTERING.md
├── DEPLOYMENT.md
├── DEVELOPMENT.md
├── FEATURES.md
├── PGADMIN_AWS_FIX.md
├── QUERY_PERFORMANCE.md
├── SECRETS.md
├── SECURITY_POLICY.md
├── SESSION_STATE.md
├── TESTING.md
├── WIKI_MAP.md
├── development/
├── fixes/
└── kiro/
- FEATURES.md - Feature catalog
- CLIENT.md - Frontend docs
development/- Additional implementation notes
- DEVELOPMENT.md - Common development issues
- DEPLOYMENT.md - Deployment issues
Historical notes are kept in dated markdown files and the fixes/ directory. Prefer the main top-level docs for current behavior.
- CONTRIBUTING.md - Contribution guidelines
- CODE_OF_CONDUCT.md - Community standards
- CHANGELOG.md - Version history
Last Updated: 2026-04-05