Repository navigation
docs: My Home Assistant buttons across the wiki - #1163
Merged
Merged
Conversation
Replace supervisor_addon (addon=) with supervisor_app (app=) and developer_services with tools_actions, turn the HTML badges into the wiki's Markdown badge pattern, and use the official alt text. - switch-to-beta-branch: the Device Builder badge pointed at addon=ESPHome+Device+Builder with a homeassistant.local repository_url, which never resolved. It now opens 5c53de3b_esphome. - updating-firmware: swap the local add-on image for the official supervisor_app badge and drop the literal & in the URL. - CAST-1 Device Builder: add the missing repository_url to the second badge. - WizMote blueprint: import from the raw YAML URL, not the GitHub page. - Renaming guide: replace the homeassistant.local links next to the existing badges with the written Settings path. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The BTN-1 and PLT-1 Manual Import steps told readers to copy "this link" into the Blueprint address box, but the link was a My Home Assistant redirect. That URL returns an HTML page, so the import failed. Show the raw blueprint URL in a code block instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The setup guide gets a button for each step that opens a Home Assistant screen: the HACS repository (covers steps 1 to 5, as in the integration README), restart, add integration, the integration options, the Get HACS app and About in the prerequisites, and the dashboards, logs and ESPHome pages its troubleshooting sends readers to. The usage guide gets buttons for creating the automation, the calibrate_gates action, the File editor app and its two troubleshooting checks. Every step keeps its written Settings path. The MSR-1, MSR-2, MTR-1 and R PRO-1 copies include these pages, so they pick the buttons up. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Put a button under each step that sends the reader to a Home Assistant screen: the integrations and ESPHome pages in Getting Started (shared by every product's copy), the ESPHome Device Builder app in the Device Builder how-tos, the ESPHome page in the radar tuning and CO2 pages, HACS for Plotly and Streamline Card, the Zone Mapper repositories, setup dialog and resources, helpers and automations in the awake helper guide, and the Media Proxy app on the M-1 page. Where a step linked a hard-coded homeassistant.local address, the link becomes the written Settings path and the button carries the link, so it works for readers on any address. The M-1 page also loses a tip box that repeated the paragraph under it word for word. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Starter Kit: the text links to Automations, Blueprints, Devices & services, the ESPHome integration and the Bluetooth advertisement monitor become buttons under their steps, the written path stays, and the motion-light blueprint gets an import button. Examples: HACS buttons for Alarmo and its card (plus the missing step to add the Alarmo integration, and "add-on" corrected to "integration"), ApexCharts Card, Plotly Graph Card and the Flower Card trio; Developer Tools > Actions buttons on the buzzer, holiday song and TTS pages; ESPHome page buttons on the LED strip, food probe, predicted temperature and Media Proxy pages; the Blueprints tab on the PLT-1 manual import; Automations in the TEMP-1 and TEMP-1B examples, in place of a "Click here" link to homeassistant.local; and the restart step in the mmWave activity tutorial. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add a "My Home Assistant buttons" section after Images: which steps get a button (installing or adding something, opening the screen a step works in, restarting), the exact Markdown with an example, list and admonition indentation, the alt text rule, current redirect names and the link creator, parameter checks, keeping the written path, one button per destination per section, and no Home Assistant buttons in content that Homey pages include. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Getting Started and the three Alarmo pages kept "easily" in sentences these changes edited. The style guide asks for it to go. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Apollo mmWave needs Home Assistant 2026.8.1 or newer, and 2026.8 moved Developer tools to Settings → Tools. The calibration paragraph still sent readers to Developer Tools → Actions, a place they won't find. It now matches the integration's configuration guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The pages this branch edited still had homeassistant.local:8123 links, which only work for readers on that address: R PRO-1 LD2412 steps 6 and 8, the "unsure of your device name" asides on the R PRO-1 and MTR-1 zone pages, the MSR-2 tuning dashboard, Sendspin and the BTN-1 manual blueprint import. Each is now a bold written path. No buttons were added, so the BTN-1 page Homey includes stays Home Assistant button free. Lines that lost their link earlier now read as full paths too: the mmWave videos and R PRO-1 LD2412 steps name Devices & services, the TEMP-1 and TEMP-1B automation steps point to + Create automation in the bottom right, and the M-1 Media Proxy step replaces its seven-arrow chain. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Both methods led with an "Open ESPHome Device Builder" button that only worked on homeassistant.local:8123, with the My Home Assistant app button for the same app right under it. Step 1 now carries only the app button, which opens the app's page or offers to install it, and the separate "Don't have it installed yet?" step is gone. Method 1 steps are renumbered 1 to 5. These snippets render on the general Bluetooth Proxy page and on every product's Bluetooth proxy page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
On the piezo, AIR-1 predicted temperature and Zone Mapper pages the button came after the steps that reach the same screen by hand, so a reader working in order got there before the shortcut. - Piezo: the Actions button sits under step 1 and says it skips step 2. Step 1 also names Settings → Tools for Home Assistant 2026.8 and newer. The numbering stays, because the screenshot's arrows match it. - AIR-1: step 1 now opens the ESPHome integration, with the button, and step 2 picks the AIR-1. - Zone Mapper: both HACS buttons sit under step 1, which says they cover steps 1 to 5. This snippet renders on the general, MTR-1 and R PRO-1 Zone Mapper pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Name Settings → Tools (tools_actions, tools_states, tools_perform_action) instead of Developer Tools, which Home Assistant 2026.8 moved there. - When one button replaces several steps, put it under the first and say which steps it covers. - Point third-party apps at supervisor_app with repository_url, which offers to add the repository, instead of supervisor_add_addon_repository, which no page uses. - Check that a redirect is also in the frontend's ha-panel-my.ts, since a few listed names, such as activity, are not. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Home Assistant 2026.8 moved Developer tools to Settings → Tools, and the style guide now names that path. The lines beside the tools_actions and tools_states buttons on the Starter Kit tune page, CAST-1 announcements, holiday songs and the Zone Mapper troubleshooting list still named only Developer tools. Each now adds the Settings → Tools path for 2026.8 and newer, as the piezo page does, so readers who follow the written path find the screen in either version. Text only, no new buttons. The Zone Mapper snippet renders on the general, MTR-1 and R PRO-1 Zone Mapper pages, and no Homey page includes any of these files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
WalkthroughThe documentation adds guidance for My Home Assistant buttons and updates product instructions with Home Assistant app, integration, HACS, and navigation links. It also revises several local URLs, redirect parameters, navigation paths, and badge formats. ChangesHome Assistant Documentation
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title clearly and concisely summarizes the main change: adding My Home Assistant buttons across the documentation wiki. |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| 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 functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (67 skipped: 67 unsupported.)
✨ 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.
A rabbit taps a badge with care
Then hops to Settings, quick and fair
A link opens the app’s bright door
HACS cards sit close at hand once more
The docs now guide each hop and turn
While I nibble greens and learn
Comment @coderabbitai help to get the list of available commands.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the official My Home Assistant buttons, the "Open your Home Assistant instance and ..." badges, to steps that send readers to a screen in Home Assistant. The buttons cover installing from HACS, adding an integration, opening an integration's page, installing or opening an app, importing a blueprint, restarting, and specific Settings and Tools pages.
What changed
supervisor_addontosupervisor_appwithapp=, anddeveloper_servicestotools_actions. Per the My Home Assistant README, current names work on every Home Assistant version.homeassistant.localand text My Home Assistant links in steps are now Settings paths or buttons. The BTN-1 and PLT-1 blueprint manual-import steps now give the raw YAML address.Rules followed
Validation
redirect.jsonand checked against it. Required params are present and no unknown params are used. All 20 distinct badge images return 200.devapart from the content changes. A parse of the built HTML shows every button inside its list item, with numbering intact, and no new My Home Assistant links on any Homey page.Follow-up, not in this PR
These pages are included whole by Homey pages, so they got no buttons:
Narrowing those Homey includes would let the Home Assistant versions get buttons too.
🤖 Generated with Claude Code
Summary by CodeRabbit