Skip to content

docs: explain the boot chain, SoftDevice, and the three update paths - #21

Merged
jamesarich merged 2 commits into
masterfrom
docs-how-it-works
Aug 19, 2026
Merged

docs: explain the boot chain, SoftDevice, and the three update paths#21
jamesarich merged 2 commits into
masterfrom
docs-how-it-works

Conversation

@jamesarich

@jamesarich jamesarich commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

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:

  • That this repo is only the bootloader — the Meshtastic application itself lives entirely in meshtastic/firmware and is built/flashed separately. Nothing said this plainly before.
  • How the boot chain actually works (MBR → this bootloader → application), referenced only in passing as "MBR/SoftDevice handoff" in AGENTS.md with no explanation.
  • What a SoftDevice even is — referenced constantly (SD_VERSION, S140 6.1.1) but never defined.
  • That UF2 drag-and-drop, serial DFU, and BLE OTA DFU are three different transports for the same job, not three unrelated features — the README documents how to use each individually but never says this.

Changes

  • New README.md section, 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

  • PR title specifically describes the change
  • tools/build_all.py (or CI's board matrix) passes — unaffected by a docs-only change, verified green anyway
  • Proofread rendered Markdown (table, anchors, section ordering) for correctness
  • [N/A] No code, board, or CI config touched

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>
@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jamesarich, you've reached your PR review limit, so we couldn't start this review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 76d85fd1-0b8a-455d-961c-d6217abe7505

📥 Commits

Reviewing files that changed from the base of the PR and between 18758d9 and 1d6417f.

📒 Files selected for processing (2)
  • AGENTS.md
  • README.md

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.

❤️ Share

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

@jamesarich
jamesarich merged commit f3289cd into master Aug 19, 2026
17 checks passed
@jamesarich
jamesarich deleted the docs-how-it-works branch August 19, 2026 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant