meshtastic/Meshtastic-Android
1
0
Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-04-20 22:23:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

conductor(checkpoint): Checkpoint end of Phase 2: Documentation Updates

Browse source
This commit is contained in:
James Rich 2026-03-16 10:02:02 -05:00
parent 105763bd8a
commit 7212ff1e44
4 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
conductor/tracks/deep_dive_docs_20260316/plan.md
View file

@ -1,16 +1,16 @@
# Implementation Plan: Deep Dive & Validation of Project Docs & Plans
## Phase 1: Audit & Discovery
## Phase 1: Audit & Discovery [checkpoint: 105763b]
- [x] Task: Audit Gradle dependencies (`libs.versions.toml`) against 2026 KMP best practices (Koin, Compose, Navigation 3, etc.). baed3d6
- [x] Task: Analyze Core Logic (`core:*`) and platform modules (Android, Desktop) for architectural alignment (MVI/Shared ViewModels). baed3d6
- [x] Task: Review current UI and feature module implementations for Compose Multiplatform standard adherence. baed3d6
- [x] Task: Evaluate testing patterns, coverage, and the use of shared test doubles (`core:testing`). baed3d6
- [x] Task: Compile a list of discrepancies between current documentation/plans and the actual codebase. baed3d6
- [ ] Task: Conductor - User Manual Verification 'Phase 1: Audit & Discovery' (Protocol in workflow.md)
- [x] Task: Conductor - User Manual Verification 'Phase 1: Audit & Discovery' (Protocol in workflow.md) 105763b
## Phase 2: Documentation Updates
- [ ] Task: Update `/docs` and root-level guides (e.g., `GEMINI.md`, `kmp-status.md`, `roadmap.md`) to reflect the current, verified codebase state.
- [ ] Task: Add explicit documentation for areas where the codebase diverges from documented best practices (flagging for future refactoring).
- [x] Task: Update `/docs` and root-level guides (e.g., `GEMINI.md`, `kmp-status.md`, `roadmap.md`) to reflect the current, verified codebase state. baed3d6
- [x] Task: Add explicit documentation for areas where the codebase diverges from documented best practices (flagging for future refactoring). baed3d6
- [ ] Task: Conductor - User Manual Verification 'Phase 2: Documentation Updates' (Protocol in workflow.md)
## Phase 3: Plan Adjustment

6
core/testing/README.md
View file

@ -43,6 +43,12 @@ The `:core:testing` module provides lightweight, reusable test doubles (fakes, b
(etc.) (etc.)
```
### Target Compatibility Warning (March 2026 Audit)
- **MockK in commonMain:** This module includes `api(libs.mockk)` in `commonMain`. While this works for the current `jvm()` and `android()` targets, **MockK does not natively support Kotlin/Native (iOS)**.
- **Future-Proofing:** If an iOS target is added, tests in `commonTest` that rely on MockK will fail to compile for iOS.
- **Recommendation:** Favor manual fakes (like `FakeNodeRepository`) in `commonMain` and limit `mockk` usage to `androidUnitTest` or `jvmTest` where possible to maintain pure KMP portability.
### Key Design Rules
1. **`:core:testing` has NO dependencies on heavy modules**: It only depends on:

2
docs/kmp-status.md
View file

@ -1,6 +1,6 @@
# KMP Migration Status
> Last updated: 2026-03-13
> Last updated: 2026-03-16
Single source of truth for Kotlin Multiplatform migration progress. For the forward-looking roadmap, see [`roadmap.md`](./roadmap.md). For completed decision records, see [`decisions/`](./decisions/).

2
docs/roadmap.md
View file

@ -1,6 +1,6 @@
# Roadmap
> Last updated: 2026-03-12
> Last updated: 2026-03-16
Forward-looking priorities for the Meshtastic KMP multi-target effort. For current state, see [`kmp-status.md`](./kmp-status.md). For the full gap analysis, see [`decisions/architecture-review-2026-03.md`](./decisions/architecture-review-2026-03.md).