Fix automation links #5490
Fix automation links #5490
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This pull request fixes broken automation links throughout the ESPHome documentation. All automation references were incorrectly pointing to #automation (modbus controller) instead of the correct /automations page. This was likely introduced during the documentation restructuring.
Key changes:
- Updated all automation link references from
#automationto/automations - Fixed links across component documentation, cookbook examples, and changelog entries
Reviewed Changes
Copilot reviewed 113 out of 113 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Multiple component files | Fixed automation links in component documentation (voice_assistant, wifi, sensor, etc.) |
| Cookbook files | Corrected automation links in example configurations (lvgl, lambda_magic, infostrip) |
| Changelog | Updated automation references in version history |
WalkthroughThis PR systematically updates internal documentation links across 100+ component documentation files. All occurrences of anchor-based automation references ( Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Despite the highly repetitive nature of changes (same pattern applied uniformly), the sheer volume of 100+ affected files requires comprehensive verification to ensure consistency and completeness across all components. Each file's changes are trivial individually, but the breadth of the update demands careful cross-file review. Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (107)
⛔ Files not processed due to max files limit (6)
🧰 Additional context used📓 Path-based instructions (1)**⚙️ CodeRabbit configuration file
Files:
🪛 LanguageToolcontent/components/esp32_ble_server.md[grammar] ~44-~44: There might be a mistake here. (QB_NEW_EN) [grammar] ~45-~45: There might be a mistake here. (QB_NEW_EN) content/components/media_player/speaker.md[style] ~59-~59: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) content/components/output/sigma_delta_output.md[grammar] ~54-~54: There might be a mistake here. (QB_NEW_EN) [style] ~55-~55: To form a complete sentence, be sure to include a subject. (MISSING_IT_THERE) [grammar] ~55-~55: There might be a mistake here. (QB_NEW_EN) content/components/output/slow_pwm.md[grammar] ~37-~37: There might be a mistake here. (QB_NEW_EN) [style] ~38-~38: To form a complete sentence, be sure to include a subject. (MISSING_IT_THERE) [grammar] ~38-~38: There might be a mistake here. (QB_NEW_EN) content/components/display_menu/_index.md[grammar] ~251-~251: There might be a mistake here. (QB_NEW_EN) [grammar] ~325-~325: There might be a mistake here. (QB_NEW_EN) [grammar] ~381-~381: There might be a mistake here. (QB_NEW_EN) [grammar] ~443-~443: There might be a mistake here. (QB_NEW_EN) [grammar] ~447-~447: There might be a mistake here. (QB_NEW_EN) [grammar] ~451-~451: There might be a mistake here. (QB_NEW_EN) content/components/ezo_pmp.md[grammar] ~262-~262: There might be a mistake here. (QB_NEW_EN) [grammar] ~288-~288: There might be a mistake here. (QB_NEW_EN) [grammar] ~319-~319: There might be a mistake here. (QB_NEW_EN) content/components/servo.md[grammar] ~77-~77: There might be a mistake here. (QB_NEW_EN) content/components/binary_sensor/_index.md[grammar] ~57-~57: There might be a mistake here. (QB_NEW_EN) [grammar] ~61-~61: There might be a mistake here. (QB_NEW_EN) content/components/pipsolar.md[grammar] ~304-~304: There might be a mistake here. (QB_NEW_EN) content/components/remote_receiver.md[grammar] ~179-~179: There might be a mistake here. (QB_NEW_EN) content/changelog/v1.7.0.md[grammar] ~67-~67: There might be a mistake here. (QB_NEW_EN) content/components/key_collector.md[grammar] ~77-~77: There might be a mistake here. (QB_NEW_EN) content/components/esp32_improv.md[grammar] ~63-~63: There might be a mistake here. (QB_NEW_EN) content/components/ota/http_request.md[grammar] ~34-~34: There might be a mistake here. (QB_NEW_EN) content/components/packet_transport/_index.md[grammar] ~285-~285: There might be a mistake here. (QB_NEW_EN) content/components/safe_mode.md[grammar] ~43-~43: There might be a mistake here. (QB_NEW_EN) 🔇 Additional comments (28)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Would it be better to use |
2 participants
Description:
Fix all automation links.
Currently all links are pointing to the modubus controller. I assume this bug was introduced with the restructure of the docs
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: