docs: second-pass audit of docs/en — fix drift and document new features#6157
Merged
Conversation
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>
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (24)
📝 WalkthroughWalkthroughThis 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. ChangesJuly 2026 documentation refresh
Estimated code review effort: 2 (Simple) | ~12 minutes ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
jamesarich
enabled auto-merge
July 8, 2026 13:31
jamesarich
disabled auto-merge
July 8, 2026 13:32
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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, andcodebase.mdhad reverted to their pre-review wording onmaineven 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 againstChannelOption.kt.debug-logs.md— privacy note claimed channel keys are redacted from log exports; they aren't (onlyprivate_key/admin_key/session_passkeyare — verified againstLogFormatter.kt). Softened the claim so it doesn't overpromise.adding-a-feature-module.md— the copy-pastebuild.gradle.ktsexample usedandroidLibrary { withHostTest {} }, a DSL block that exists nowhere in the repo; every real feature module usesandroid { withHostTest { isIncludeAndroidResources = true } }.codebase.md— convention-plugin classes live inbuild-logic/convention/src/main/kotlin/(default package), not the documented subpackage; the tree also showed abuild-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, perCapabilities.supportsTakV2); said V1 doesn't support chat (it does — GeoChat, perTAKMeshIntegration.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 againstMessage.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; tracedDefaultFirmwareUpdateManager's dispatch logic and it's fully cross-platform with no desktop gating anywhere in the stack.🌟 Newly documented (shipped, previously undocumented)
nodes.mdmap-and-waypoints.mdmap-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 theDateFormatterreference; 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/discoveryrow 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