Audit the user docs for accuracy against the code, enrich them with
component-level screenshots, and separate the doc-screenshot generation
path from the visual-regression gate so doc framing no longer churns test
baselines.
Veracity fixes (claims verified against code):
- connections: removed 3 screenshots that were from the unrelated mPWRD/nymea
WiFi-provisioning app and rewrote the TCP/IP section to match the real
Network transport flow (mDNS scan + manual IP:4403); replaced the BLE
"scan" image (it was the wifi-provision splash) with the real device list.
- nodes: online window is 2h (not 15min); binary online/offline, no "away" tier.
- map: markers are identity-colored node chips, not online-status colors.
- node-metrics & signal-meter: signal quality is preset-relative SNR, not
fixed thresholds.
- messages: max message length is 200 bytes (not 237/230).
- telemetry: CO2 bands aligned to Co2Severity (Good/Stuffy/Poor/Unsafe/Evacuate).
- translate: locale dirs use {lang}-r{REGION}.
New pages: Home Screen Widget, Help & In-App Docs (Chirpy on-device AI).
Screenshot enrichment + tighter framing: added IAQ scale, firmware verifying,
TAK local server, quick-chat dialog; cropped firmware states and connections
panes to component-level views instead of full-screen frames.
Pipeline split (new :docs-screenshots module, generate-only, not CI-gated):
holds doc-framed compositions so reframing a doc image never moves a regression
baseline; :screenshot-tests stays the gate. copyDocsScreenshots aggregates
both modules. Updated CI filter, governance advisories, dev docs, and the
testing-ci skill.
Translated docs re-sync from the English source via the scheduled Crowdin job.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2.1 KiB
title, layout, nav_order, has_children
| title | layout | nav_order | has_children |
|---|---|---|---|
| User Guide | default | 1 | true |
User Guide
Documentation for using the Meshtastic Android and Desktop app.
What's New in the Docs
June 2026 — Help & In-App Docs — New page covering the in-app documentation browser, search, and the on-device Chirpy AI assistant.
June 2026 — Home Screen Widget — New page covering the Android home screen widget that shows your connected radio's local stats at a glance.
June 2026 — Discovery — Added the Local Mesh Discovery scanner: a dedicated mode that cycles your radio through LoRa presets, dwells on each to collect packets, and ranks which preset works best at your location.
June 2026 — Node Metrics — Added Air Quality metrics (PM1.0, PM2.5, PM10, and CO₂ with severity color bands), a separate view from the BME680 IAQ reading.
June 2026 — Messages & Channels — Added full-text message search within a conversation, with a result counter and previous/next navigation.
June 2026 — Android Auto — New page covering Meshtastic in Android Auto.
June 2026 — App Functions — New page covering App Functions, which exposes app actions to the Android system AI on Google flavor builds.
May 2026 — Translate the App — New page explaining how to contribute translations to the Meshtastic app via Crowdin.
May 2026 — Units & Locale — New page explaining how the app automatically adapts temperatures, distances, speeds, and times to your device's regional settings.
May 2026 — Signal Meter — New page explaining how the LoRa signal quality meter works, why negative SNR values are normal, and how to interpret RSSI vs. SNR.