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-08-02 05:57:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

IQC - Improve installation parameter examples (#2474)

Browse Source 
* IQC - Improve installation parameter examples

* tweak breadcrumb style

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Klaas Schoute 2024-12-02 00:11:29 +01:00 committed by GitHub
parent b78f6127cc
commit 9dcf4c72b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/core/integration-quality-scale/rules/docs-installation-parameters.md
View File

@ -10,8 +10,21 @@ This should help the user to gather all the necessary information before startin
## Example implementation ## Example implementation
In case an integration is used via a config flow:
```markdown showLineNumbers ```markdown showLineNumbers
{% configuration_basic %} {% configuration_basic %}
Host:
description: "The IP address of your bridge. You can find it in your router or in the Integration app under **Bridge Settings** > **Local API**."
Local access token:
description: "The local access token for your bridge. You can find it in the Integration app under **Bridge Settings** > **Local API**."
{% endconfiguration_basic %}
```
In case an integration is set up via YAML in the `configuration.yaml`:
```markdown showLineNumbers
{% configuration %}
Host: Host:
description: "The IP address of your bridge. You can find it in your router or in the Integration app under **Bridge Settings** -> **Local API**." description: "The IP address of your bridge. You can find it in your router or in the Integration app under **Bridge Settings** -> **Local API**."
required: false required: false
@ -20,9 +33,9 @@ Local access token:
description: "The local access token for your bridge. You can find it in the Integration app under **Bridge Settings** -> **Local API**." description: "The local access token for your bridge. You can find it in the Integration app under **Bridge Settings** -> **Local API**."
required: false required: false
type: string type: string
{% endconfiguration_basic %} {% endconfiguration %}
``` ```
## Exceptions ## Exceptions
There are no exceptions to this rule. There are no exceptions to this rule.