HealthArchive Documentation

This documentation portal covers the HealthArchive app monorepo and links to the separate datasets documentation.

Public documentation focuses on project purpose, data methodology, architecture, limitations, and reproducible local development. Deployment is environment-specific and handled outside this public repository; exact host paths, private inventories, and operator-only runbooks are intentionally not documented here.

Quick Start by Role

Choose the path that matches your role:

• Developers: Start with Development Guide → Live Testing
• Deploying: Use your environment-specific deployment runbook outside this public docs portal
• API consumers: Start with API Documentation
• Researchers: Start with Architecture → Datasets

Key Resources

Documentation Structure

This docs portal is built from docs/ in the app monorepo. Frontend-specific docs remain canonical under frontend/docs/ and are surfaced here through the docs/frontend/ bridge; datasets docs remain canonical in the separate datasets repo:

• Frontend bridge: frontend/README.md
• Datasets pointers: datasets-external/README.md

Private shared-ops documentation is the canonical home for shared host facts such as ingress ownership, service inventory, backup posture, and host access rules. This public portal keeps only the app-specific and local-development material needed to understand and reproduce the project.

Recommended reading order

1. Project docs portal (monorepo + datasets navigation)
2. this page
3. Architecture & implementation (how the code works)
4. architecture.md
5. Public API and data access
6. api.md
7. api-consumer-guide.md
8. datasets-external/README.md
9. Local development / live testing (how to run it locally)
10. development/live-testing.md
11. development/dev-environment-setup.md (local setup guidance)
12. development/testing-guidelines.md (backend test expectations)
13. Contribution and public project context
14. contributing.md

Notes

• No secrets live in this repo. Any token/password values shown in docs must be placeholders.
• The archive_tool crawler has its own internal documentation at src/archive_tool/docs/documentation.md.