mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-08 20:42:43 +00:00
Marc-André Bombeck
e0fe7c0a3d
README:
- Add a "How it compares" matrix against Withings web, Apple Health,
Oura, Garmin, and generic CSV. The audit found this section absent;
self-hosters arrive comparing alternatives and bounce when there's
no head-to-head.
- Promote Apple Health import + AI Coach as standalone Key-Features
bullets. Apple Health was the v1.4.34 banner feature with zero
grep matches in the README until now; the audit ranked it the
single highest-intent search keyword for ex-iOS users. AI Coach
+ Insights moved out from under "Multi-Provider AI Insights" into
a dedicated bullet that names the Coach, Daily Briefing, Weekly
Report, and Health Score surfaces.
- Status block under "What it is" so visitors see release cadence
+ current focus (native iOS client) without trawling the changelog.
- Badge row: drop "PRs welcome" + duplicate Self-Hosted, add a live
"Latest release" badge + a GHCR multi-arch badge so the landing
page surfaces version + container distribution at a glance.
- Tagline tightened to lead with "self-hosted health tracker" + the
two integration anchors (Withings + Apple Health) — both phrases
are search-keyword fronts the GitHub search index picks up.
- Drop the dead SESSION_SECRET env entry from Quick Start (3
secrets, not 4) and the Environment Variables table — the env
var was documented as required but never read by code (per the
code-quality audit). Companion env-removal in docker-compose /
.env.example / entrypoint ships in a parallel batch.
- Add a one-line OpenAPI pointer above the API-Reference table so
integrators discover the codegen source.
Layout / OG metadata:
- openGraph + twitter cards now carry images, a higher-intent
description, and a summary_large_image card. Uses the existing
logo-readme.png as the OG asset; replace with a 1200x630 dashboard
capture when one ships.
GitHub repo metadata (via gh CLI, no git diff):
- description tightened from 290 chars to 156 chars, keyword-front.
- homepage flipped from a personal tenant to demo.healthlog.dev so
sidebar clicks land on a working demo instead of a login wall.
- Topics: dropped 6 generic/PII-adjacent entries (glp-1, mounjaro,
tracking, health, dashboard, bloodpressure), added 6 high-intent
ones (apple-health-import, withings-alternative, glucose-tracker,
mood-tracker, ai-insights, personal-dashboard).
Planning artifacts:
- 7 audit reports drop into .planning/round-audit-*.md covering
mobile-security, UX, code-quality, README/discoverability,
perf, mobile-deep (pending), test-coverage, docs-depth. These
are the working notes for the v1.4.34.4 audit-driven release.
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
# `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/`](./api/) — the OpenAPI 3.1 spec for the native-client subset
|
|
(iOS DTO codegen target). See [`api/README.md`](./api/README.md) for
|
|
the preview commands.
|
|
- [`ops/`](./ops/) — backup / restore + encryption-key-rotation
|
|
playbooks. These are the runbooks an operator reaches for during an
|
|
incident.
|
|
- [`self-hosting/`](./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/`](./migration/) — release-by-release migration notes.
|
|
Read the entry for the version you're upgrading from.
|
|
- [`audit/`](./audit/) — per-release audit summaries archived for
|
|
forensic traceability.
|
|
- [`apple-store-connect-checklist.md`](./apple-store-connect-checklist.md)
|
|
— the iOS submission gate.
|
|
- [`doctor-report.md`](./doctor-report.md) — PDF generator design
|
|
notes.
|
|
- [`codex-protocol-spec.md`](./codex-protocol-spec.md) — Codex / ChatGPT
|
|
OAuth protocol reverse-engineering notes.
|
|
- [`ui-guidelines.md`](./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](../README.md#quick-start).
|