jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-19 07:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added details

Browse Source 
The standards just say "use a configuration block", with zero useful information on how to do that. Fixing that ;)
This commit is contained in:
DubhAd 2018-09-08 16:36:36 +01:00 committed by GitHub
parent 27f541b52f
commit 220f6e5f0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/documentation_standards.md
View File

@ -17,9 +17,9 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
## Component and Platform Pages
* The **Configuration Variables** section must use the `{% configuration %}` tag.
* Configuration variables must document the requirement status.
* Configuration variables must document the requirement status (`false` or `true`)
* Configuration variables must document the default value, if any.
* Configuration variables must document the accepted value types.
* Configuration variables must document the accepted value types (`string`, `boolean`, `integer`, `list`)
* For configuration variables that accept multiple types, separate the types with a comma (i.e. `string, int`).
* Use YAML sequence syntax in the sample code if it is supported.
* All examples should be formatted to be included in `configuration.yaml` unless explicitly stated.
@ -27,6 +27,18 @@ To ensure that the documentation for Home Assistant is consistent and easy to fo
* If you know that the API key or value contains [control characters](https://en.wikipedia.org/wiki/YAML#Syntax), e.g., `#`, `[`, `?`, etc., wrap it in quotes and add a note.
* Component and platform names should be a link to their respective documentation pages.
Example configuration block
```yaml
{% configuration %}
some_key:
description: This is a description of what this key is for.
required: false
type: string, list
default: Optional default value - leave out if there isn't one
{% endconfiguration %}
```
## Templates
* All examples containing Jinja2 templates should be wrapped **outside** of the code markdown with the `{% raw %}` tag.