Skip to content

docs: make two-button boot mode impossible to misread - #1184

Merged
Bunton33 merged 1 commit into
devfrom
docs/clearer-boot-mode
Oct 23, 2026
Merged

Bunton33 merged 1 commit into
devfrom
docs/clearer-boot-mode

Conversation

@Bunton33

Copy link
Copy Markdown
Contributor

Why: a Starter Kit owner wrote in that he watched the boot-mode clip, saw "one finger holding down the board and the second one pushing the reset button," and pressed reset alone. He suggested starting the clip sooner and making it clear that boot is held while reset is pressed.

Text (25 pages, Home Assistant and Homey):

  • Every two-button boot-mode step now gives the order as three bullets: press and hold boot; while still holding it, press and release reset; let go of boot.
  • A "Keep holding boot the whole time" warning says that reset alone only restarts the device.
  • Both come before the photo or clip.
  • Method intros lead with holding boot instead of "use both buttons together."

Clips (Starter Kit, BTN-1, CAST-1, H-2, PUMP-1):

  • A caption bar under each clip changes with the action: 1 Press and hold BOOT, 2 Keep holding BOOT. Tap RESET., 3 Let go of BOOT, and Boot mode is on where the clip shows the fingers leaving.
  • Each step starts with a short pause, so the caption is readable before the fingers move. This covers the "start it sooner" suggestion.
  • Alt text now describes the captions.
  • The three largest clips are smaller: 5.2 → 2.5 MB, 4.7 → 1.7 MB, 2.7 → 1.7 MB.

Also fixed:

  • R PRO-1 Method 2 never said to plug the board back in after step 1 unplugged it.
  • BTN-1 boot-mode step numbers were 1, 2, 4 and 1, 2, 2, 3.
  • Style guide: added the pattern for two-button boot mode.

Review: writer agents made the text changes, and adversarial checkers verified each product group. They checked that button positions match each device (the MSR-1 is the reverse of the MSR-2 and MTR-1), that nothing else changed, and that the steps render as a list rather than a code block.

Checks: markdown, secrets and images 0 errors (large-file warnings only); mkdocs build passes; check_links 683 pages, 0 errors.

🤖 Generated with Claude Code

Customer feedback: a Starter Kit owner watched the boot-mode clip, saw a
finger resting on the board and a second finger pressing reset, and
pressed reset alone. The clip started with boot already held and never
said so.

- Every page that enters boot mode with boot plus reset (25 pages,
  Home Assistant and Homey) now lists the order as three bullets (hold
  boot; while still holding it, press and release reset; let go of
  boot) and a "Keep holding boot the whole time" warning that reset
  alone only restarts the device, placed before the photo or clip.
  Method intros lead with holding boot instead of "use both together".
- The five boot-mode clips (Starter Kit, BTN-1, CAST-1, H-2, PUMP-1)
  now have a step caption bar ("1 Press and hold BOOT", "2 Keep holding
  BOOT. Tap RESET.", "3 Let go of BOOT", "Boot mode is on") that changes
  with the action, a pause at the start of each step so it can be read,
  and alt text that describes the captions. The three largest are also
  smaller (5.2 MB to 2.5 MB, 4.7 to 1.7, 2.7 to 1.7).
- R PRO-1 Method 2 now plugs the board back in before the buttons
  (step 1 unplugged it and nothing reconnected it).
- BTN-1 boot-mode step numbers fixed (1, 2, 4 and 1, 2, 2, 3).
- Style guide: the pattern for two-button boot mode.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 23, 2026

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c87c9bc3-fc81-4b29-9f8f-c673d842f539
📥 Commits

Reviewing files that changed from the base of the PR and between 11615e4 and ae63fe6.

📒 Files selected for processing: 32
  • STYLE_GUIDE.md
  • docs/assets/btn-1-boot-mode-method-2.webp
  • docs/assets/cast-1-boot-mode-method-2.webp
  • docs/assets/esphome-starter-kit-boot-mode.webp
  • docs/assets/h-2-boot-mode-method-2-boot-reset-buttons.webp
  • docs/assets/pump-1-hold-boot-and-reset-button-video.webp
  • docs/homey/products/air1/troubleshooting/air1-boot-mode.md
  • docs/homey/products/msr2/troubleshooting/msr2-boot-mode.md
  • docs/homey/products/mtr1/troubleshooting/mtr1-boot-mode.md
  • docs/homey/products/plt1/troubleshooting/plt1-boot-mode.md
  • docs/homey/products/plt1b/troubleshooting/plt1b-boot-mode.md
  • docs/homey/products/temp1/troubleshooting/temp1-boot-mode.md
  • docs/homey/products/temp1b/troubleshooting/temp1b-boot-mode.md
  • docs/products/ESPHome-Starter-Kit/setup/first-steps.md
  • docs/products/air1/troubleshooting/air1-boot-mode.md
  • docs/products/btn1/troubleshooting/btn1-boot-mode.md
  • docs/products/btn1/troubleshooting/btn1-reflash.md
  • docs/products/cast1/troubleshooting/cast1-boot-mode.md
  • docs/products/cast1/troubleshooting/cast1-reflash.md
  • docs/products/h1/boot-mode.md
  • docs/products/h2/troubleshooting/boot-mode.md
  • docs/products/msr1/troubleshooting/msr1-boot-mode.md
  • docs/products/msr2/troubleshooting/msr2-boot-mode.md
  • docs/products/mtr1/troubleshooting/mtr1-boot-mode.md
  • docs/products/new-product-template/troubleshooting/productname-boot-mode.md
  • docs/products/plt1/troubleshooting/plt1-boot-mode.md
  • docs/products/plt1b/troubleshooting/plt1b-boot-mode.md
  • docs/products/pump1/troubleshooting/pump1-boot-mode.md
  • docs/products/rpro1/troubleshooting/rpro1-boot-mode.md
  • docs/products/temp1/troubleshooting/temp1-boot-mode.md
  • docs/products/temp1b/troubleshooting/temp1b-boot-mode.md
  • docs/products/temppro1/troubleshooting/temp-pro1-boot-mode.md
+-------------------------------+
| BOFH: Bunny of Friendly Help. |
+-------------------------------+
  \
   \     /)/)
        ( '')
        /  |
      o(___)
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • 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.

❤️ Share

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

@Bunton33
Bunton33 merged commit b992189 into dev Oct 23, 2026
2 of 3 checks passed
@Bunton33
Bunton33 deleted the docs/clearer-boot-mode branch October 23, 2026 20:04
@Bunton33 Bunton33 mentioned this pull request Oct 23, 2026
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.

2 participants