Skip to content

docs: README refresh, architecture, contributing, security, MIT license - #70

Merged
bibeshpyakurel merged 1 commit into
devfrom
docs/readme-refresh
Oct 18, 2026
Merged

bibeshpyakurel merged 1 commit into
devfrom
docs/readme-refresh

Conversation

@bibeshpyakurel

Copy link
Copy Markdown
Owner

Docs only: no app code, schema or behavior changes.

What changed

  • README: a light/dark banner in the app's own colors, badges, a screenshot gallery (six phone screens that switch with the viewer's GitHub theme), features, a "how it works" diagram, the three product rules, stack, quick start with an env table, scripts, project structure, testing, deployment flow and a docs index.
  • docs/architecture.md: system overview, data model (ER diagram), photo-flow and vitals sequence diagrams, check engine, catalog, security model.
  • docs/README.md: an index of every spec and plan.
  • CONTRIBUTING.md: PR-into-dev workflow, product boundaries, conventions, shared-database rules, PR checklist.
  • SECURITY.md: private vulnerability reporting (now enabled on the repo) and how data is handled.
  • LICENSE: MIT.
  • .env.example: adds the missing VITALLENS_API_KEY.

How it was checked

  • The screenshots come from a local production build with the e2e fake Gemini (no model or VitalLens quota spent), taken as one guest user who was deleted afterwards.
  • The README was rendered through GitHub's Markdown API, and all six Mermaid diagrams parse and render with Mermaid 11.
  • Claims were checked against the code. For example, SUPABASE_SECRET_KEY isn't used at runtime, and the catalog holds 11,999 labels.

Deploy

Merging doesn't deploy, and the app is unchanged. The repo's default branch is main, though, so GitHub's landing page shows the new README only after the next npm run deploy:prod moves main.

🤖 Generated with Claude Code

- README: light/dark banner, badges, a screenshot gallery (six phone screens,
  light and dark), features, how it works, stack, quick start, env table,
  scripts, structure, testing, deployment and docs index.
- docs/architecture.md: system overview, data model, photo and vitals flows,
  check engine, catalog, security model.
- docs/README.md: index of every spec and plan.
- CONTRIBUTING.md, SECURITY.md, LICENSE (MIT).
- .env.example: add VITALLENS_API_KEY.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@bibeshpyakurel
bibeshpyakurel merged commit 6c78ec2 into dev Oct 18, 2026
2 checks passed
@bibeshpyakurel
bibeshpyakurel deleted the docs/readme-refresh branch October 18, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant