Skip to content

Add anchor for automation section in documentation #5327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: current
Choose a base branch
from
Open

Add anchor for automation section in documentation #5327

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/automations/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ params:
image: auto-fix.svg
---

{{< anchor "automation" >}}

Comment on lines +10 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify shortcode syntax and inbound references resolve to #automation.

Please confirm:

  • The repo already uses the same anchor shortcode (with quotes) elsewhere.
  • All “on_xxx (Automation)” references expect .../automations/#automation (exact fragment).

You can run:

🏁 Script executed:

#!/bin/bash
# 1) Survey existing anchor shortcode usage
rg -nC2 $'{{<\\s*anchor\\b' content

# 2) Find inbound references that might need to match the new fragment
rg -nP -C2 '\(Automation\)|#automation\b|/automations/?#' content

# 3) Optional: check for accidental links to Modbus from "(Automation)" mentions
rg -nP -C2 '\(Automation\).*modbus' content

Length of output: 116075

🏁 Script executed:

#!/bin/bash
# 1) List all anchor shortcode usages across the content directory
echo "=== All anchor shortcode usages ==="
rg -nC2 '\{\{<\s*anchor' content

# 2) Detect any anchor shortcode usages without quoted name (possible missing quotes)
echo "=== Anchor usages without quotes ==="
rg -nP '\{\{<\s*anchor\s+[^"]' -n content

Length of output: 270099

Replace page-local “Automation” links with explicit /automations/#automation (or a docref/ref shortcode).

Anchor exists at content/automations/_index.md:10 ({{< anchor "automation" >}}). Many pages (e.g. files under content/components/*) use Automation which is a page-local fragment and will not resolve to the automations page — update those links to /automations/#automation or use the repo's docref/ref shortcode.

🤖 Prompt for AI Agents 
In content/automations/_index.md around lines 10-11, the anchor {{< anchor
"automation" >}} is correct but many pages link to it using page-local fragment
links like [Automation](#automation) which won't resolve across pages; update
those references (e.g., files under content/components/* and any other content
using #automation) to use an absolute path or the repo shortcode — either
/automations/#automation or the docref/ref shortcode — so cross-page links
correctly target this anchor.

Automations are a very powerful aspect of ESPHome; they allow you to easily perform actions given some condition(s).

When you want your ESPHome device to respond to its environment, you use an automation. Here are some examples:
Expand Down