Skip to content

docs(m1): add my.home-assistant.io badge for ESPHome Device Builder install#761

Merged
bharvey88 merged 1 commit into
devfrom
fix/m1-esphome-device-builder-link
Apr 30, 2026
Merged

docs(m1): add my.home-assistant.io badge for ESPHome Device Builder install#761
bharvey88 merged 1 commit into
devfrom
fix/m1-esphome-device-builder-link

Conversation

@bharvey88
Copy link
Copy Markdown
Contributor

@bharvey88 bharvey88 commented Apr 30, 2026

What does this implement/fix?

The M-1 ESPHome getting started guide tells the user to "click the button below" to install the ESPHome Device Builder add-on, but no button was actually rendered. This adds the official my.home-assistant.io supervisor_addon badge that deep-links straight into the user's Home Assistant supervisor add-on store with the ESPHome Device Builder pre-selected, matching the pattern already used on products/general/setup/switch-to-beta-branch.md and products/general/calibrating-and-updating/updating-firmware.md.

Also capitalized "Start on Boot" to match the actual toggle label in the Home Assistant add-on UI.

Types of changes

  • Typo / wording fix
  • Content update (correcting outdated info, adding missing steps, clarifications)
  • New page or new product section
  • Page move / rename (redirect added in mkdocs.yml)
  • Image / screenshot update
  • Nav / structure change
  • Site config or theme change
  • CI / workflows / dependencies — Does not publish

Checklist:

  • This PR targets the dev branch (not main)
  • Changes previewed locally with mkdocs serve
  • If pages were moved or renamed, redirects were added to mkdocs.yml
  • If new pages were added, nav was updated in mkdocs.yml

Summary by CodeRabbit

  • Documentation
    • Updated ESPHome setup guide with clearer installation instructions, including a convenient badge link that directly opens the Home Assistant supervisor add-on store with ESPHome pre-selected for faster setup.

@bharvey88 bharvey88 merged commit 9f4c2a3 into dev Apr 30, 2026
1 check was pending
@bharvey88 bharvey88 deleted the fix/m1-esphome-device-builder-link branch April 30, 2026 21:34
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 30, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1531a8cd-4f0b-4004-ba6e-83b7ffdc4f12

📥 Commits

Reviewing files that changed from the base of the PR and between 5901a5c and 9523b3f.

📒 Files selected for processing (1)
  • docs/products/m1/setup/getting-started-m1-esphome.md

Walkthrough

The ESPHome getting-started guide for the M1 product was updated to capitalize the "Start" instruction text and include a direct badge link to the Home Assistant supervisor add-on store for simplified ESPHome add-on installation.

Changes

Cohort / File(s) Summary
ESPHome M1 Setup Documentation
docs/products/m1/setup/getting-started-m1-esphome.md
Updated instruction text capitalization ("Start on Boot") and added a badge link for direct access to the Home Assistant supervisor add-on store.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A button bright, a link so clear,
Makes ESPHome setup without fear!
With caps so bold and badges new,
Getting started's easier to do! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/m1-esphome-device-builder-link

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

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