Skip to content

Add Button Module - Placeholder GIFs#804

Merged
TrevorSchirmer merged 1 commit into
devfrom
ButtonModule
May 14, 2026
Merged

Add Button Module - Placeholder GIFs#804
TrevorSchirmer merged 1 commit into
devfrom
ButtonModule

Conversation

@TrevorSchirmer
Copy link
Copy Markdown
Member

@TrevorSchirmer TrevorSchirmer commented May 14, 2026

What does this implement/fix?

Adding ESPHome Starter Kit button module page

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
    • Added comprehensive button module tutorial covering setup, physical connections, configuration, and firmware testing procedures.
    • Updated documentation navigation to include the new button module guide.

Review Change Stack

@TrevorSchirmer TrevorSchirmer merged commit 65482b5 into dev May 14, 2026
1 check was pending
@TrevorSchirmer TrevorSchirmer deleted the ButtonModule branch May 14, 2026 01:27
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 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: 5f6fadc8-bc96-4a7c-b32d-7dd72ffb2409

📥 Commits

Reviewing files that changed from the base of the PR and between 2307a78 and a6dd6cd.

📒 Files selected for processing (2)
  • docs/products/ESPHome-Starter-Kit/modules/button-module.md
  • mkdocs.yml

Walkthrough

This PR adds a new tutorial for the ESPHome Starter Kit button module. It introduces documentation describing hardware setup, Device Builder configuration for the web_server component and button component, firmware flashing, and testing procedures, along with a navigation entry to expose the tutorial in the documentation site.

Changes

Button Module Tutorial

Layer / File(s) Summary
Button module tutorial content
docs/products/ESPHome-Starter-Kit/modules/button-module.md
A new tutorial page guides users through connecting the button module, configuring the web_server and button components in Device Builder, understanding the generated YAML configuration (GPIO pin, inversion, pull-up), flashing firmware, and testing button behavior in the web UI.
Documentation navigation integration
mkdocs.yml
Navigation entry added under ESPHome Starter Kit → Tutorials to expose "Adding the Button Module" tutorial.

Possibly related PRs

  • ApolloAutomation/docs#778: Prior PR that modified ESPHome Starter Kit navigation structure in mkdocs.yml and may have affected button-related documentation organization.

Poem

🐰 A button module springs to life,
With FPC cables cutting strife,
Device Builder clicks with care,
Firmware flashed through the air,
Web_server glows—button tested fair! ✨


🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ButtonModule

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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