Skip to content

[docs] Rename "add-on" to "app" in getting started guide#6713

Open
eMUQI wants to merge 2 commits into
esphome:currentfrom
eMUQI:docs/rename-addon-to-app
Open

[docs] Rename "add-on" to "app" in getting started guide#6713
eMUQI wants to merge 2 commits into
esphome:currentfrom
eMUQI:docs/rename-addon-to-app

Conversation

@eMUQI
Copy link
Copy Markdown

@eMUQI eMUQI commented May 31, 2026

Description

Home Assistant 2026.2 renamed "add-ons" to "apps". This PR updates user-facing text in the getting started with Home Assistant guide to reflect the new terminology.

Changes in src/content/docs/guides/getting_started_hassio.mdx:

  • Frontmatter description
  • Intro paragraph
  • Badge alt text
  • Install instructions (2 occurrences)
  • Note about access to apps
  • SSH app reference

Technical identifiers (variable names, external URLs, Docker container names) are left unchanged.


Note

The following files also contain "add-on" references that may need similar updates. Should these be included in this PR or handled separately?

  • src/content/docs/index.mdx
  • src/content/docs/components/mdns.mdx
  • src/content/docs/components/font.mdx
  • src/content/docs/components/ota/http_request.mdx
  • src/content/docs/guides/getting_started_command_line.mdx
  • src/content/docs/guides/faq.mdx
  • src/content/docs/guides/migrate_espurna.mdx
  • src/content/docs/guides/migrate_sonoff_tasmota.mdx
  • src/content/docs/guides/migrate_espeasy.mdx

Note: atm90e26.mdx and atm90e32.mdx use "add-on" to refer to hardware expansion boards, not Home Assistant add-ons — these should remain as-is.

Related issue (if applicable): N/A

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

  • N/A

Checklist

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

  • 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 /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

Home Assistant 2026.2 renamed "add-ons" to "apps".
Update user-facing text in the getting started with
Home Assistant guide to reflect the new terminology.
@esphome esphome Bot added the current label May 31, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 31, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 7d0330f
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a1e944aa800260008924bf9
😎 Deploy Preview https://deploy-preview-6713--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 31, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 017e677c-2873-4cf0-87d2-4034f81a9631

📥 Commits

Reviewing files that changed from the base of the PR and between 2308531 and 7d0330f.

📒 Files selected for processing (9)
  • src/content/docs/components/font.mdx
  • src/content/docs/components/mdns.mdx
  • src/content/docs/components/ota/http_request.mdx
  • src/content/docs/guides/faq.mdx
  • src/content/docs/guides/getting_started_command_line.mdx
  • src/content/docs/guides/migrate_espeasy.mdx
  • src/content/docs/guides/migrate_espurna.mdx
  • src/content/docs/guides/migrate_sonoff_tasmota.mdx
  • src/content/docs/index.mdx
✅ Files skipped from review due to trivial changes (8)
  • src/content/docs/components/mdns.mdx
  • src/content/docs/index.mdx
  • src/content/docs/guides/migrate_espeasy.mdx
  • src/content/docs/components/ota/http_request.mdx
  • src/content/docs/guides/migrate_espurna.mdx
  • src/content/docs/guides/getting_started_command_line.mdx
  • src/content/docs/guides/faq.mdx
  • src/content/docs/components/font.mdx

Walkthrough

Documentation text across multiple guides and component pages was updated to replace references to "Home Assistant add-on"/"Add-on Store" with "Home Assistant app"/"App Store", and the getting started guide's installation and SSH notes were adjusted to reference the ESPHome Device Builder app and the SSH app.

Changes

App Installation Documentation

Layer / File(s) Summary
Getting Started (Hass.io) guide updates
src/content/docs/guides/getting_started_hassio.mdx
Page description, introduction, installation instructions with badge/link, UPDATE button explanation, and SSH access NOTE updated to reference Home Assistant apps and the SSH app.
Supplementary docs wording updates
src/content/docs/components/font.mdx, src/content/docs/components/mdns.mdx, src/content/docs/components/ota/http_request.mdx, src/content/docs/guides/faq.mdx, src/content/docs/guides/getting_started_command_line.mdx, src/content/docs/guides/migrate_espeasy.mdx, src/content/docs/guides/migrate_espurna.mdx, src/content/docs/guides/migrate_sonoff_tasmota.mdx, src/content/docs/index.mdx
Minor single-line edits across component and guide docs updating wording to use "app"/"App Store" and to adjust references for downloading/compiling binaries, Pillow expectations, and ping/SSH guidance.

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating documentation to rename 'add-on' to 'app' in the getting started guide, reflecting Home Assistant 2026.2's terminology change.
Description check ✅ Passed The description clearly explains the terminology change context, lists specific files modified, distinguishes between user-facing and technical changes, and appropriately addresses scope questions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@eMUQI
Copy link
Copy Markdown
Author

eMUQI commented Jun 2, 2026

Hi @jesserockz , PTAL.

I've been writing an ESPHome getting started series for Waveshare boards and ran into this — Home Assistant renamed "add-ons" to "apps" back in 2026.2, but the ESPHome docs haven't caught up yet. It'd be great to get the terminology in sync.

Happy to expand the scope to cover the other files listed above if that helps. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant