Skip to content

docs: second-pass audit of docs/en — fix drift and document new features#6157

Merged
jamesarich merged 1 commit into
mainfrom
claude/admiring-goldberg-43a18b
Jul 8, 2026
Merged

docs: second-pass audit of docs/en — fix drift and document new features#6157
jamesarich merged 1 commit into
mainfrom
claude/admiring-goldberg-43a18b

Conversation

@jamesarich

@jamesarich jamesarich commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Why

Follow-up to #6150 (the first docs/en audit). Two things prompted a second pass: several features shipped without doc updates in the days around that PR, and — caught while re-verifying — the squash-merge on GitHub silently dropped that PR's CodeRabbit-review follow-up commit. signal-meter.md, node-metrics.md, units-and-locale.md, and codebase.md had reverted to their pre-review wording on main even though the review threads show resolved. All four are reapplied here, plus a fresh audit of everything else.

Every claim below was verified against the current source (grep/read, not assumed) before editing — three independent fresh audit passes ran in parallel, then each finding was cross-checked against the actual code, strings, and Compose UI before I touched a file.

🐛 Corrections — factual errors

  • settings-radio-user.md — Modem Preset SNR Limit table was wrong on 9 of 14 presets, including the default (Long Fast: doc said −12.5 dB, code says −17.5 dB). Verified against ChannelOption.kt.
  • debug-logs.md — privacy note claimed channel keys are redacted from log exports; they aren't (only private_key/admin_key/session_passkey are — verified against LogFormatter.kt). Softened the claim so it doesn't overpromise.
  • adding-a-feature-module.md — the copy-paste build.gradle.kts example used androidLibrary { withHostTest {} }, a DSL block that exists nowhere in the repo; every real feature module uses android { withHostTest { isIncludeAndroidResources = true } }.
  • codebase.md — convention-plugin classes live in build-logic/convention/src/main/kotlin/ (default package), not the documented subpackage; the tree also showed a build-logic/flatpak/ directory deleted back in feat: adopt gradle-flatpak-sources plugin for offline Flatpak builds #5619.
  • tak.md — wire-format table said V2 needs firmware "2.3+" (actually 2.8.0, per Capabilities.supportsTakV2); said V1 doesn't support chat (it does — GeoChat, per TAKMeshIntegration.kt); documented a "Callsign" module setting that doesn't exist in the UI (it's auto-derived from the node name).
  • onboarding.md — notification-permission blurb described "connection status" and "firmware update" notification categories that don't exist; the real three are messages/new nodes/low battery (NotificationsScreen.kt).
  • messages-and-channels.md — Message States table rewritten: queued and en-route render identical "Sending…" text, "Delivered" means something different for a direct message vs. a channel broadcast, and the status label only appears on your own outgoing messages, never on incoming ones (verified against Message.kt/MessageItem.kt).
  • settings-module-admin.md — five module-config tables had drifted from the current Compose UI (Store & Forward, Remote Hardware, Neighbor Info, Ambient Lighting, Detection Sensor) — missing fields, and one boolean documented as if it were a numeric interval.
  • desktop.md — my own claim from the first audit round that BLE/Wi-Fi OTA firmware update is Android-only was itself wrong; traced DefaultFirmwareUpdateManager's dispatch logic and it's fully cross-platform with no desktop gating anywhere in the stack.

🌟 Newly documented (shipped, previously undocumented)

  • "Nodes per Hop" histogram on the node list app bar → nodes.md
  • Map Layers (import your own GeoJSON/KML/KMZ overlays) + Site Planner (RF coverage estimation), now on F-Droid as well as Google Play (feat(map): F-Droid map-layer parity — share layer UI + logic in common source (#6138) #6148) → map-and-waypoints.md
  • Waypoint geofences — enter/exit alerts, creator-only by default with a per-geofence opt-in for others → map-and-waypoints.md
  • @mentions (tap to jump to a node) and on-device message translation (Google Play only) → messages-and-channels.md

🧹 Smaller corrections

Waypoint name limit is 29 characters not 30; added the missing formatDateTimeShort() to the DateFormatter reference; added 4 Room entities from Discovery/device-links that were missing from the persistence table; fixed a stale numeric spec-prefix example (specs now use timestamp-based names); added a /discovery row to the deep-link table; fixed a couple of button-label mismatches; refreshed both "What's New" lists (kept at the 8-entry cap).

For reviewers

Given the squash-merge issue on #6150, it's worth merging this one with a regular merge commit, or double-checking the squash captures the final pushed state rather than the branch's first commit.

Testing

Content-only Markdown edits, scoped entirely to docs/en/. No frontmatter schema or link-structure changes beyond what's described above.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features
    • Added documentation for map layers, Site Planner overlays, geofences, hop histogram charts, and improved message status details.
    • Expanded guidance for discovery, TAK integration, firmware updates, and desktop firmware parity.
  • Bug Fixes
    • Clarified signal-quality thresholds, modem preset limits, and deep link/navigation references for more accurate in-app guidance.
  • Documentation
    • Updated several user and developer guides, including onboarding, persistence, transport, and contribution instructions.

Follow-up to #6150. Re-audits docs/en against current code, catches a
squash-merge that silently dropped that PR's CodeRabbit-review commit
(signal-meter.md, node-metrics.md, units-and-locale.md, codebase.md
had reverted to pre-review wording on main), and documents features
that shipped without doc updates (hop histogram, F-Droid map-layer
parity, waypoint geofences, @mentions, message translation).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: f744af13-91c4-4bde-b457-3fae8b68f0cb

📥 Commits

Reviewing files that changed from the base of the PR and between ffc1828 and cabe48b.

📒 Files selected for processing (24)
  • docs/en/developer.md
  • docs/en/developer/adding-a-feature-module.md
  • docs/en/developer/codebase.md
  • docs/en/developer/contributing.md
  • docs/en/developer/measurement.md
  • docs/en/developer/navigation-and-deep-links.md
  • docs/en/developer/persistence.md
  • docs/en/developer/transport.md
  • docs/en/user.md
  • docs/en/user/connections.md
  • docs/en/user/debug-logs.md
  • docs/en/user/desktop.md
  • docs/en/user/discovery.md
  • docs/en/user/firmware.md
  • docs/en/user/map-and-waypoints.md
  • docs/en/user/messages-and-channels.md
  • docs/en/user/node-metrics.md
  • docs/en/user/nodes.md
  • docs/en/user/onboarding.md
  • docs/en/user/settings-module-admin.md
  • docs/en/user/settings-radio-user.md
  • docs/en/user/signal-meter.md
  • docs/en/user/tak.md
  • docs/en/user/units-and-locale.md

📝 Walkthrough

Walkthrough

This PR updates documentation only, refreshing developer and user docs for July 2026: new map layers/site planner and mesh discovery persistence entries, geofence and hop-histogram guidance, revised SNR/signal-quality thresholds, TAK wire-format rewrite, module settings updates, and various metadata date bumps.

Changes

July 2026 documentation refresh

Layer / File(s) Summary
What's New summaries
docs/en/developer.md, docs/en/user.md
Added July 2026 entries (map layers/site planner extraction, mesh discovery persistence, geofences, hop histogram) and removed older May/June entries.
Map layers, geofences, site planner, discovery persistence
docs/en/user/map-and-waypoints.md, docs/en/developer/persistence.md, docs/en/developer/navigation-and-deep-links.md, docs/en/developer/transport.md, docs/en/user/nodes.md
Documented Map Layers, Site Planner, geofence configuration, new Room discovery/device-link entities, a new /discovery deep link, hop-histogram usage, and clarified iOS transport status.
Signal quality and SNR thresholds
docs/en/user/node-metrics.md, docs/en/user/signal-meter.md, docs/en/user/discovery.md, docs/en/user/settings-radio-user.md
Revised Fair/Bad SNR boundary wording and updated modem preset SNR limit values across signal-quality references.
Module settings and admin docs
docs/en/user/settings-module-admin.md
Updated Store & Forward, Remote Hardware, Neighbor Info, Ambient Lighting, Detection Sensor tables, and Debug Panel guidance.
Messaging, connections, and TAK docs
docs/en/user/messages-and-channels.md, docs/en/user/connections.md, docs/en/user/debug-logs.md, docs/en/user/tak.md
Rewrote message delivery-state table, adjusted connection option wording, revised export privacy notice, and reworked TAK V1/V2 wire-format and troubleshooting guidance.
Onboarding, firmware, desktop, units docs
docs/en/user/onboarding.md, docs/en/user/firmware.md, docs/en/user/desktop.md, docs/en/user/units-and-locale.md
Updated notification examples, simplified firmware update-check steps, aligned desktop firmware OTA parity with Android, and changed unit example to m/s.
Developer process and codebase docs
docs/en/developer/contributing.md, docs/en/developer/codebase.md, docs/en/developer/adding-a-feature-module.md, docs/en/developer/measurement.md
Updated branch-naming spec prefix guidance, repository structure/convention-plugin paths, feature-module Gradle example, and added a DateFormatter table row.

Estimated code review effort: 2 (Simple) | ~12 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/admiring-goldberg-43a18b

Comment @coderabbitai help to get the list of available commands.

@jamesarich
jamesarich enabled auto-merge July 8, 2026 13:31
@jamesarich
jamesarich disabled auto-merge July 8, 2026 13:32
@jamesarich
jamesarich merged commit 03ceba2 into main Jul 8, 2026
5 of 6 checks passed
@jamesarich
jamesarich deleted the claude/admiring-goldberg-43a18b branch July 8, 2026 13:32
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant