Fix link in esp32_rmt_led_strip.mdx#6278
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughDocumentation link reference updated in ESP32 RMT LED strip component documentation, changing the APIRef header file target from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip You can get early access to new features in CodeRabbit.Enable the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/components/light/esp32_rmt_led_strip.mdx`:
- Line 96: Update the APIRef usage so the visible link label matches the
referenced header: change the APIRef text attribute from "esp32_rmt_led_strip.h"
to "led_strip.h" (or otherwise ensure it equals the last path segment), and
remove the redundant "esp32_rmt_led_strip/" prefix from the path if present so
APIRef resolves cleanly; locate the APIRef element (APIRef text="..."
path="...") and make the text equal to the final path segment "led_strip.h".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: bd1e1df2-a989-40e2-abe7-22b9d00be728
📒 Files selected for processing (1)
src/content/docs/components/light/esp32_rmt_led_strip.mdx
| - [Light Component](/components/light/) | ||
| - [Power Supply Component](/components/power_supply/) | ||
| - <APIRef text="esp32_rmt_led_strip.h" path="esp32_rmt_led_strip/esp32_rmt_led_strip.h" /> | ||
| - <APIRef text="esp32_rmt_led_strip.h" path="esp32_rmt_led_strip/led_strip.h" /> |
There was a problem hiding this comment.
Link label should match the referenced header.
On Line 96, the link text still says esp32_rmt_led_strip.h while path points to led_strip.h. This is confusing in docs. Also, the esp32_rmt_led_strip/ prefix is redundant here because APIRef resolves from the last path segment.
Suggested doc fix
-- <APIRef text="esp32_rmt_led_strip.h" path="esp32_rmt_led_strip/led_strip.h" />
+- <APIRef text="led_strip.h" path="led_strip.h" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - <APIRef text="esp32_rmt_led_strip.h" path="esp32_rmt_led_strip/led_strip.h" /> | |
| - <APIRef text="led_strip.h" path="led_strip.h" /> |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/content/docs/components/light/esp32_rmt_led_strip.mdx` at line 96, Update
the APIRef usage so the visible link label matches the referenced header: change
the APIRef text attribute from "esp32_rmt_led_strip.h" to "led_strip.h" (or
otherwise ensure it equals the last path segment), and remove the redundant
"esp32_rmt_led_strip/" prefix from the path if present so APIRef resolves
cleanly; locate the APIRef element (APIRef text="..." path="...") and make the
text equal to the final path segment "led_strip.h".
1 participant
Description
Fixes link in docs to h file:
https://api-docs.esphome.io/dir_e0ebe1cc7cb01fee3e19370a14ecbe57
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
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.