Unify ZHA configuration section, include standard config_flow steps.

[kylehakala]

Proposed change

• Use the standard config_flow includes-based steps to create the Configuration section,
• Add a Configuration Requirements section just before the standard config_flow section
  • It feels helpful and important to remind users to ensure they have plugged in the hardware before adding the integration / starting setup.
• Move the "Configuration - YAML" sections to subsections of the new standard configuration section; the YAML config is mostly outlining several optional "advanced" configs that can be added via YAML (not a full YAML-based configuration).

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:
• 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
  • Enhanced the clarity of configuration guides for the Zigbee Home Automation integration.
  • Updated section headers and reorganized content for both basic and advanced configuration instructions.
  • Refined guidance to emphasize compatibility requirements and best practices for setting up radio modules.
  • Added reference to an included configuration flow document for improved user guidance.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	1f3e0d2
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67b2e35738c1be0008e054a7
😎 Deploy Preview	https://deploy-preview-37497--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 update the documentation for the Zigbee Home Automation (ZHA) integration by refining section headers and rewording instructions. The "Configuration - GUI" section has been renamed to "Configuration requirements," and the YAML-related sections have shifted to a deeper header level to improve structure. Additionally, the phrasing for connecting a radio module now explicitly emphasizes the need for compatibility and a restart before configuration.

Changes

File	Change Summary
source/_integrations/zha.markdown	- Renamed Configuration - GUI to Configuration requirements. - Updated Configuration - YAML header level from ### to ###. - Changed header levels for Advanced OTA configuration and Defining Zigbee channel to use from ### to ####. - Reworded radio module instructions to stress compatibility and the need to restart Home Assistant.

---

📜 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 2c6d15b and 1f3e0d2.

📒 Files selected for processing (1)

• source/_integrations/zha.markdown (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• source/_integrations/zha.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

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/zha.markdown (1)

248-248: Header Level Consistency for YAML Configuration
The header "Configuration - YAML" is currently at level 3 ("###"). However, based on the reorganization objectives (and as noted in the AI summary), this section should likely be demoted to level 4 (i.e. "#### Configuration - YAML") to align it as a proper subsection under the unified configuration section. Please review the hierarchy to ensure consistency throughout the document.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3282e05 and 2c6d15b.

📒 Files selected for processing (1)

• source/_integrations/zha.markdown (4 hunks)

🔇 Additional comments (4)

source/_integrations/zha.markdown (4)

145-149: New "Configuration Requirements" Section Added
The addition of the "Configuration Requirements" section is a great move to remind users to ensure their hardware is connected and operational before proceeding. Including the standard config_flow steps via {% include integrations/config_flow.md %} nicely streamlines the process. Just verify that the referenced content is current and consistent with other documentation.

---

268-268: Appropriate Hierarchy for Advanced OTA Configuration
The "Advanced OTA configuration" section is now marked with a level 4 header ("####"), which is consistent with the revised structure. The content is clearly presented and fits well within the reorganized documentation hierarchy.

---

274-274: Clear Structuring for Zigbee Channel Definition
By updating the header to "#### Defining Zigbee channel to use," the document now provides clear guidance on configuring the Zigbee channel. The inclusion of best practices and troubleshooting tips makes the section user friendly.

---

297-308: Helpful Section on Modifying Device Type
The "Modifying the device type" section offers valuable instructions on how to correct device classifications in the YAML configuration. The provided sample YAML snippet is clear. For enhanced clarity, consider adding a brief note explaining scenarios when users might need to adjust the device type.

[c0ffeeca7]

Thank you, @kylehakala 👍