Skip to content

ai: Establish conductor documentation and governance framework#4780

Merged
jamesarich merged 13 commits intomainfrom
ai/conductor
Mar 13, 2026
Merged

ai: Establish conductor documentation and governance framework#4780
jamesarich merged 13 commits intomainfrom
ai/conductor

Conversation

@jamesarich
Copy link
Copy Markdown
Collaborator

This pull request significantly overhauls the documentation for the Meshtastic-Android project, focusing on improving clarity, structure, and comprehensiveness for both AI agents and developers. The new documentation provides a detailed architectural overview, stricter development and execution protocols, an updated codebase map, and improved troubleshooting guidance. It also enforces continuous documentation sync with code changes and clarifies strict rules for platform purity and testing.

Key documentation and guidance improvements:

1. Architectural and Codebase Clarity

  • Expanded and reorganized project vision and architecture sections, providing explicit details on language choices, module boundaries, build system, and platform targets. [1] [2]
  • Introduced a comprehensive codebase map, detailing the purpose and contents of each major directory and module.

2. Development and Execution Protocols

  • Defined strict build, test, and execution commands, including environment setup and troubleshooting steps, to ensure consistent developer and CI workflows.
  • Added explicit instructions for secrets management and JDK version requirements.

3. Coding Standards and Best Practices

  • Outlined detailed UI, logic, and data layer guidelines, including platform purity rules, dependency management, and testing strategies for multiplatform code. [1] [2]
  • Specified namespacing conventions and legacy application ID maintenance.

4. Documentation and Agent Guidance

  • Mandated continuous documentation updates in sync with code changes, listing all relevant files to update when architecture or workflow changes occur.
  • Clarified the role of AGENTS.md as the primary source of truth, with mirrored guidance in .github/copilot-instructions.md.

5. Troubleshooting and Support

  • Centralized troubleshooting advice for common build, dependency, and configuration issues.

These changes collectively make the documentation more actionable, maintainable, and accessible for both human and AI contributors, reducing onboarding friction and improving project consistency.

This commit introduces a comprehensive "conductor" directory to manage project workflow, technical standards, and historical archives. This structure centralizes project state and decision-making processes to align with 2026 Kotlin Multiplatform (KMP) best practices.

Key changes include:
- **Core Governance**: Added `workflow.md`, `tech-stack.md`, and `product.md` to define development protocols, the KMP-focused stack (Koin 4.2, Navigation 3, Compose Multiplatform), and product vision.
- **Documentation Consolidation**: Introduced `doc-consolidation-plan.md` to prune redundant session artifacts and synthesize status reports into a single historical record.
- **Track Management**: Created an archive of major project tracks (Hardware Transport Extraction, Desktop Parity, Doc Consolidation) including specifications, implementation plans, and metadata.
- **Style & Quality**: Added general code style principles and defined a "Definition of Done" that mandates TDD and >80% code coverage.
- **Administrative**: Established an `index.md` as a entry point for project context and a `tracks.md` registry for ongoing initiatives.

Signed-off-by: James Rich <[email protected]>
…s for quality and veracity against the current codebase and recent changes - use tooling as needed. Evaluate updating project documentation for clarity and context. Synthesize and condense documentation and plans as needed. Be sure to thoroughly investigate the current state of the codebase and it's migration to kmp.' as complete
…docs for quality and veracity against the current codebase and recent changes - use tooling as needed. Evaluate updating project documentation for clarity and context. Synthesize and condense documentation and plans as needed. Be sure to thoroughly investigate the current state of the codebase and it's migration to kmp.'
@jamesarich jamesarich enabled auto-merge March 13, 2026 16:38
@jamesarich jamesarich added this pull request to the merge queue Mar 13, 2026
Merged via the queue into main with commit da11703 Mar 13, 2026
6 checks passed
@jamesarich jamesarich deleted the ai/conductor branch March 13, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant