From e0fe7c0a3dea6ffa5c7626d4a17fbc8853febb34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Bombeck?= Date: Sun, 17 May 2026 00:28:05 +0200 Subject: [PATCH] docs: README discoverability rework + OG metadata + planning audit reports MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- .planning/round-audit-code-quality.md | 290 ++++++++++++++++ .planning/round-audit-docs-depth.md | 196 +++++++++++ .planning/round-audit-docs-discoverability.md | 235 +++++++++++++ .planning/round-audit-mobile-security.md | 98 ++++++ .planning/round-audit-perf.md | 105 ++++++ .planning/round-audit-test-coverage.md | 309 ++++++++++++++++++ .planning/round-audit-ux.md | 153 +++++++++ README.md | 41 ++- docs/README.md | 33 ++ src/app/layout.tsx | 18 +- 10 files changed, 1464 insertions(+), 14 deletions(-) create mode 100644 .planning/round-audit-code-quality.md create mode 100644 .planning/round-audit-docs-depth.md create mode 100644 .planning/round-audit-docs-discoverability.md create mode 100644 .planning/round-audit-mobile-security.md create mode 100644 .planning/round-audit-perf.md create mode 100644 .planning/round-audit-test-coverage.md create mode 100644 .planning/round-audit-ux.md create mode 100644 docs/README.md diff --git a/.planning/round-audit-code-quality.md b/.planning/round-audit-code-quality.md new file mode 100644 index 000000000..04c99bb13 --- /dev/null +++ b/.planning/round-audit-code-quality.md @@ -0,0 +1,290 @@ +# Code Quality + Documentation Audit — 2026-05-17 + +## Executive summary + +The repo is in unusually good shape for its size: `tsc --noEmit` and `eslint` +both pass clean, there are zero `TODO`/`FIXME`/`XXX`/`HACK` markers in product +code, zero empty `catch` blocks outside one inline `