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

Update documentation to HA guidelines #414

Open
WebSpider opened this issue Dec 6, 2024 · 0 comments
Open

Update documentation to HA guidelines #414

WebSpider opened this issue Dec 6, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@WebSpider
Copy link
Contributor

As part of the 2024.12 release, HomeAssistant has released new quality guidelines at https://www.home-assistant.io/docs/quality_scale/

Since we are looking to be a well-behaved (custom) integration, we should try and bring the documentation standard to the gold level. How we do this, we can discuss in this issue.

🥉 Offers basic end-user documentation that is enough to get users started step-by-step easily.

🥈 The documentation for these integrations provides information on what is available in Home Assistant when this integration is used, as well as troubleshooting information when issues occur.
Offers detailed documentation of what the integration provides and instructions for troubleshooting issues.

🥇 The documentation for these integrations is extensive, and primarily aimed toward end-users and understandable by non-technical consumers. Besides providing general information on the integration, the documentation provides possible example use cases, a list of compatible devices, a list of described entities the integration provides, and extensive descriptions and usage examples of available actions provided by the integration. The use of example automations, dashboards, available Blueprints, and links to additional external resources, is highly encouraged as well.
Extensive documentation, aimed at non-technical users.

@WebSpider WebSpider added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 6, 2024
@WebSpider WebSpider changed the title Update documentation to HA silver guidelines Update documentation to HA guidelines Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant