Skip to content

Commit 9a31da7

Browse files
jamesarichCopilot
andcommitted
docs: content audit — expand modules, add cross-refs, fix TODOs, polish tone
- Rewrote discovery.md from stub to practical guide covering existing tools (traceroute, neighbor info, node list filtering) — no unimplemented features documented - Expanded all 1-liner module entries in settings-module-admin.md with descriptions, use cases, settings tables, and tips/warnings - Replaced 5 TODO screenshot placeholders with descriptive text - Added description field to all user doc frontmatter for SEO/search - Added Related Topics cross-reference sections to 10 user docs - Added Troubleshooting sections to MQTT and telemetry docs - Added tip/note/warning callouts matching Apple docs quality bar - Updated last_updated dates across all 26 doc pages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 600f197 commit 9a31da7

23 files changed

Lines changed: 295 additions & 106 deletions

docs/developer/adding-a-feature-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Adding a Feature Module
33
nav_order: 3
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- new-module
77
- feature-module

docs/developer/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Architecture
33
nav_order: 1
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- layers
77
- module-architecture

docs/developer/codebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Codebase
33
nav_order: 2
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- repository-layout
77
- project-structure

docs/developer/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Contributing
33
nav_order: 8
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- contributing
77
- pull-request

docs/developer/navigation-and-deep-links.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Navigation & Deep Links
33
nav_order: 4
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- deeplinks
77
- navigation-3

docs/developer/persistence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Persistence
33
nav_order: 6
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- room
77
- database

docs/developer/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Testing
33
nav_order: 7
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- tests
77
- unit-tests

docs/developer/transport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Transport
33
nav_order: 5
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
55
aliases:
66
- ble
77
- serial

docs/user/connections.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Connections
33
nav_order: 2
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
5+
description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP.
56
aliases:
67
- bluetooth
78
- usb
@@ -99,5 +100,13 @@ On Desktop (Linux/macOS/Windows), the app supports:
99100
- **TCP/IP** — for network-connected radios
100101
- Bluetooth is **not** currently supported on Desktop
101102

103+
See [Desktop App](desktop) for platform-specific details and keyboard shortcuts.
104+
105+
## Related Topics
106+
107+
- [Getting Started](onboarding) — first-launch setup and permissions
108+
- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration
109+
- [Desktop App](desktop) — desktop-specific connection details
110+
102111
---
103112

docs/user/desktop.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Desktop App
33
nav_order: 14
4-
last_updated: 2026-05-12
4+
last_updated: 2026-05-13
5+
description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts.
56
aliases:
67
- desktop
78
- linux
@@ -96,9 +97,7 @@ The Desktop app uses the same Compose Multiplatform UI with adaptations for larg
9697

9798
### Notification Preferences
9899

99-
The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts:
100-
101-
<!-- TODO: Add screenshot settings_notifications.png -->
100+
The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app.
102101

103102
## Building from Source
104103

0 commit comments

Comments
 (0)