Add documentation on Miele vacuum platform #38770
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 Miele integration was updated to reflect new support for vacuum devices. The metadata in the documentation now lists "Vacuum" as a supported category and platform. A new section describing vacuum entity support, including available controls and monitoring capabilities, was added. The structure of the documentation was adjusted to properly close and open details blocks for entity types. No changes were made to existing entity types or automation examples. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Miele Integration Documentation
User->>Miele Integration Documentation: Access documentation
Miele Integration Documentation-->>User: Display supported categories (now includes Vacuum)
User->>Miele Integration Documentation: View Vacuum entity section
Miele Integration Documentation-->>User: Show controls and monitoring info for Vacuum devices
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 0
🧹 Nitpick comments (1)
source/_integrations/miele.markdown (1)
155-160: Document the Vacuum entity
The new### Vacuumsection and nested{% details %}block accurately describe Miele robot vacuums (start, stop, pause, fan speed). Consider enriching this section with additional attributes (e.g., battery level, status) if supported by the API:### Vacuum {% details "List of vacuum entities" %} - **Robot vacuum cleaner**: Miele robot vacuum cleaners can be monitored and controlled to a limited extent. The device can be started, stopped, and paused. The fan speed can also be set. + - **Battery level**: Reports the current battery percentage of the device. {% enddetails %}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/miele.markdown(4 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
🔇 Additional comments (3)
source/_integrations/miele.markdown (3)
12-12: Add Vacuum to supported categories
The new- Vacuumentry underha_categoryaligns with the existing Title-case style. This correctly advertises the vacuum entity in the integration metadata.
27-27: Include vacuum inha_platforms
Adding- vacuumto theha_platformslist follows Home Assistant conventions (all lowercase, underscore-free). Ensure that the vacuum platform is exercised in CI tests to avoid any missing template or translation errors.
122-123: Properly close the Light details block
The explicit{% enddetails %}on line 122 (and subsequent blank line) prevents the Light section from bleeding into the Binary sensor section, restoring correct Markdown structure.
Proposed change
Add description of vacuum entity
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit