docs: add Connect to Home Assistant tutorial + HA Integration Learn the Basics page#845
Conversation
…he Basics page Adds two Starter Kit pages covering how the device shows up in Home Assistant: - tutorials/connect-to-home-assistant.md: step-by-step for accepting the device into Home Assistant, confirming entities, and a small troubleshooting section. - learning-the-basics/how-esphome-talks-to-home-assistant.md: the conceptual companion, titled "HA Integration" in the nav. Covers auto-discovery, the encryption key, how components become entities, and how the on-device web page coexists with Home Assistant. Network edge cases collapsed into a single admonition that links to the UniFi mDNS troubleshooting guide. Both pages use my.home-assistant.io My redirect links and badges for any "open X in Home Assistant" reference, so readers land at the right spot in their own instance without clicking around. Other touch-ups in the same PR: - setup/first-steps.md footer: three buttons (Back - Start Here, Add More Modules, Connect to Home Assistant). - learning-the-basics/explaining-esphome.md: cross-link to the new HA Integration page from the "From Home Assistant" subsection, and link the on-device web page hostname so readers can click straight to it. Same actionable-URL fix on the new HA Integration page.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
WalkthroughThis PR extends the ESPHome Starter Kit documentation with new learning and tutorial content focused on Home Assistant integration. It adds two new pages explaining how the device connects to Home Assistant and walking users through the setup process, updates navigation across existing docs to surface these resources, and wires them into the site's documentation structure. ChangesHome Assistant Integration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
What does this implement/fix?
Two new Starter Kit pages covering how the device shows up in Home Assistant, plus a few touch-ups to existing pages:
New pages:
tutorials/connect-to-home-assistant.md("Connect to Home Assistant"): step-by-step for accepting the device into Home Assistant, confirming entities, and a short troubleshooting section.learning-the-basics/how-esphome-talks-to-home-assistant.md("HA Integration" in the nav): conceptual companion covering auto-discovery, the encryption key, how components become entities, and how the on-device web page coexists with Home Assistant. Network edge cases collapsed into a single admonition that links to the UniFi mDNS troubleshooting guide.Both pages use my.home-assistant.io My redirect links and badges for any "open X in Home Assistant" reference, so readers land at the right spot in their own instance without manual navigation.
Touch-ups:
setup/first-steps.mdfooter: three buttons (Back - Start Here, Add More Modules, Connect to Home Assistant).learning-the-basics/explaining-esphome.md: cross-link to the new HA Integration page from the "From Home Assistant" subsection, and link the on-device web page hostname so readers can click straight to it. Same actionable-URL fix on the new HA Integration page.Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs servemkdocs.ymlmkdocs.ymlSummary by CodeRabbit