Documentation audit status
This page is the audit index for the public SDK documentation. It exists so a future change can be checked against a named surface instead of adding another disconnected page.
Coverage matrix
| Surface | Canonical guide | Detailed reference | Source of truth |
|---|---|---|---|
| Package install and compatibility | Installation | Installation & Setup | package.json, example/package.json, example/app.config.ts |
| Provider hierarchy and polyfills | App shell | Theme | src/polyfills/index.ts, example navigation |
| Auth and session UI | Authentication | Auth components | src/modules/auth/index.tsx |
| Theme and design tokens | App shell | Theme | src/modules/theme/index.ts |
| Bluetooth lifecycle and callbacks | Bluetooth | BT provider | src/modules/bt-management/index.ts |
| Device catalog, images, credits, localization | Device catalog | BT device UI | src/modules/bt-device/constants/ |
| BLE background restoration and queue | Background sync | BT troubleshooting | src/modules/bt-management/services/background-sync/ |
| HealthKit import | Health data | Apple Health | src/modules/data-sync/ |
| Health Connect import | Health data | Health Connect | src/modules/data-sync/ |
| UI component library | UI modules | Component categories in the sidebar | src/modules//index. |
| Public root and subpath exports | Public API | TypeScript declarations in build output | src/index.tsx, package exports |
| Build, CI, release, docs sync | Development and release | Contributing | .github/workflows/ |
| Failure diagnosis and platform limits | Troubleshooting | Component-specific troubleshooting | source comments and native setup |
Manual review rules
Before merging a source change:
- Check whether src/index.tsx or a module index changed.
- Check whether a public prop/type or peer dependency changed.
- Check whether a native config plugin or permission changed.
- Check whether a device name, image, credit, translation key, or measurement type changed.
- Update the canonical guide and the detailed reference together.
- Run the docs build and the relevant tests.
Known repository consistency item
The npm package metadata currently declares MIT, while the repository LICENSE file contains a proprietary/confidential notice. The README now links to the license rather than asserting a third license name, but maintainers must reconcile these two sources before making a new licensing claim. This is intentionally recorded here rather than silently guessing a legal resolution.