Skip to main content

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 areaGuideComponent and API references
Install, compatibility, and runtime setupInstallation · App shellPolyfills · Theme
Authentication and session UIAuthenticationAuth components
Bluetooth connection and measurementBluetoothBluetooth management · Device UI · Device manuals
Device catalog and supported hardwareDevice catalog · All supported devicesCatalog and device references
Bluetooth and Android background deliveryBackground syncBackground sync APIs
HealthKit and Health ConnectHealth dataHealth sync components
Measurement field semanticsMeasurement field catalogMeasurement components
App UI and reusable task flowsApp UI · Reusable flowsUI components
Guided breathingBreathing exercisesBreathing exercise components
Content cards, lists, and Composition detailsContentContent components and context
CMS content and translationsCMSCMS hooks
Diary cardsDiaryDiary components
Journal prompts and entriesJournalJournal components
Language selectionLanguage switcherLanguage switcher components
Measurement lists and rangesMeasurementsMeasurement components
Observation detail presentationObservation detailsObservation detail components
Patient cards and listsPatient UIPatient components
PDF documentsPDF viewerPDFViewer
Selection sheetsPicker sheetsPickerSheet and WheelPicker
Linear and circular progress indicatorsProgress bars · Progress ringProgressBar · ProgressRing
FHIR Questionnaire rendering and submissionQuestionnaire formsQuestionnaire components and advanced API
Settings listsSettingsSetting components
Real-time socket eventsReal-time socketsSocket provider, hooks, and types
In-screen tabsTabsTab components and provider
Measurement task tilesTilesTile components
Ovok-hosted imagesImagesOptimizedImage
Form, conditional, animation, and telemetry helpersSDK helpers · ObservabilityHelpers
Root exports and subpath importsPublic API mapGenerated from package exports and source barrels
Local development, release, and docs syncDevelopment and releaseRepository scripts and CI workflows
Platform limits and issue diagnosisTroubleshootingFeature-specific references linked above

Keeping coverage current​

When a public module, export, prop, native permission, or peer dependency changes:

  1. Update the task guide for the affected workflow and the matching component reference.
  2. Run yarn docs:generate to refresh the public API map and LLM reference files.
  3. Run yarn doc build to validate Docusaurus pages, sidebar entries, and internal links.
  4. Sync the doc/docs/ tree into Actimi/ovok-docs using the repository's scripts/sync-docs-to-ovok-docs.mjs workflow.

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.