Repository navigation
docs: trim the README to current behavior - #98
Conversation
Drop release-by-release comparisons and repeated history; state current behavior with minimum versions once.
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Installation and UF2 entry README.md |
The introduction, board guidance, and installation instructions describe release assets, recovery, and the paths into UF2 or BLE OTA mode. |
UF2 operations and updates README.md |
The README documents UF2 file handling, update acceptance and size limits, application backup, factory erase, display behavior, and the Android upgrade workflow. |
Troubleshooting and board notes README.md |
The README revises fault and transfer troubleshooting, OTA settings, and guidance for XIAO, RAK4631, and single-button boards. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested reviewers: oltaco
Merge Risk: 
327ec
-
This documentation-only change has no established merge-blocking risk.
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: shortening the README to document current behavior. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
A rabbit reads the UF2 guide,
Then checks which board can take the ride.
Through cables, screens, and files anew,
The bootloader’s notes are clearer too.
I thump my paws and hop away!
Comment @coderabbitai help to get the list of available commands.
Checklist
tools/build_all.py(or CI's board matrix) passes - docs-only change, no source touchedDescription of Change
A maintainer review of the sibling docs-site PR said "a lot of these changes are way too verbose. We need to be concise or we lose the reader. We also need to get away from documenting old behavior." This applies the same to the README.
Removes comparisons to older releases and repeated "formerly OTAFIX" text, keeping one line near the top. Minimum versions are stated only where a user needs one ("2.6.0 and later"). Boards, BLE names, install steps, UF2 drive, factory erase, DFU screens, troubleshooting, single-button notes and OTA settings are kept. The
#how-this-fits-together,#boards-supported,#ble-advertising-namesand#recommended-ota-dfu-settingsanchors are unchanged; the Contents list is dropped.README goes from 409 lines / 4877 words to 308 / 3361.
Summary by CodeRabbit