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

added documentation redgtech #36958

Draft
wants to merge 177 commits into
base: next
Choose a base branch
from

Conversation

Jonhsady
Copy link

@Jonhsady Jonhsady commented Jan 16, 2025

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

  • New Features

    • Added Redgtech device integration for Home Assistant
    • Supports smart lights and switches
    • Enables device control and real-time monitoring
    • Provides easy setup and configuration process
  • Documentation

    • Created comprehensive integration documentation
    • Included device compatibility table
    • Added troubleshooting guidance

mrdarrengriffin and others added 30 commits December 23, 2024 16:13
* Fix display issues when :target is active

* Content update

* Change :target to display block

* Added Australian distributors
* Fix limitations wording

* Reorder limitations section
Bumps [rbs](https://github.com/ruby/rbs) from 3.7.0 to 3.8.0.
- [Release notes](https://github.com/ruby/rbs/releases)
- [Changelog](https://github.com/ruby/rbs/blob/master/CHANGELOG.md)
- [Commits](ruby/rbs@v3.7.0...v3.8.0)

---
updated-dependencies:
- dependency-name: rbs
  dependency-type: indirect
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…36548)

Bumps [bigdecimal](https://github.com/ruby/bigdecimal) from 3.1.8 to 3.1.9.
- [Release notes](https://github.com/ruby/bigdecimal/releases)
- [Changelog](https://github.com/ruby/bigdecimal/blob/master/CHANGES.md)
- [Commits](ruby/bigdecimal@v3.1.8...v3.1.9)

---
updated-dependencies:
- dependency-name: bigdecimal
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…t#36504)

* Add troubleshooting and known limitations

* Remove quotes for non-code

* CRAI nitpicks

* Add suggestions
Example in Legacy binary sensor section was missing quote marks.
Point to the correct repository and not to a forked one.
dependabot bot and others added 8 commits January 16, 2025 08:13
…e-assistant#36947)

Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11755 to 0.5.11761.
- [Release notes](https://github.com/sorbet/sorbet/releases)
- [Commits](https://github.com/sorbet/sorbet/commits)

---
updated-dependencies:
- dependency-name: sorbet-runtime
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…36948)

Bumps [parser](https://github.com/whitequark/parser) from 3.3.6.0 to 3.3.7.0.
- [Changelog](https://github.com/whitequark/parser/blob/master/CHANGELOG.md)
- [Commits](whitequark/parser@v3.3.6.0...v3.3.7.0)

---
updated-dependencies:
- dependency-name: parser
  dependency-type: indirect
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Add Lutron Caseta to SSDP page

* lutron accent
* Improve incomfort docs

* Rephrase

* Typo

* Update source/_integrations/incomfort.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Apply suggestions from code review

* fix link

---------

Co-authored-by: c0ffeeca7 <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Add better content types to examples

* Update source/_integrations/music_assistant.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jan 16, 2025
Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 65047e3
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/678acb36e16d85000814c084
😎 Deploy Preview https://deploy-preview-36958--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 Jan 16, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a new Home Assistant integration for Redgtech devices, specifically targeting smart lights and switches. The documentation provides a comprehensive guide for users to connect and manage Redgtech devices within the Home Assistant ecosystem. The markdown file includes configuration instructions, device compatibility information, feature descriptions, and a troubleshooting section to help users successfully integrate and use Redgtech smart home devices.

Changes

File Change Summary
source/_integrations/redgtech.markdown Added new integration documentation for Redgtech devices, including setup instructions, supported device list, features, and troubleshooting guidance

Sequence Diagram

sequenceDiagram
    participant User
    participant HomeAssistant
    participant RedgtechCloud
    
    User->>HomeAssistant: Navigate to Integrations
    User->>HomeAssistant: Add Redgtech Integration
    HomeAssistant->>RedgtechCloud: Request Authentication
    User->>RedgtechCloud: Login with Credentials
    RedgtechCloud-->>HomeAssistant: Authenticate and Retrieve Devices
    HomeAssistant->>User: Display Connected Redgtech Devices
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7fd2a92 and 09492d7.

📒 Files selected for processing (1)
  • source/_integrations/redgtech.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/redgtech.markdown
⏰ 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

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
source/_integrations/redgtech.markdown (1)

24-27: Make formatting consistent across steps.

The formatting of steps is inconsistent with some wrapped in asterisks and others not.

-1. *Go to **Settings** > **Devices e Services**.*
-2. *Click on **Add Integration**.*
-3. *Choose **Redgtech** from the list.*
-4. Log in with your Redgtech app credentials.
+1. Go to **Settings** > **Devices & Services**.
+2. Click on **Add Integration**.
+3. Choose **Redgtech** from the list.
+4. Log in with your Redgtech app credentials.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 419a984 and 7fd2a92.

📒 Files selected for processing (1)
  • source/_integrations/redgtech.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
🔇 Additional comments (4)
source/_integrations/redgtech.markdown (4)

7-7: Verify the release version.

The release version is set to 2025.1, which seems too far in the future. Please verify if this is the intended version or if it should be aligned with the next upcoming release.


16-18: LGTM!

The introduction clearly explains the purpose of the integration.


29-33: LGTM!

The features section is well-structured and provides clear information about the integration's capabilities.


35-41: LGTM!

The supported devices table is well-formatted and clearly presents the compatible models.

source/_integrations/redgtech.markdown Outdated Show resolved Hide resolved
source/_integrations/redgtech.markdown Outdated Show resolved Hide resolved
source/_integrations/redgtech.markdown Outdated Show resolved Hide resolved
Copy link
Author

@Jonhsady Jonhsady left a comment

Choose a reason for hiding this comment

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

Hello! This PR adds documentation for the Redgtech feature. Please review and approve it when possible. Thank you!

@c0ffeeca7 c0ffeeca7 mentioned this pull request Jan 17, 2025
8 tasks
@c0ffeeca7
Copy link
Contributor

I closed your PR #36958 as seems to be a translated duplicate of this one.
I realize it is a lot to take in for a first-time contribution. Here are a few steps that need to be done before this PR can be processed:

  1. Please fill out the PR template.
    image
    • Please fill out the relevant checkboxes, and provide the requested information.
  2. Add the link to the related core PR. If it is this one, please add it to the relevant position in the PR template.
  3. Add a link to the related PR in the Brands repository.
  4. Please rebase and point this PR against the next branch (which deals with changes that will be added in a future release). (it is now on the current branch, which changes the documentation right now)

From the developer docs on documenting
image

@c0ffeeca7 c0ffeeca7 marked this pull request as draft January 17, 2025 07:29
@c0ffeeca7
Copy link
Contributor

I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again.

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Jan 17, 2025
@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label Jan 17, 2025
@home-assistant 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 Jan 17, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@Jonhsady Jonhsady changed the base branch from current to next January 17, 2025 20:45
@home-assistant home-assistant bot removed current This PR goes into the current branch needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jan 17, 2025
@home-assistant home-assistant bot added the next This PR goes into the next branch label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.