Android Documentation Index
Verification Status
| Metric | Value |
|---|---|
| Last Full Verification | 2025-07-10 |
| Verified Against Commit | a2e810d (branch: dev) |
| Total Documents | 43 |
| Accuracy Target | 10/10 per document |
How to Update
To update documentation after code changes:
- Get the verified commit: the hash above
- Check what changed:
git log --oneline <verified_commit>..HEAD - Identify affected docs based on changed source files
- Re-verify and update affected documents
- Update the verified commit hash and date above
Documentation Map
Core Architecture
- overview.md — App overview, tech stack, project structure, getting started
- architecture.md — Clean Architecture layers, dependency flow, design decisions
- mvi-pattern.md — IntentViewModel, state management, intent handling
- dependency-injection.md — Hilt modules, scoping, build-type variants
Data Layer (data-layer/)
- index.md — Overview, patterns, inventories
- network.md — OkHttp, Retrofit, interceptors, authenticator
- auth.md — AuthApi, AuthRepository, DTOs, UserMapper
- devices.md — DeviceApi, DeviceRepository, DeviceMapper
- positions.md — PositionApi, PositionRepository
- events.md — EventApi, EventRepository
- geofences.md — GeofenceApi, GeofenceRepository
- notifications.md — NotificationApi, NotificationRepository
- commands.md — CommandApi, CommandRepository
- sharing.md — SharingApi, SharingRepository
- billing.md — BillingApi, SubscriptionApi, BillingManager
- datastores.md — All DataStores
- real-time.md — WebSocketManager, RealTimeRepository
- subscriptions.md — SubscriptionApi, SubscriptionRepository
Features
- authentication.md — Token lifecycle, encryption, OAuth, 2FA
- real-time.md — WebSocket architecture, event flows
- navigation.md — Compose Navigation, routes, deep links
- widget.md — Home screen widget, sync, grid layout
- notifications.md — FCM, channels, push handling
- billing.md — Play Billing, subscriptions, licensing
- sharing.md — Permissions model, invite flow
- geofencing-commands.md — Geofences, device commands
- device-lifecycle.md — Claiming, configuration, suspension
UI
- ui-components.md — Theme system, component library
- maps/ — Dual map provider system (Google Maps + Mapbox)
- screen-catalog.md — Screen & route inventory
- user-flows.md — Key user flows with error handling
Cross-Cutting
- error-handling.md — Exception hierarchy, error propagation
- offline-caching.md — DataStore caching, refresh policies
Engineering
- testing/ — Testing strategy (unit, UI, mocking)
- build-and-ci.md — Gradle, Makefile, CI/CD, code quality