docs: explain the boot chain, SoftDevice, and the three update paths - #21
Conversation
The docs covered usage (how to flash, troubleshoot, board list) and file-by-file architecture well, but never explained the underlying concepts a newcomer needs first: that this repo is only the bootloader (not the Meshtastic application, which lives entirely in meshtastic/firmware), how the MBR hands off to it on boot, what a SoftDevice is, and that UF2/serial DFU/BLE OTA DFU are three distinct paths for the same job rather than three unrelated features. Added a "How this fits together" section to README.md covering all of that, and pointed AGENTS.md's "First read" at it so the Architecture section's assumptions (MBR/SoftDevice handoff, DFU state machine) have somewhere to land for a reader seeing this repo for the first time. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 56 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Reviewing the docs after PR #14's overhaul: they cover usage well (how to flash, troubleshoot, board list) and give a decent file-by-file architecture breakdown in
AGENTS.md, but never explain the underlying concepts someone new to this repo actually needs first:meshtastic/firmwareand is built/flashed separately. Nothing said this plainly before.AGENTS.mdwith no explanation.SD_VERSION,S140 6.1.1) but never defined.Changes
README.mdsection, How this fits together, right after the intro (before "Boards supported"): the boot chain, the "this repo ≠ the application" split, a table of the three update paths with pointers to where each is already documented in detail, and a short SoftDevice explainer.AGENTS.md's "First read" now points at that section first, since the Architecture section's terminology (MBR/SoftDevice handoff, DFU state machine) assumes it.No functional changes — docs only.
Test plan
tools/build_all.py(or CI's board matrix) passes — unaffected by a docs-only change, verified green anyway