Template: cover: add description and type #38785

c0ffeeca7 · 2025-04-28T13:17:23Z

Proposed change

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration others adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Add modern style configuration for template cover #38744
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated the template integration documentation to include a description and type declaration for the cover configuration section.
- Reorganized the cover configuration keys into a nested structure for improved clarity.

home-assistant · 2025-04-28T13:17:27Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

netlify · 2025-04-28T13:17:43Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`7d45ec0`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/680f8231c0ac1d0008513504
😎 Deploy Preview	https://deploy-preview-38785--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

MindFreeze

I think the other properties have to be under keys:

coderabbitai · 2025-04-28T13:19:53Z

📝 Walkthrough

Walkthrough

The change updates the documentation for the template integration by restructuring the cover configuration section. It adds a top-level description ("Characteristics of a cover") and a type declaration (map). All previously existing keys under cover are now nested inside a new keys map. The content and descriptions of the individual keys remain unchanged.

Changes

File	Change Summary
source/_integrations/template.markdown	Restructured `cover` configuration section to include a top-level `description` and `type` and nested all keys under a new `keys` map.

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e03cd7 and ce6849c.

📒 Files selected for processing (1)

source/_integrations/template.markdown (1 hunks)

⏰ 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

coderabbitai · 2025-04-28T13:19:56Z

source/_integrations/template.markdown

+  description: Characteristics of a cover
+  type: map


🛠️ Refactor suggestion

Add required: true to the cover section for consistency
The cover block should declare whether it’s required, mirroring other entity sections (e.g., image, button, number) which all include required: true. Without this key, the schema may be unclear.

Proposed diff:

cover: description: Characteristics of a cover - type: map + required: true + type: map

If desired, you might also align the description with other sections (e.g., "List of covers") to maintain uniformity.

📝 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.

Suggested change

description: Characteristics of a cover

type: map

cover:

description: Characteristics of a cover

required: true

type: map

abmantis · 2025-04-28T13:21:54Z

this is targeted to next but marked for current in the description (I think that is why the bot added the in progress and needs rebase labels.

c0ffeeca7 · 2025-04-28T13:28:22Z

I think the other properties have to be under keys:

oh, I see. Thank you for the catch!

home-assistant · 2025-04-28T13:29:18Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (1)

source/_integrations/template.markdown (1)
299-301: Add required: true to the cover configuration section for consistency

Other entity sections (e.g., sensor, button, image) explicitly declare whether they are required. Including required: true here makes it clear that a cover block must be provided and aligns with the schema of the other integrations.

Apply this diff to insert required: true:
 cover:
   description: Characteristics of a cover
+  required: true
   type: map
   keys:

🧹 Nitpick comments (1)

source/_integrations/template.markdown (1)

302-348: Check and correct inline anchor link fragments

Static analysis flagged the inline links to #open_cover, #close_cover, and #set_cover_position as invalid fragments. Please verify whether the rendered documentation generator uses underscores or hyphens in anchor IDs. If it uses hyphens, update these references (e.g., #open-cover) to prevent broken links in the final docs.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

303-303: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce6849c and 7d45ec0.

📒 Files selected for processing (1)

source/_integrations/template.markdown (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/template.markdown

303-303: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

315-315: Link fragments should be valid
null

(MD051, link-fragments)

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Lint Text
GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

Template: cover: add description and type

ce6849c

c0ffeeca7 requested a review from a team as a code owner April 28, 2025 13:17

home-assistant bot assigned c0ffeeca7 Apr 28, 2025

home-assistant bot added the in-progress This PR/Issue is currently being worked on label Apr 28, 2025

home-assistant bot added needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Apr 28, 2025

joostlek previously approved these changes Apr 28, 2025

View reviewed changes

MindFreeze reviewed Apr 28, 2025

View reviewed changes

coderabbitai bot reviewed Apr 28, 2025

View reviewed changes

c0ffeeca7 removed their assignment Apr 28, 2025

c0ffeeca7 removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 28, 2025

Move details under

7d45ec0

c0ffeeca7 dismissed joostlek’s stale review via 7d45ec0 April 28, 2025 13:27

home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 28, 2025

coderabbitai bot reviewed Apr 28, 2025

View reviewed changes

MindFreeze approved these changes Apr 28, 2025

View reviewed changes

MindFreeze merged commit 67229a0 into next Apr 28, 2025
9 checks passed

home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Apr 28, 2025

MindFreeze deleted the template-cover-add-description-and-type branch April 28, 2025 13:52

github-actions bot locked and limited conversation to collaborators Apr 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Template: cover: add description and type #38785

Template: cover: add description and type #38785

c0ffeeca7 commented Apr 28, 2025 •

edited by coderabbitai bot

Loading

home-assistant bot commented Apr 28, 2025

netlify bot commented Apr 28, 2025 •

edited

Loading

MindFreeze left a comment

coderabbitai bot commented Apr 28, 2025 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot Apr 28, 2025

abmantis commented Apr 28, 2025

c0ffeeca7 commented Apr 28, 2025

home-assistant bot commented Apr 28, 2025

coderabbitai bot left a comment

Template: cover: add description and type #38785

Template: cover: add description and type #38785

Conversation

c0ffeeca7 commented Apr 28, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Summary by CodeRabbit

home-assistant bot commented Apr 28, 2025

netlify bot commented Apr 28, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

MindFreeze left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Apr 28, 2025 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 28, 2025

Choose a reason for hiding this comment

abmantis commented Apr 28, 2025

c0ffeeca7 commented Apr 28, 2025

home-assistant bot commented Apr 28, 2025

coderabbitai bot left a comment

Choose a reason for hiding this comment

c0ffeeca7 commented Apr 28, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 28, 2025 •

edited

Loading

coderabbitai bot commented Apr 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)