Skip to content

ESK-1: build out first-steps and getting-started pages#766

Merged
bharvey88 merged 1 commit into
devfrom
esk1-first-steps-getting-started
May 5, 2026
Merged

ESK-1: build out first-steps and getting-started pages#766
bharvey88 merged 1 commit into
devfrom
esk1-first-steps-getting-started

Conversation

@bharvey88
Copy link
Copy Markdown
Contributor

@bharvey88 bharvey88 commented May 5, 2026

Summary

  • Replaces placeholder content on docs/products/ESPHome-Starter-Kit/first-steps.md (QR landing page) with a real welcome, kit overview, and snap-apart instructions, ending with a branded ESPHome-logo button that links forward to the getting-started page.
  • Replaces the 5-line stub in docs/products/ESPHome-Starter-Kit/setup/getting-started.md with a full walkthrough: physical setup of the ESP32-C6, installing the ESPHome Device Builder add-on, writing the device YAML section by section, and adding it to Home Assistant.
  • Adds docs/assets/esphome-logo.svg, sourced from the canonical esphome/esphome-docs repo (public/images/logo.svg), used for the call-to-action button.
  • Leaves docs/products/ESPHome-Starter-Kit/buttongettingstarted.md untouched.
  • Does not add either page to mkdocs.yml nav yet, so they remain reachable only via direct URL / QR code until we're ready to publish.

TODOs left in the pages for follow-up

  • Panel callout photo for first-steps.md (docs/assets/esk-1-panel-callouts.png).
  • ESP32-C6 board photo for getting-started.md (docs/assets/esk-1-c6-board.png).
  • Confirm the full module list once Trevor signs off.
  • Confirm GPIO9 is the right pin for the kit's button module.
  • Confirm which module is the recommended "first project" in the walkthrough.

Test plan

  • Pull the branch locally and run mkdocs serve.
  • Visit /products/ESPHome-Starter-Kit/first-steps/ and confirm the ESPHome-logo button renders with the icon and the link goes to the getting-started page.
  • Visit /products/ESPHome-Starter-Kit/setup/getting-started/ and confirm tables, code blocks, and admonitions all render cleanly.
  • Confirm neither page shows up in the left nav (we did not edit mkdocs.yml).

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive first-steps guide for the ESPHome Starter Kit with learning outcomes, module overview, and assembly instructions.
    • Expanded the Getting Started guide with detailed hardware setup, software installation, Wi-Fi configuration, and device scaffolding instructions.

Replace placeholder content on the ESPHome Starter Kit landing page and
its getting-started walkthrough. Adds the canonical ESPHome logo
(sourced from esphome/esphome-docs) so the first-steps page can render a
branded call-to-action button linking forward to the build guide.

Pages are not added to the mkdocs.yml nav yet, they remain reachable
only via direct URL/QR until ready to publish.
@bharvey88 bharvey88 merged commit 8894e7c into dev May 5, 2026
1 check was pending
@bharvey88 bharvey88 deleted the esk1-first-steps-getting-started branch May 5, 2026 20:07
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 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: b190e9af-a1a9-4832-97be-50e1d2711b3b

📥 Commits

Reviewing files that changed from the base of the PR and between 792e0cc and c414844.

⛔ Files ignored due to path filters (1)
  • docs/assets/esphome-logo.svg is excluded by !**/*.svg
📒 Files selected for processing (2)
  • docs/products/ESPHome-Starter-Kit/first-steps.md
  • docs/products/ESPHome-Starter-Kit/setup/getting-started.md

Walkthrough

This PR replaces placeholder documentation with two comprehensive guides for the ESPHome Starter Kit. The first-steps guide introduces the kit, learning outcomes, module composition, and separation instructions. The getting-started guide provides detailed step-by-step setup, configuration, and flashing procedures for integrating the ESP32-C6 board with Home Assistant via ESPHome.

Changes

ESPHome Starter Kit Documentation

Layer / File(s) Summary
First-steps guide
docs/products/ESPHome-Starter-Kit/first-steps.md
Welcome introduction, learning outcomes checklist, kit contents overview, panel image callout, step-by-step module separation instructions with safety warning, module descriptions, and navigation button to Getting Started.
Getting-started guide
docs/products/ESPHome-Starter-Kit/setup/getting-started.md
Hardware setup section (board identification, module connection, USB-C plugging), ESPHome Device Builder installation and configuration (secrets.yaml, device creation), complete YAML configuration examples (substitutions, esphome config, esp32 target, HA API, Wi-Fi, logger, sensors), flashing and Home Assistant discovery instructions, success callout, and next steps links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes


🐰 A kit awaits, with panels to snap,
And modules bright—no soldering mishap!
From first step bold to Home Assistant's embrace,
New guides now light the ESPHome space!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch esk1-first-steps-getting-started

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.

2 participants