mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-11-16 14:30:28 +00:00
Add integration quality scale docs (#2457)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com> Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
a1f286224a
commit
cf52c30bc0
26
docs/core/integration-quality-scale/rules/docs-examples.md
Normal file
26
docs/core/integration-quality-scale/rules/docs-examples.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: "The documentation provides automation examples the user can use."
|
||||
---
|
||||
|
||||
## Reasoning
|
||||
|
||||
To show how the integration can be used, we should provide a limited set of blueprints, containing common or useful ones.
|
||||
This will help users to get started with the integration faster and easier.
|
||||
|
||||
The documentation pages should not be used as a collection or as a replacement of the blueprint exchange on the forums.
|
||||
|
||||
## Example implementation
|
||||
|
||||
```markdown showLineNumbers
|
||||
## Examples
|
||||
|
||||
### Turning off the LEDs during the night
|
||||
The status LEDs on the device can be quite bright.
|
||||
To tackle this, you can use this blueprint to easily automate the LEDs turning off when the sun goes down.
|
||||
|
||||
link to blueprint
|
||||
```
|
||||
|
||||
## Exceptions
|
||||
|
||||
There are no exceptions to this rule.
|
||||
Reference in New Issue
Block a user