You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: