Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove core specific documentation from integrations #39311

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

Merged
merged 1 commit into from
Jun 1, 2025

Conversation

edenhaus
Copy link
Member

@edenhaus edenhaus commented May 29, 2025

Proposed change

Remove core specific documentation form integrations as core is not supported anymore

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

  • Link to parent pull request in the codebase:
  • 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 and streamlined integration documentation by removing or revising instructions and references specific to Home Assistant Core installations.
    • Clarified installation and troubleshooting steps for Bluetooth, USB access, and port access across various integrations.
    • Removed outdated or redundant configuration examples and platform-specific notes to improve clarity and accuracy.
    • Eliminated unsupported or deprecated setup instructions for certain integrations.

@edenhaus edenhaus added this to the 2025.6 milestone May 29, 2025
@edenhaus edenhaus requested review from a team, emlove, gjohansson-ST and hunterjm as code owners May 29, 2025 11:42
Copy link

netlify bot commented May 29, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 02d41e8
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6838480d9a07a6000863f8b5
😎 Deploy Preview https://deploy-preview-39311--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 project configuration.

@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 next This PR goes into the next branch labels May 29, 2025
@home-assistant
Copy link

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.

Copy link
Contributor

coderabbitai bot commented May 29, 2025

📝 Walkthrough

Walkthrough

This update revises documentation across several Home Assistant integration files, primarily removing or altering instructions, notes, and requirements specific to "Home Assistant Core" installations. The changes eliminate references to Home Assistant Core in installation, troubleshooting, and configuration guidance, focusing instructions on other installation methods such as OS, Supervised, and Container.

Changes

File(s) Change Summary
source/_integrations/beewi_smartclim.markdown Removed Bluetooth backend dependency installation instructions for Home Assistant Core systems.
source/_integrations/energenie_power_sockets.markdown Limited USB device access rights troubleshooting advice to Container installations only.
source/_integrations/matter.markdown Removed statement declaring Matter unsupported on Home Assistant Core.
source/_integrations/media_source.markdown Deleted incorrect statement about default media directory for Home Assistant Core users.
source/_integrations/onvif.markdown Removed note about installing libxml2/libxslt Python interfaces for Core in virtual environments.
source/_integrations/ps4.markdown Deleted "Debian-based" section on granting port access for Home Assistant Core users.
source/_integrations/sql.markdown Removed MS SQL integration instructions and configuration examples.
source/_integrations/zerproc.markdown Removed section on Bluetooth stack requirements for Core on Python environments.
source/_integrations/zwave_js.markdown Omitted "Home Assistant Core" from advanced Z-Wave JS server installation instructions.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation updates and do not introduce or modify control flow or features.


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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

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

  • @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.

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

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

23-23: Suggestion: Improve sentence formatting for consistency
Consider replacing the colon after “installation” with a comma and tightening the phrasing to match the style used elsewhere in the docs:

- If you are running a {% term "Home Assistant Container" %} installation: Depending on your system configuration, it may be necessary to grant explicit user access rights to the USB device by creating an udev rule.
+ If you are running a {% term "Home Assistant Container" %} installation, you may need to grant explicit user access rights to the USB device by creating an udev rule.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 174378f and 02d41e8.

📒 Files selected for processing (9)
  • source/_integrations/beewi_smartclim.markdown (0 hunks)
  • source/_integrations/energenie_power_sockets.markdown (1 hunks)
  • source/_integrations/matter.markdown (0 hunks)
  • source/_integrations/media_source.markdown (0 hunks)
  • source/_integrations/onvif.markdown (0 hunks)
  • source/_integrations/ps4.markdown (0 hunks)
  • source/_integrations/sql.markdown (0 hunks)
  • source/_integrations/zerproc.markdown (0 hunks)
  • source/_integrations/zwave_js.markdown (1 hunks)
💤 Files with no reviewable changes (7)
  • source/_integrations/sql.markdown
  • source/_integrations/beewi_smartclim.markdown
  • source/_integrations/zerproc.markdown
  • source/_integrations/ps4.markdown
  • source/_integrations/media_source.markdown
  • source/_integrations/onvif.markdown
  • source/_integrations/matter.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
🔇 Additional comments (1)
source/_integrations/energenie_power_sockets.markdown (1)

23-23: Removal of deprecated "Home Assistant Core" guidance
This update correctly scopes the udev rule instructions to only "Home Assistant Container" installations, aligning with the broader effort to drop unsupported Core-specific documentation.

@@ -752,7 +752,7 @@ In addition to the [standard automation trigger data](/docs/automation/templatin

## Advanced installation instructions

If you are using Home Assistant Container, Home Assistant Core, or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect.
If you are using Home Assistant Container or you don't want to use the built-in Z-Wave JS Server add-on, you will need to run the Z-Wave JS server yourself, to which the Z-Wave integration will connect.
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Remove deprecated Home Assistant Core reference
This change correctly strips out the unsupported “Home Assistant Core” mention, focusing the advanced installation guidance on Container and add-on usage as intended by the PR. Please verify there are no remaining “Home Assistant Core” references in this file.


🏁 Script executed:

#!/bin/bash
# Check for any lingering Core mentions in this doc
rg -n "Home Assistant Core" source/_integrations/zwave_js.markdown

Length of output: 264


Remove remaining “Home Assistant Core” reference

The ripgrep search found one more instance that needs updating:

  • source/_integrations/zwave_js.markdown:922
    Replace:
    …after a restart of Home Assistant Core…
    
    with:
    …after a restart of Home Assistant…
    
🤖 Prompt for AI Agents
In source/_integrations/zwave_js.markdown around line 922, update the phrase
"after a restart of Home Assistant Core" to "after a restart of Home Assistant"
to remove the deprecated "Home Assistant Core" reference and maintain
consistency with the rest of the document.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @edenhaus 👍

@c0ffeeca7 c0ffeeca7 merged commit c441f2e into next Jun 1, 2025
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the edenhaus-remove-core-specific branch June 1, 2025 05:02
@home-assistant home-assistant bot 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 Jun 1, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jun 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants