mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-11-14 21:40:22 +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
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: "The documentation describes all integration configuration options"
|
||||
---
|
||||
|
||||
## Reasoning
|
||||
|
||||
Integrations can provide an options flow to allow users to change integration configuration.
|
||||
This rule ensures that all configuration options are documented so that users can understand what each option does and how to use it.
|
||||
|
||||
## Example implementation
|
||||
|
||||
The following example is for an integration with multiple configuration options, using the `configuration_basic` tag.
|
||||
|
||||
```markdown showLineNumbers
|
||||
## Configuration options
|
||||
|
||||
The integration provides the following configuration options:
|
||||
|
||||
{% configuration_basic %}
|
||||
Country code:
|
||||
description: You can specify the country code (NL or BE) of the country to display on the camera.
|
||||
Timeframe:
|
||||
description: Minutes to look ahead for precipitation forecast sensors (minimum 5, maximum 120).
|
||||
{% end configuration_basic %}
|
||||
|
||||
```
|
||||
|
||||
## Exceptions
|
||||
|
||||
There are no exceptions to this rule.
|
||||
Reference in New Issue
Block a user