From 7212ff1e4482fdc5e624b8420893cae90528894c Mon Sep 17 00:00:00 2001 From: James Rich Date: Mon, 16 Mar 2026 10:02:02 -0500 Subject: [PATCH] conductor(checkpoint): Checkpoint end of Phase 2: Documentation Updates --- conductor/tracks/deep_dive_docs_20260316/plan.md | 8 ++++---- core/testing/README.md | 6 ++++++ docs/kmp-status.md | 2 +- docs/roadmap.md | 2 +- 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/conductor/tracks/deep_dive_docs_20260316/plan.md b/conductor/tracks/deep_dive_docs_20260316/plan.md index ff44b9c48..f5f58888a 100644 --- a/conductor/tracks/deep_dive_docs_20260316/plan.md +++ b/conductor/tracks/deep_dive_docs_20260316/plan.md @@ -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 diff --git a/core/testing/README.md b/core/testing/README.md index b55ab37c4..1307f107b 100644 --- a/core/testing/README.md +++ b/core/testing/README.md @@ -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: diff --git a/docs/kmp-status.md b/docs/kmp-status.md index 6d4de8911..de9a29af7 100644 --- a/docs/kmp-status.md +++ b/docs/kmp-status.md @@ -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/). diff --git a/docs/roadmap.md b/docs/roadmap.md index f635cae7e..96c28a0aa 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -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).