Skip to content

Update ZHA intro Zigbee terminology and concepts #40468

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

Draft
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

Hedda
Copy link
Contributor

@Hedda Hedda commented Aug 15, 2025

Proposed change

Update the ZHA introduction bullet points fo correct Zigbee terminology and better explaination of its concepts.

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.
  • The documentation follows the Home Assistant documentation standards.

Update the ZHA introduction bullet points fo correct Zigbee terminology and better explaination of its concepts.
@home-assistant home-assistant bot added the current This PR goes into the current branch label Aug 15, 2025
Copy link

netlify bot commented Aug 15, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 6ce979a
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/689f415650a1a70008978cdd
😎 Deploy Preview https://deploy-preview-40468--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.

Copy link
Contributor

@puddly puddly left a comment

Choose a reason for hiding this comment

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

This PR introduces lot of repetitive information. For example, this entire paragraph is verbose and explains a little too much:

Zigbee standards is a suite of low-bandwidth wireless IoT protocol that uses low-power digital radios and standardized set of communication. Throughout this documentation, Home Assistant terminology is primarly used. For some of the underlying concepts, the wording does not correspond to the terminology used in the Zigbee standards technical documentations. The bullet points below provides equivalents for some of those terms and keywords.

Let's try to keep the documentation to-the-point and explain things that users have questions about, especially things they would expect to find in the documentation for ZHA specifically. If someone has questions about what Zigbee clusters are or what the ZCL stands for, this is well outside of the scope of the user documentation for ZHA, in my opinion.

@frenck frenck marked this pull request as draft August 15, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants