Home AssistantHome AssistantContributors
On this page

This is a Bronze rule. In quality_scale.yaml, it is called docs-removal-instructions.

The integration page on home-assistant.io must explain how to remove the integration. When removing it from Home Assistant is all there is to it, say so. When there is more to clean up, like a token in the app of the manufacturer or a setting on the device, describe those steps too.

Why it matters

Removing an integration is not always as simple as deleting it in Home Assistant. A cloud service may keep Home Assistant listed as a connected app, or a device may keep pushing data to an address that no longer listens. Users who want to start fresh, or stop using a device, need to know what is left behind.

Example

Use the standard include for the steps in Home Assistant, and add anything specific to your integration:

Markdown
## Removing the integration

This integration follows standard integration removal.

{% include integrations/remove_device_service.md %}

After you remove the integration, open the **MyProduct** app and remove
Home Assistant from the list of connected apps.

See Write integration documentation and the integration page structure for where this goes on the page.

How it is checked

Checked in review of the documentation pull request.

Exceptions

There are no exceptions to this rule.

Was this page helpful?

Last updated on .