Add cat genie documentation#45104
Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new CatGenie integration and updates the existing Actron Air integration docs to reflect newly added switch entities.
Changes:
- Added a new integration documentation page for CatGenie.
- Updated Actron Air docs to include the
switchplatform and describe the new switch entities.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| source/_integrations/catgenie.markdown | New integration page covering supported devices, prerequisites, entities, and examples. |
| source/_integrations/actron_air.markdown | Documents newly added switch platform/entities for Actron Air. |
| You can utilise this integration to: | ||
|
|
||
| ### Turn on an exhaust fan when the unit is running | ||
|
|
||
| You can automatically set a fan to run when the sensor 'status' is in the 'cleaning' mode, and turn off when the status is in the 'idle' mode. |
There was a problem hiding this comment.
Use US English and Home Assistant style in this section: “utilise” -> “use”, and format entity/attribute names and state values with backticks (for example, status, cleaning, idle) instead of single quotes.
| You can utilise this integration to: | |
| ### Turn on an exhaust fan when the unit is running | |
| You can automatically set a fan to run when the sensor 'status' is in the 'cleaning' mode, and turn off when the status is in the 'idle' mode. | |
| You can use this integration to: | |
| ### Turn on an exhaust fan when the unit is running | |
| You can automatically set a fan to run when the sensor `status` is in the `cleaning` mode, and turn off when the status is in the `idle` mode. |
| ha_domain: actron_air | ||
| ha_platforms: | ||
| - climate | ||
| - switch |
There was a problem hiding this comment.
ha_platforms now includes switch, but ha_category still only lists Climate. Add Switch to ha_category so the integrations index/category filtering reflects the new switch entities.
|
|
||
| ## Supported functionality | ||
|
|
||
| The **My integration** integration provides the following entities. |
There was a problem hiding this comment.
This sentence still contains the template placeholder “My integration”. Replace it with “CatGenie” so the Supported functionality section refers to the correct integration.
| The **My integration** integration provides the following entities. | |
| The **CatGenie** integration provides the following entities. |
| --- | ||
|
|
||
| The **CatGenie** {% term integration %} is used to integrate with the devices of [CatGenie](https://www.catgenie.com/). CatGenie creates automatic cat toilets. | ||
| Use case: You can automatically trigger an exhaust fan when the CatGenie is running to remove any lingering odour. |
There was a problem hiding this comment.
Use American English spelling in docs: change “odour” to “odor”. Also consider rewriting the “Use case:” line as a normal sentence for readability.
| Use case: You can automatically trigger an exhaust fan when the CatGenie is running to remove any lingering odour. | |
| For example, you can automatically trigger an exhaust fan when the CatGenie is running to remove any lingering odor. |
| 1. Your device must support the CatGenie App | ||
| 2. Your device must be setup in the CatGenie App prior to setting up this integration |
There was a problem hiding this comment.
Prerequisites steps need copy edits for Home Assistant docs style: add periods, and use the verb form “set up” (not “setup”) when describing the action of configuring the device in the app.
| 1. Your device must support the CatGenie App | |
| 2. Your device must be setup in the CatGenie App prior to setting up this integration | |
| 1. Your device must support the CatGenie App. | |
| 2. Your device must be set up in the CatGenie App prior to setting up this integration. |
Proposed change
Contributing doucmentation for the new CatGenie integration in Home Assistant
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.