ESK-1: build out first-steps and getting-started pages#766
Conversation
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.
|
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 (2)
WalkthroughThis 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. ChangesESPHome Starter Kit Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
Summary
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.docs/products/ESPHome-Starter-Kit/setup/getting-started.mdwith 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.docs/assets/esphome-logo.svg, sourced from the canonicalesphome/esphome-docsrepo (public/images/logo.svg), used for the call-to-action button.docs/products/ESPHome-Starter-Kit/buttongettingstarted.mduntouched.mkdocs.ymlnav 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
docs/assets/esk-1-panel-callouts.png).docs/assets/esk-1-c6-board.png).Test plan
mkdocs serve./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./products/ESPHome-Starter-Kit/setup/getting-started/and confirm tables, code blocks, and admonitions all render cleanly.mkdocs.yml).Summary by CodeRabbit