Document program key attribute at Home Connect

[Diegorro98]

Proposed change

Some programs are not documented, so they are not in the integration, neither have translation keys, etc.
So at core a program_key has been added to show the raw value of the program value in the select entiites that control the activre and the select programs.

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).
  • 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: Show the raw program key at Home Connect select entities attributes core#131874

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
  • Added clarification about the Home Connect integration, noting that some programs are not documented by the API.
  • Specified the use of the program_key attribute for automation or scripting with undocumented programs.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	bf60cf1
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/674ad1c585e03d0008cf7931
😎 Deploy Preview	https://deploy-preview-36072--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.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a clarification in the Home Connect integration documentation, highlighting that some programs are not documented by the API and are therefore excluded from the integration. It informs users about the use of the program_key attribute for accessing undocumented programs for automation or scripting purposes. The existing notes and instructions remain intact, ensuring users are aware of the integration's capabilities and limitations.

Changes

File	Change Summary
source/_integrations/home_connect.markdown	Added a note about undocumented programs in the Home Connect integration and usage of program_key.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeConnectAPI
    participant Integration

    User->>Integration: Request to use program
    Integration->>HomeConnectAPI: Check program documentation
    alt Program documented
        HomeConnectAPI-->>Integration: Return program details
        Integration-->>User: Provide program information
    else Program undocumented
        Integration-->>User: Inform about use of program_key
    end

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

📒 Files selected for processing (1)

• source/_integrations/home_connect.markdown (1 hunks)

🔇 Additional comments (1)

source/_integrations/home_connect.markdown (1)

55-59: LGTM! The documentation addition is clear and valuable.

The new note block effectively:

• Explains the limitation regarding undocumented programs
• Provides a solution using the program_key attribute
• Helps users understand how to work with undocumented programs in their automations

Let's verify if this documentation matches the implementation:

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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