From baed3d61cb73efc8f42ff8b81c7db2ef9a6d7e81 Mon Sep 17 00:00:00 2001 From: James Rich Date: Mon, 16 Mar 2026 09:49:39 -0500 Subject: [PATCH] chore(conductor): Add new track 'deep_dive_docs_20260316' --- conductor/tracks.md | 6 +++++- .../tracks/deep_dive_docs_20260316/index.md | 5 +++++ .../deep_dive_docs_20260316/metadata.json | 8 ++++++++ .../tracks/deep_dive_docs_20260316/plan.md | 19 +++++++++++++++++++ .../tracks/deep_dive_docs_20260316/spec.md | 19 +++++++++++++++++++ 5 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 conductor/tracks/deep_dive_docs_20260316/index.md create mode 100644 conductor/tracks/deep_dive_docs_20260316/metadata.json create mode 100644 conductor/tracks/deep_dive_docs_20260316/plan.md create mode 100644 conductor/tracks/deep_dive_docs_20260316/spec.md diff --git a/conductor/tracks.md b/conductor/tracks.md index b0b15a077..f47058242 100644 --- a/conductor/tracks.md +++ b/conductor/tracks.md @@ -1,3 +1,7 @@ # Project Tracks -This file tracks all major tracks for the project. Each track has its own detailed plan in its respective folder. \ No newline at end of file +This file tracks all major tracks for the project. Each track has its own detailed plan in its respective folder. +--- + +- [ ] **Track: do a deep dive of project docs and plans in /docs - verify against actual project/codebase state, then validate against modern best practices for android, kotlin, kmp, and the dependencies used. be thorough - check all the major dependencies. Update docs and plans accordingly.** +*Link: [./tracks/deep_dive_docs_20260316/](./tracks/deep_dive_docs_20260316/)* diff --git a/conductor/tracks/deep_dive_docs_20260316/index.md b/conductor/tracks/deep_dive_docs_20260316/index.md new file mode 100644 index 000000000..aea19983d --- /dev/null +++ b/conductor/tracks/deep_dive_docs_20260316/index.md @@ -0,0 +1,5 @@ +# Track deep_dive_docs_20260316 Context + +- [Specification](./spec.md) +- [Implementation Plan](./plan.md) +- [Metadata](./metadata.json) \ No newline at end of file diff --git a/conductor/tracks/deep_dive_docs_20260316/metadata.json b/conductor/tracks/deep_dive_docs_20260316/metadata.json new file mode 100644 index 000000000..919480970 --- /dev/null +++ b/conductor/tracks/deep_dive_docs_20260316/metadata.json @@ -0,0 +1,8 @@ +{ + "track_id": "deep_dive_docs_20260316", + "type": "chore", + "status": "new", + "created_at": "2026-03-16T12:00:00Z", + "updated_at": "2026-03-16T12:00:00Z", + "description": "do a deep dive of project docs and plans in /docs - verify against actual project/codebase state, then validate against modern best practices for android, kotlin, kmp, and the dependencies used. be thorough - check all the major dependencies. Update docs and plans accordingly." +} \ No newline at end of file diff --git a/conductor/tracks/deep_dive_docs_20260316/plan.md b/conductor/tracks/deep_dive_docs_20260316/plan.md new file mode 100644 index 000000000..a251e9088 --- /dev/null +++ b/conductor/tracks/deep_dive_docs_20260316/plan.md @@ -0,0 +1,19 @@ +# Implementation Plan: Deep Dive & Validation of Project Docs & Plans + +## Phase 1: Audit & Discovery +- [ ] Task: Audit Gradle dependencies (`libs.versions.toml`) against 2026 KMP best practices (Koin, Compose, Navigation 3, etc.). +- [ ] Task: Analyze Core Logic (`core:*`) and platform modules (Android, Desktop) for architectural alignment (MVI/Shared ViewModels). +- [ ] Task: Review current UI and feature module implementations for Compose Multiplatform standard adherence. +- [ ] Task: Evaluate testing patterns, coverage, and the use of shared test doubles (`core:testing`). +- [ ] Task: Compile a list of discrepancies between current documentation/plans and the actual codebase. +- [ ] Task: Conductor - User Manual Verification 'Phase 1: Audit & Discovery' (Protocol in workflow.md) + +## 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). +- [ ] Task: Conductor - User Manual Verification 'Phase 2: Documentation Updates' (Protocol in workflow.md) + +## Phase 3: Plan Adjustment +- [ ] Task: Create new, actionable tasks in the project's main `plan.md` to address the flagged discrepancies (e.g., refactoring non-compliant Koin modules, updating deprecated APIs). +- [ ] Task: Review and finalize the overall project roadmap and status based on the audit findings. +- [ ] Task: Conductor - User Manual Verification 'Phase 3: Plan Adjustment' (Protocol in workflow.md) \ No newline at end of file diff --git a/conductor/tracks/deep_dive_docs_20260316/spec.md b/conductor/tracks/deep_dive_docs_20260316/spec.md new file mode 100644 index 000000000..baa50bda7 --- /dev/null +++ b/conductor/tracks/deep_dive_docs_20260316/spec.md @@ -0,0 +1,19 @@ +# Specification: Deep Dive & Validation of Project Docs & Plans + +## Overview +This track involves a comprehensive review and deep dive into the project's documentation (`/docs`, `GEMINI.md`, etc.) and plans. The goal is to verify the documented state against the actual Kotlin Multiplatform (KMP) codebase and validate it against modern 2026 KMP and Android best practices. The outcome will be updated documentation reflecting the current state and flagged/planned changes for areas not following best practices. + +## Functional Requirements +- **Codebase Verification:** Analyze all major areas including Core Logic (`core:*`), UI & Features (Compose Multiplatform), Dependencies (Gradle version catalogs), and Platform-specific implementations (Android, Desktop). +- **Best Practice Validation:** Evaluate the codebase against modern standards, specifically focusing on Architecture (MVI/Shared ViewModels), Navigation (Navigation 3), Dependency Injection (Koin Annotations K2), and Testing patterns. +- **Documentation Update:** Modify existing documentation and plans to accurately reflect the current state of the codebase and dependencies. +- **Refactoring Proposals:** Identify and flag code or architectural decisions that deviate from best practices, outlining necessary refactoring steps in the project's plans. + +## Acceptance Criteria +- All documentation in `/docs` and root-level guides accurately reflect the current codebase. +- A comprehensive audit of major dependencies has been performed and validated against 2026 KMP standards. +- Discrepancies between the codebase and best practices are clearly flagged and actionable tasks are added to the project plans. +- The `plan.md` reflects the updated status and any new tasks generated from the audit. + +## Out of Scope +- Direct refactoring or modification of the actual Kotlin/Android codebase during this specific track (this track focuses on documentation, planning, and flagging). \ No newline at end of file