Skip to content

Fix link in esp32_rmt_led_strip.mdx#6278

Merged
jesserockz merged 1 commit intoesphome:currentfrom
theomega:patch-2
Mar 24, 2026
Merged

Fix link in esp32_rmt_led_strip.mdx#6278
jesserockz merged 1 commit intoesphome:currentfrom
theomega:patch-2

Conversation

@theomega
Copy link
Copy Markdown
Contributor

Description

Fixes link in docs to h file:
https://api-docs.esphome.io/dir_e0ebe1cc7cb01fee3e19370a14ecbe57

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because 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.mdx when creating new documents for new components or cookbook.

@esphome esphome Bot added the current label Mar 13, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 13, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 018b0bf
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69b49276ca69e3000895ae53
😎 Deploy Preview https://deploy-preview-6278--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 13, 2026

Walkthrough

Documentation link reference updated in ESP32 RMT LED strip component documentation, changing the APIRef header file target from esp32_rmt_led_strip.h to led_strip.h.

Changes

Cohort / File(s) Summary
Documentation Link Update
src/content/docs/components/light/esp32_rmt_led_strip.mdx
APIRef link target changed from esp32_rmt_led_strip.h to led_strip.h.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • swoboda1337
  • kbx81
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fix link in esp32_rmt_led_strip.mdx' directly and accurately describes the main change: correcting a link in that specific documentation file.
Description check ✅ Passed The description is related to the changeset, explaining that it fixes a documentation link in the esp32_rmt_led_strip.mdx file with a reference to the correct header file location.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

You can get early access to new features in CodeRabbit.

Enable the early_access setting to enable early access features such as new models, tools, and more.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4a35bec and 018b0bf.

📒 Files selected for processing (1)
  • src/content/docs/components/light/esp32_rmt_led_strip.mdx
Comment thread src/content/docs/components/light/esp32_rmt_led_strip.mdx
@jesserockz jesserockz merged commit 170ada1 into esphome:current Mar 24, 2026
6 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 26, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

2 participants