feat(docs): In-app documentation browser with Jekyll site and Docusaurus sync (#5445)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-05-30 09:37:13 -04:00 · 2026-05-18 23:00:22 -05:00
parent f5128798a8
commit fc0df1a79a
201 changed files with 12471 additions and 136 deletions
--- a/docs/developer/codebase.md
+++ b/docs/developer/codebase.md
@@ -0,0 +1,137 @@
+---
+title: Codebase
+nav_order: 2
+last_updated: 2026-05-13
+aliases:
+  - repository-layout
+  - project-structure
+  - source-code
+---
+
+# Codebase
+
+Repository layout, namespacing conventions, and build system overview.
+
+## Repository Structure
+
+```
+Meshtastic-Android/
+├── app/                    # Android application module
+│   ├── src/main/           # Shared Android code
+│   ├── src/google/         # Google Play flavor (Gemini, proprietary)
+│   └── src/fdroid/         # F-Droid flavor (FOSS-only)
+├── desktop/                # Desktop JVM application
+├── feature/                # Feature modules (KMP)
+│   ├── intro/
+│   ├── messaging/
+│   ├── connections/
+│   ├── map/
+│   ├── node/
+│   ├── settings/
+│   ├── firmware/
+│   ├── docs/
+│   ├── wifi-provision/
+│   └── widget/
+├── core/                   # Core infrastructure modules (KMP)
+│   ├── common/
+│   ├── navigation/
+│   ├── ui/
+│   ├── resources/
+│   ├── model/
+│   ├── data/
+│   ├── database/
+│   ├── datastore/
+│   ├── prefs/
+│   ├── repository/
+│   ├── service/
+│   ├── di/
+│   ├── network/
+│   ├── ble/
+│   ├── proto/
+│   └── testing/
+├── build-logic/            # Convention plugins and build helpers
+│   └── convention/
+├── docs/                   # Documentation source (markdown)
+│   ├── user/
+│   └── developer/
+├── gradle/                 # Gradle wrapper and version catalog
+│   └── libs.versions.toml
+├── specs/                  # Feature specifications
+└── .github/workflows/      # CI/CD workflows
+```
+
+## Namespacing Convention
+
+All Kotlin packages follow the pattern:
+```
+org.meshtastic.{layer}.{module}.{subpackage}
+```
+
+Examples:
+- `org.meshtastic.core.navigation` — core navigation module
+- `org.meshtastic.feature.docs.ui` — docs feature UI package
+- `org.meshtastic.app.di` — app DI configuration
+
+## Build System
+
+### Gradle Kotlin DSL
+
+All build files use Kotlin DSL (`.gradle.kts`). Configuration:
+
+- **Version catalog:** `gradle/libs.versions.toml`
+- **Convention plugins:** `build-logic/convention/`
+- **Settings:** `settings.gradle.kts`
+
+### Convention Plugins
+
+Located in `build-logic/convention/src/main/kotlin/org/meshtastic/buildlogic/`:
+
+| Plugin | Purpose |
+|--------|---------|
+| `meshtastic.kmp.feature` | Standard feature module setup |
+| `meshtastic.kmp.jvm.android` | JVM + Android target configuration |
+| `meshtastic.kotlinx.serialization` | Serialization plugin setup |
+
+### Build Variants (Android)
+
+| Flavor | Description |
+|--------|-------------|
+| `google` | Google Play distribution; includes proprietary APIs |
+| `fdroid` | F-Droid distribution; FOSS-only dependencies |
+
+### Key Gradle Tasks
+
+```bash
+# Compile check across all KMP targets
+./gradlew kmpSmokeCompile
+
+# Run all tests
+./gradlew allTests
+
+# Code quality
+./gradlew spotlessCheck detekt
+
+# Android build
+./gradlew assembleGoogleDebug assembleFdroidDebug
+
+# Desktop run
+./gradlew :desktop:run
+```
+
+## Version Catalog Highlights
+
+Key dependencies in `gradle/libs.versions.toml`:
+
+| Category | Library |
+|----------|---------|
+| Compose | Compose Multiplatform (JetBrains) |
+| Navigation | Navigation 3 |
+| DI | Koin (annotations) |
+| Serialization | kotlinx.serialization |
+| Database | Room KMP |
+| Networking | Ktor |
+| Markdown | multiplatform-markdown-renderer |
+| Testing | kotlin-test, compose-ui-test |
+
+---
+