OpenVitals Docs

Start here when you need to understand the app, a feature, or the implementation direction.

Use The App

• App guide: install, getting started, Health Connect, permissions, privacy, FAQ, editions, screenshots, and support.
• How-to guides: concrete workflows that need step-by-step instructions.
• Release notes: latest user-facing release summary. Full history: CHANGELOG.md.

Browse Features

• Feature guide: grouped feature pages for current app behavior.
• Feature map: canonical mapping between docs, routes/widgets, and implementation packages.
• Functional inventory: detailed checklist of view, write, import, settings, and privacy capabilities.

Recently added feature pages:

• Elevation correction: imported routes take their altitude from SRTM tiles stored on the phone.
• Sync with another phone: copying Health Connect records between two phones over Bluetooth.

Contribute And Architecture

• Engineering guide: architecture, development setup, feature playbook, code analysis, and test parity.
• Architecture: current single-module architecture, feature boundaries, period detail pattern, and data-access rules.
• Feature playbook: checklist for adding or extending a metric feature.
• Translations: translate OpenVitals in your language, Codeberg Translate setup, shipping policy, and validation checks.

Reference And Archive

• Proposals: non-current plans and design explorations.
• Reference: external or supporting design/reference material.
• Images: screenshots and image assets used by docs.

If code and docs disagree, prefer the docs for new work and refactor incrementally toward them.

---

Generated from docs/README.md. Edit it there; changes made here are overwritten.