Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Home Connect program switches deprecation #36073

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

Diegorro98
Copy link
Contributor

@Diegorro98 Diegorro98 commented Nov 30, 2024

Proposed change

Program switches are being deprecated because it functionality has been substituted by the active program select entity.

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 I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

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 Home Connect integration documentation with detailed descriptions of functionality and supported appliances.
    • Expanded prerequisites for setting up a Home Connect developer account, including instructions for obtaining client ID and secret.
    • Clarified available actions and their required data attributes for better usability.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Nov 30, 2024
Copy link

netlify bot commented Nov 30, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5489f98
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/674ad4594f07db0008c16ca3
😎 Deploy Preview https://deploy-preview-36073--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

coderabbitai bot commented Nov 30, 2024

📝 Walkthrough

Walkthrough

The changes involve a significant update to the documentation for the Home Connect integration in Home Assistant. This includes detailed descriptions of the integration's functionality, supported appliances, and the types of entities created. The prerequisites for setting up a Home Connect developer account have been clarified, and specific instructions for obtaining client credentials are provided. Additionally, the documentation outlines the available actions within the integration, detailing their purposes and required data attributes.

Changes

File Change Summary
source/_integrations/home_connect.markdown Comprehensive update to documentation, including functionality, supported appliances, prerequisites, and detailed action descriptions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant HomeConnectAPI

    User->>HomeAssistant: Setup Home Connect Integration
    HomeAssistant->>User: Provide documentation
    User->>HomeConnectAPI: Register application
    HomeConnectAPI-->>User: Provide client ID and secret
    User->>HomeAssistant: Configure integration with client ID
    HomeAssistant->>HomeConnectAPI: Authenticate user
    HomeConnectAPI-->>HomeAssistant: Return access token
    User->>HomeAssistant: Execute action (e.g., start_program)
    HomeAssistant->>HomeConnectAPI: Send action request
    HomeConnectAPI-->>HomeAssistant: Confirm action execution
    HomeAssistant-->>User: Notify action result
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a4923de and 5489f98.

📒 Files selected for processing (1)
  • source/_integrations/home_connect.markdown (0 hunks)
💤 Files with no reviewable changes (1)
  • source/_integrations/home_connect.markdown

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approved. Can be merged as soon as the parent PR gets merged.

@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants