Fix ESPHome Starter Kit broken links and rename Casita to LED & Buzzer#816
Conversation
- first-steps.md bottom CTAs: drop the extra `setup/` slug from both Back and Next links, and repoint Next at the new modules/ directory - using-secrets.md: repoint two dead Getting Started links at first-steps - mkdocs.yml nav: LED & Buzzer entry was pointing at a nonexistent casita-module.md; corrected to rgb-buzzer-module.md - start-here.md and getting-started-advanced.md: replace remaining Casita references with LED & Buzzer to match the module page and nav - Rename casita-module-only.jpg asset to rgb-buzzer-module-only.jpg
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (5)
WalkthroughDocumentation updates rename the ESPHome Starter Kit's Casita module to LED & Buzzer module across multiple guides and the site navigation. Kit stand descriptions, module sections, setup guide references, and tutorial cross-links are updated to reflect the new module name and point to the First Steps guide consistently. ChangesModule Naming and Documentation Structure Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
What does this implement/fix?
Fixes several broken links and naming inconsistencies in the ESPHome Starter Kit wiki:
setup/first-steps.mdbottom CTAs were both broken. The page lives at/setup/first-steps/, so relative../setup/...URLs were resolving to/setup/setup/.... Additionally,button-module.mdhas moved fromsetup/tomodules/.../setup/start-here/->../start-here/../setup/button-module/->../modules/button-module/tutorials/using-secrets.mdhad two dead links to../setup/getting-started.md(no such file). Repointed both to../setup/first-steps.mdand updated matching prose ("Getting Started" -> "First Steps").mkdocs.ymlnav entry forLED & Buzzerpointed atmodules/casita-module.md, which does not exist. The actual file ismodules/rgb-buzzer-module.md.start-here.mdandsetup/getting-started-advanced.mdstill referred to the LED & Buzzer module as "Casita". Replaced with "LED & Buzzer" so the kit overview, module page H1, and nav all agree.esphome-starter-kit-casita-module-only.jpgtoesphome-starter-kit-rgb-buzzer-module-only.jpgand updated its reference instart-here.md.Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs servemkdocs.ymlmkdocs.ymlSummary by CodeRabbit