Update template cover, switch, and light documentation. #38822
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User ->> Documentation: Reads about template integration
Documentation -->> User: Presents updated entity types (including switch, cover)
User ->> Documentation: Checks YAML configuration section
Documentation -->> User: Shows configuration options for all supported entities
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
source/_integrations/template.markdown (4)
60-63: Ensure lists are surrounded by blank lines
Per Markdown lint (MD032), lists should be preceded and followed by an empty line to improve readability and avoid rendering issues. Please add a blank line before the- [Cover]…entry and one after the list.For Legacy types, please see the specific pages: + - [Cover](/integrations/cover.template/) - [Light](/integrations/light.template/) - [Switch](/integrations/switch.template/) + {% include integrations/config_flow.md %}🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
60-60: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
78-78: Grammar: use “weather entities” instead of “weathers”
The plural “weathers” is unconventional. For consistency with other sections, replace it with “weather entities.”- Entities (binary sensors, buttons, covers, images, lights, numbers, selects, sensors, switches, and weathers) are defined in your YAML configuration files under the `template:` key. + Entities (binary sensors, buttons, covers, images, lights, numbers, selects, sensors, switches, and weather entities) are defined in your YAML configuration files under the `template:` key.
82-82: Grammar: replace “weathers” with “weather entities” in heading
Align terminology with the rest of the document by using “weather entities” in the section title.- ### State-based template binary sensors, buttons, covers, images, lights, numbers, selects, sensors, switches, and weathers + ### State-based template binary sensors, buttons, covers, images, lights, numbers, selects, sensors, switches, and weather entities
104-104: Grammar: replace “weathers” with “weather entities” in heading
Use consistent terminology across headings and configuration reference sections.- ### Trigger-based template binary sensors, images, lights, numbers, selects, sensors, switches, and weathers + ### Trigger-based template binary sensors, images, lights, numbers, selects, sensors, switches, and weather entities
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/template.markdown(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/template.markdown
49-49: Link fragments should be valid
null
(MD051, link-fragments)
60-60: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| @@ -46,18 +46,18 @@ related: | |||
|
|
|||
| The `template` integration allows creating entities which derive their values from other data. This is done by specifying [templates](/docs/configuration/templating/) for properties of an entity, like the name or the state. | |||
|
|
|||
| Sensors, binary (on/off) sensors, buttons, images, numbers, and selects are covered on this page. They can be configured using [UI](#configuration) or [YAML](#yaml-configuration) file. | |||
| Sensors, binary (on/off) sensors, buttons, images, numbers, selects, and switches are covered on this page. They can be configured using [UI](#configuration) or [YAML](#yaml-configuration) file. | |||
There was a problem hiding this comment.
Broken link fragment: UI likely broken
The anchor #configuration does not match any heading ID in this document. The include at line 64 generates a “Configuration flow” section, which likely uses #configuration-flow. Please update the link to the correct fragment (or adjust the heading) to prevent a dead link.
- They can be configured using [UI](#configuration) or [YAML](#yaml-configuration) file.
+ They can be configured using [UI](#configuration-flow) or [YAML](#yaml-configuration) file.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Sensors, binary (on/off) sensors, buttons, images, numbers, selects, and switches are covered on this page. They can be configured using [UI](#configuration) or [YAML](#yaml-configuration) file. | |
| Sensors, binary (on/off) sensors, buttons, images, numbers, selects, and switches are covered on this page. They can be configured using [UI](#configuration-flow) or [YAML](#yaml-configuration) file. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Link fragments should be valid
null
(MD051, link-fragments)
Proposed change
Update template documentation for PRs
I added all these changes in a single PR because it would be a merge nightmare if they were separate.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit