docs: sync developer docs, skills and constitution with the code (#7427)

This commit is contained in:
James Rich authored and GitHub committed 2026-09-29 10:50:44 +00:00
1 parent 1b128ffc78
commit df33cad51c
13 files changed
+84 -37

No files matched your search

+6 -5
View File
@@ -2,7 +2,7 @@
title: Codebase
parent: Developer Guide
nav_order: 2
last_updated: 2026-09-26
last_updated: 2026-09-28
description: Repository layout, package namespacing, and the Gradle build system — convention plugins, build variants, and key tasks.
aliases:
- repository-layout
@@ -29,6 +29,7 @@ Meshtastic-Android/
│ ├── connections/
│ ├── map/
│ ├── map-maplibre/
│ ├── map-terrain/
│ ├── node/
│ ├── settings/
│ ├── firmware/
@@ -104,7 +105,7 @@ Located in `build-logic/convention/src/main/kotlin/`. The full set is registered
| `meshtastic.kmp.feature` | Standard feature module setup |
| `meshtastic.kmp.library` | Shared KMP library module |
| `meshtastic.kmp.library.compose` | KMP library that also ships Compose UI |
| `meshtastic.kmp.jvm.android` | JVM + Android target configuration |
| `meshtastic.kmp.jvm.android` | Adds the `jvmAndroidMain` source set shared by the Android and desktop JVM targets |
| `meshtastic.koin` | Koin Annotations + K2 compiler plugin |
| `meshtastic.kotlinx.serialization` | Serialization plugin setup |
| `meshtastic.android.room` | Room KMP setup and schema location |
@@ -124,11 +125,11 @@ block rather than assuming a plugin does or does not exist.
### Key Gradle Tasks
```shell
# Compile check across all KMP targets
# Compile check of every KMP module for JVM and iosSimulatorArm64 (excludes :desktopApp)
./gradlew kmpSmokeCompile
# Run all tests
./gradlew allTests
# Run all tests: allTests covers KMP modules, test covers Android/JVM-only modules; run both
./gradlew test allTests
# Code quality
./gradlew spotlessCheck detekt