From 39bf8320fc319e37d6a1f81bf7fa5f0761e731bd Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Fri, 24 May 2024 17:04:36 +0200 Subject: [PATCH] Configuration troubleshooting: Add links to related topics (#32937) --- source/_docs/configuration/troubleshooting.markdown | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index f41064e550d..386e4f5c344 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -1,6 +1,10 @@ --- title: "Troubleshooting your configuration" description: "Common problems with tweaking your configuration and their solutions." +related: + - docs: /docs/configuration/ + - docs: /docs/configuration/customizing-devices/ + title: Changing entity name and ID --- It can happen that you run into trouble while configuring Home Assistant. Perhaps an integration is not showing up or is acting strangely. This page will discuss a few of the most common problems. @@ -98,6 +102,8 @@ The only characters valid in entity names are: The entity name must not start or end with an underscore. If you create an entity with other characters from the UI, Home Assistant validates the name. If you change the name directly in the YAML file, then Home Assistant may not generate an error for that entity. However, attempts to use that entity will generate errors (or possibly fail silently). +For instructions on how to change an entity name, refer to the section on [changing entity name and entity ID](/docs/configuration/customizing-devices/#changing-entity-name-and-entity-id). + ## Debug logs and diagnostics The first thing you will need before reporting an issue online is debug logs and diagnostics (if available) for the integration giving you trouble. Getting those ahead of time will ensure someone can help resolve your issue in the fastest possible manner.