Skip to content

Fix ESPHome Starter Kit broken links and rename Casita to LED & Buzzer#816

Merged
bharvey88 merged 1 commit into
devfrom
fix-esk-broken-links
May 16, 2026
Merged

Fix ESPHome Starter Kit broken links and rename Casita to LED & Buzzer#816
bharvey88 merged 1 commit into
devfrom
fix-esk-broken-links

Conversation

@bharvey88
Copy link
Copy Markdown
Contributor

@bharvey88 bharvey88 commented May 16, 2026

What does this implement/fix?

Fixes several broken links and naming inconsistencies in the ESPHome Starter Kit wiki:

  • setup/first-steps.md bottom CTAs were both broken. The page lives at /setup/first-steps/, so relative ../setup/... URLs were resolving to /setup/setup/.... Additionally, button-module.md has moved from setup/ to modules/.
    • Back: ../setup/start-here/ -> ../start-here/
    • Next: ../setup/button-module/ -> ../modules/button-module/
  • tutorials/using-secrets.md had two dead links to ../setup/getting-started.md (no such file). Repointed both to ../setup/first-steps.md and updated matching prose ("Getting Started" -> "First Steps").
  • mkdocs.yml nav entry for LED & Buzzer pointed at modules/casita-module.md, which does not exist. The actual file is modules/rgb-buzzer-module.md.
  • start-here.md and setup/getting-started-advanced.md still referred to the LED & Buzzer module as "Casita". Replaced with "LED & Buzzer" so the kit overview, module page H1, and nav all agree.
  • Renamed the asset esphome-starter-kit-casita-module-only.jpg to esphome-starter-kit-rgb-buzzer-module-only.jpg and updated its reference in start-here.md.

Types of changes

  • Typo / wording fix
  • Content update (correcting outdated info, adding missing steps, clarifications)
  • New page or new product section
  • Page move / rename (redirect added in mkdocs.yml)
  • Image / screenshot update
  • Nav / structure change
  • Site config or theme change
  • CI / workflows / dependencies - Does not publish

Checklist:

  • This PR targets the dev branch (not main)
  • Changes previewed locally with mkdocs serve
  • If pages were moved or renamed, redirects were added to mkdocs.yml
  • If new pages were added, nav was updated in mkdocs.yml

Summary by CodeRabbit

  • Documentation
    • Corrected module naming throughout ESPHome Starter Kit documentation from "Casita module" to "LED & Buzzer module" with updated imagery.
    • Updated navigation links and cross-references across guides to ensure consistent references and proper navigation paths.

Review Change Stack

- 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
@bharvey88 bharvey88 merged commit b3128d9 into dev May 16, 2026
1 check was pending
@bharvey88 bharvey88 deleted the fix-esk-broken-links branch May 16, 2026 21:39
@bharvey88 bharvey88 mentioned this pull request May 16, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 40a03755-0c75-4630-8403-9170bed66e8f

📥 Commits

Reviewing files that changed from the base of the PR and between d6a8b6f and 42397be.

⛔ Files ignored due to path filters (1)
  • docs/assets/esphome-starter-kit-rgb-buzzer-module-only.jpg is excluded by !**/*.jpg
📒 Files selected for processing (5)
  • docs/products/ESPHome-Starter-Kit/setup/first-steps.md
  • docs/products/ESPHome-Starter-Kit/setup/getting-started-advanced.md
  • docs/products/ESPHome-Starter-Kit/start-here.md
  • docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
  • mkdocs.yml

Walkthrough

Documentation 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.

Changes

Module Naming and Documentation Structure Update

Layer / File(s) Summary
Module content and kit stand description
docs/products/ESPHome-Starter-Kit/start-here.md
Kit stand description now references LED & Buzzer module instead of Casita. The Casita LED and Buzzer module section is replaced with LED & Buzzer module heading and corresponding image.
Module references in setup guides
docs/products/ESPHome-Starter-Kit/setup/getting-started-advanced.md, docs/products/ESPHome-Starter-Kit/setup/first-steps.md
Getting Started Advanced guide updated to name the module as "LED & Buzzer module" with piezo buzzer and ten RGB LEDs. First Steps guide navigation buttons redirect to ../start-here/ and ../modules/button-module/.
Site navigation and tutorial cross-references
mkdocs.yml, docs/products/ESPHome-Starter-Kit/tutorials/using-secrets.md
Navigation entry in mkdocs.yml points to rgb-buzzer-module.md instead of casita-module.md. Using Secrets tutorial references "First Steps" instead of older guide name in three locations: introductory paragraph, Open Secrets section, and Wi-Fi credentials section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • ApolloAutomation/docs#782: Earlier PR that introduced the "Using secrets.yaml" tutorial page that is now being updated to reference the "First Steps" guide.

Poem

🐰 The Casita fades to history bright,
LED & Buzzer shines in proper light,
Cross-links and nav now point the way,
First Steps guides them through the day! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-esk-broken-links

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant