From 9dcf4c72b777726d883f1fcad06b55f927b5550f Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 2 Dec 2024 00:11:29 +0100 Subject: [PATCH] IQC - Improve installation parameter examples (#2474) * IQC - Improve installation parameter examples * tweak breadcrumb style --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- .../rules/docs-installation-parameters.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/core/integration-quality-scale/rules/docs-installation-parameters.md b/docs/core/integration-quality-scale/rules/docs-installation-parameters.md index c5511dba..2b243629 100644 --- a/docs/core/integration-quality-scale/rules/docs-installation-parameters.md +++ b/docs/core/integration-quality-scale/rules/docs-installation-parameters.md @@ -10,8 +10,21 @@ This should help the user to gather all the necessary information before startin ## Example implementation +In case an integration is used via a config flow: + ```markdown showLineNumbers {% 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: 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 @@ -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**." required: false type: string -{% endconfiguration_basic %} +{% endconfiguration %} ``` ## Exceptions -There are no exceptions to this rule. \ No newline at end of file +There are no exceptions to this rule.