Documentation coverage
This page maps the public @ovok/native surface to its task guides and component
references. It reflects package version 1.10.4 and the module entry points
exported by src/index.tsx and package.json.
Coverage map
| SDK area | Guide | Component and API references |
|---|---|---|
| Install, compatibility, and runtime setup | Installation · App shell | Polyfills · Theme |
| Authentication and session UI | Authentication | Auth components |
| Bluetooth connection and measurement | Bluetooth | Bluetooth management · Device UI · Device manuals |
| Device catalog and supported hardware | Device catalog · All supported devices | Catalog and device references |
| Bluetooth and Android background delivery | Background sync | Background sync APIs |
| HealthKit and Health Connect | Health data | Health sync components |
| Measurement field semantics | Measurement field catalog | Measurement components |
| App UI and reusable task flows | App UI · Reusable flows | UI components |
| Guided breathing | Breathing exercises | Breathing exercise components |
| Content cards, lists, and Composition details | Content | Content components and context |
| CMS content and translations | CMS | CMS hooks |
| Diary cards | Diary | Diary components |
| Journal prompts and entries | Journal | Journal components |
| Language selection | Language switcher | Language switcher components |
| Measurement lists and ranges | Measurements | Measurement components |
| Observation detail presentation | Observation details | Observation detail components |
| Patient cards and lists | Patient UI | Patient components |
| PDF documents | PDF viewer | PDFViewer |
| Selection sheets | Picker sheets | PickerSheet and WheelPicker |
| Linear and circular progress indicators | Progress bars · Progress ring | ProgressBar · ProgressRing |
| FHIR Questionnaire rendering and submission | Questionnaire forms | Questionnaire components and advanced API |
| Settings lists | Settings | Setting components |
| Real-time socket events | Real-time sockets | Socket provider, hooks, and types |
| In-screen tabs | Tabs | Tab components and provider |
| Measurement task tiles | Tiles | Tile components |
| Ovok-hosted images | Images | OptimizedImage |
| Form, conditional, animation, and telemetry helpers | SDK helpers · Observability | Helpers |
| Root exports and subpath imports | Public API map | Generated from package exports and source barrels |
| Local development, release, and docs sync | Development and release | Repository scripts and CI workflows |
| Platform limits and issue diagnosis | Troubleshooting | Feature-specific references linked above |
Keeping coverage current
When a public module, export, prop, native permission, or peer dependency changes:
- Update the task guide for the affected workflow and the matching component reference.
- Run
yarn docs:generateto refresh the public API map and LLM reference files. - Run
yarn doc buildto validate Docusaurus pages, sidebar entries, and internal links. - Sync the
doc/docs/tree intoActimi/ovok-docsusing the repository'sscripts/sync-docs-to-ovok-docs.mjsworkflow.
The docs workflow targets the dev branch of Actimi/ovok-docs. The SDK repository
remains the source of truth for these pages.
License source
The repository's root LICENSE file is the license source. package.json points to
that file with SEE LICENSE IN LICENSE; this documentation does not make a separate
licensing claim.