From a7abce4bce9bf94c3b80c2b77fe8bd6f6eabffa2 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 28 Nov 2024 09:17:49 +0100 Subject: [PATCH] IQS: docs for supported devices: streamline title (#2475) --- .../rules/docs-supported-devices.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/core/integration-quality-scale/rules/docs-supported-devices.md b/docs/core/integration-quality-scale/rules/docs-supported-devices.md index 27b8c793..f01d5cc9 100644 --- a/docs/core/integration-quality-scale/rules/docs-supported-devices.md +++ b/docs/core/integration-quality-scale/rules/docs-supported-devices.md @@ -1,16 +1,17 @@ --- -title: "The integration documents known supported / unsupported devices" +title: "The documentation lists known supported / unsupported devices" --- ## Reasoning A lot of Home Assistant users buy devices based on if Home Assistant supports them. -To make it easier for users to find out if a device is supported, the documentation should document the known supported or unsupported devices. +To make it easier for users to find out if a device is supported, the documentation should list the known supported or unsupported devices. This will decrease the amount of bad experiences where the user finds out their device is not supported when they try to set it up. ## Example implementation ```markdown showLineNumbers + ## Supported devices The following devices are known to be supported by the integration: