Files
HealthLog/docs
Marc-André Bombeck 04aa2fc8b9 docs(diagrams): add five Dracula-styled architecture diagrams
Five SVG diagrams anchor the architecture story across README, the
public doc site and the landing page:

- 01-data-flow: source → ingest → store → read → surface
- 02-coach-pipeline: question → snapshot → prompt → provider chain → cited reply
- 03-self-hosting-topology: reverse proxy → app + worker → Postgres + image registry
- 04-source-priority: per-metric ladder with audit-trail kept/dropped lanes
- 05-security-model: three concentric layers plus rate-limit / audit / SSRF rails

Hand-authored SVG, no external dependencies, mirrored into the
healthlog-docs and healthlog-landing repos so each surface ships its own
copy.
2026-05-17 14:14:41 +02:00
..

docs/ — internal reference + operator playbooks

The user-facing documentation lives at https://docs.healthlog.dev — that's the canonical surface for self-hosting guides, integration walkthroughs, AI-provider setup, and the doctor-report workflow.

The files in this directory are the internal operator playbooks, audit notes, and machine-readable specs that ship alongside the source:

  • api/ — the OpenAPI 3.1 spec for the native-client subset (iOS DTO codegen target). See api/README.md for the preview commands.
  • ops/ — backup / restore + encryption-key-rotation playbooks. These are the runbooks an operator reaches for during an incident.
  • self-hosting/ — horizontal-scaling notes (HEALTHLOG_PROCESS_TYPE=web|worker|all) and the deploy-pipeline recipe. Routine install steps stay on docs.healthlog.dev.
  • migration/ — release-by-release migration notes. Read the entry for the version you're upgrading from.
  • audit/ — per-release audit summaries archived for forensic traceability.
  • apple-store-connect-checklist.md — the iOS submission gate.
  • doctor-report.md — PDF generator design notes.
  • codex-protocol-spec.md — Codex / ChatGPT OAuth protocol reverse-engineering notes.
  • ui-guidelines.md — UI / a11y house style.

If you're a self-hoster looking to spin up an instance, start at https://docs.healthlog.dev or jump to the Quick Start in the project README.