esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

[nRF52] Put the most common case first (Adafruit bootloader)

Open lboue opened this issue 1 month ago โ€ข 5 comments

Description:

This PR reorganizes the flashing instructions for nRF52 boards by reordering sections and improving documentation clarity.

  • Moved Adafruit nRF52 Bootloader section before MCUboot section
  • Enhanced board compatibility information for Adafruit bootloader method

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#<esphome PR number goes here>

Checklist:

  • [ ] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [x] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • [ ] Link added in /components/index.rst when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

lboue avatar Nov 01 '25 18:11 lboue

Deploy Preview for esphome ready!

Name Link
Latest commit c81a19cd7ec1e6a712733043dc95742386d17cbb
Latest deploy log https://app.netlify.com/projects/esphome/deploys/6906543daac58900085dcd35
Deploy Preview https://deploy-preview-5549--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Nov 01 '25 18:11 netlify[bot]

[!NOTE]

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Reorders and updates the nRF52 documentation: reintroduces MCUboot SWD flashing steps with example device config, moves that section after the Adafruit bootloader content, and expands the Adafruit bootloader flashing steps to cover additional boards, UF2 copy instructions, and USB CDC update notes.

Changes

Cohort / File(s) Summary
Documentation restructuring and content updates
content/components/nrf52.md
Moves the "Flashing with MCUboot" section after the "Adafruit nRF52 Bootloader" section; reintroduces SWD-based MCUboot flashing steps with example device configuration; expands Adafruit bootloader instructions to include additional boards (Adafruit, ProMicro nRF52840, Seeed XIAO BLE), explicit UF2 copy step, and USB CDC update note; minor wording and ordering adjustments.

Estimated code review effort

๐ŸŽฏ 2 (Simple) | โฑ๏ธ ~10 minutes

  • Review focus: verify step ordering, board list accuracy, and clarity of UF2/USB CDC steps.
  • Check example device configuration for correctness and consistency with surrounding docs.

Pre-merge checks and finishing touches

โŒ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage โš ๏ธ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
โœ… Passed checks (2 passed)
Check name Status Explanation
Title Check โœ… Passed The PR title "[nRF52] Put the most common case first (Adafruit bootloader)" directly and clearly describes the main objective of the changeset. The title identifies both the component affected (nRF52) and the primary change (reordering sections to prioritize the Adafruit bootloader method as the most common case). This aligns precisely with the file changes in nrf52.md, which moves the Adafruit nRF52 Bootloader section before the MCUboot section. The title is concise, specific, and would allow a teammate scanning the commit history to immediately understand the nature of this documentation reorganization.
Description Check โœ… Passed The PR description is meaningfully related to the changeset. It provides a clear summary stating that the PR reorganizes flashing instructions for nRF52 boards by reordering sections and improving documentation clarity, and it explicitly mentions the two key changes: moving the Adafruit nRF52 Bootloader section before MCUboot and enhancing board compatibility information. This description directly corresponds to the actual changes in nrf52.md. While the description includes standard template content about new component images, the relevant portion appropriately describes the documentation changes being made.
โœจ Finishing touches
๐Ÿงช Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

[!WARNING]

Review ran into problems

๐Ÿ”ฅ Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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 and usage tips.

coderabbitai[bot] avatar Nov 01 '25 18:11 coderabbitai[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit abca49badf8bf10a1b4bc1c819a3ea90ab046cd8
Latest deploy log https://app.netlify.com/projects/esphome/deploys/690654a9c9056a00085af2d2
Deploy Preview https://deploy-preview-5549--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Nov 01 '25 18:11 netlify[bot]

Deploy Preview for esphome ready!

Name Link
Latest commit b9e4d865eddf41a2d81ff89c14fb35dfb8cc9103
Latest deploy log https://app.netlify.com/projects/esphome/deploys/6906554bbb66cb00070c9735
Deploy Preview https://deploy-preview-5549--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Nov 01 '25 18:11 netlify[bot]

Are we OK for this?

lboue avatar Nov 13 '25 20:11 lboue