From d6a1e4e95bc23ea2371a78b5e46b37dd736b3455 Mon Sep 17 00:00:00 2001 From: Brandon Harvey <8107750+bharvey88@users.noreply.github.com> Date: Tue, 19 May 2026 18:24:35 -0500 Subject: [PATCH] docs: style-guide pass on Explaining ESPHome page (#838) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Switch the Device Builder bullet to imperative voice and drop the dangling preposition and the "for you" filler, per style guide §6 defaults and §4 banned softeners. - Lead numbered steps with an imperative verb; drop the install detail that belongs in First Steps, not in a conceptual Learn the Basics page. - Flip "It is an option, not a requirement" to a positive framing per §4 ("Excessive 'no' framing"). - Tighten "there are two ways" to a direct "you can control it two ways", and "everything" to "the device". - Add a forward link to the Device Builder Tour page so the sibling Learn the Basics flow is symmetric. Co-authored-by: Brandon Harvey --- .../learning-the-basics/explaining-esphome.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md b/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md index fa8305b7d2..2a1f1d7647 100644 --- a/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md +++ b/docs/products/ESPHome-Starter-Kit/learning-the-basics/explaining-esphome.md @@ -6,24 +6,24 @@ description: A short overview of what ESPHome is, how the Device Builder app fit ESPHome is the open-source firmware project that powers your Apollo ESPHome Starter Kit. You describe what is connected to your board (a button, a sensor, an LED) and ESPHome runs on the device, exposes those parts to Home Assistant, and accepts updates over the network. -You do not need to write any code to use it. For the Starter Kit, the **ESPHome Device Builder** app does the work for you. +You do not need to write any code to use it. For the Starter Kit, the **ESPHome Device Builder** app handles it. ## ESPHome vs Device Builder These two names get used interchangeably, but they are different pieces: - **ESPHome** is the software that runs on your device after it has been flashed. It is what makes your board talk to Home Assistant, expose its sensors and controls, and accept wireless updates. -- **ESPHome Device Builder** is the app you set everything up in. You pick the components you want (button, LED, sensor, etc.), click **Install**, and the Builder compiles the firmware and flashes it to your device for you. You can run it as a desktop app on Windows, Mac, or Linux, or install it as a Home Assistant app. +- **ESPHome Device Builder** is the app where you set everything up. Pick the components you want (button, LED, sensor, etc.), click **Install**, and the Builder compiles the firmware and flashes it to your device. Run it as a desktop app on Windows, Mac, or Linux, or install it as a Home Assistant app. For the Starter Kit, you will spend almost all your time in the Device Builder. ## Controlling your device -Once your device is flashed, there are two ways to interact with it. +Once your device is flashed, you can control it two ways: #### From any web browser -ESPHome's built-in **Web Server** component (the Starter Kit's First Steps walks you through adding it) makes your device serve its own local web page. Open `esphome-starter-kit.local` or its IP address in any browser on your network, on a phone or PC, and you can toggle the LED, view sensor readings, and control everything directly. No Home Assistant required. +ESPHome's built-in **Web Server** component (the Starter Kit's First Steps walks you through adding it) makes your device serve its own local web page. Open `esphome-starter-kit.local` or its IP address in any browser on your network, on a phone or PC, and you can toggle the LED, view sensor readings, and control the device directly. No Home Assistant required. #### From Home Assistant @@ -31,11 +31,11 @@ Home Assistant discovers your device automatically through the **ESPHome integra A typical flow looks like this: -1. In **ESPHome Device Builder**, click **Add component** and pick what is connected to your device. No code or YAML required to get started. -2. Click **Install** to flash the firmware to the device. USB the first time, then wirelessly after that. +1. Click **Add component** in **ESPHome Device Builder** and pick what is connected to your device. No code or YAML required. +2. Click **Install** to flash the firmware to the device. 3. Home Assistant picks up the device through the **ESPHome integration** and shows its sensors, buttons, and lights as entities you can control or automate. -If you ever want to fine-tune something the GUI does not expose, the YAML view is always available. It is an option, not a requirement. +If you ever want to fine-tune something the GUI does not expose, the YAML view is always available. Most users never need it. ## Why ESPHome @@ -45,4 +45,4 @@ You get wireless updates, a built-in web page for controlling your device, and d The official ESPHome documentation covers every component, configuration option, and advanced topic in detail. - Visit esphome.io + Next - Device Builder Tour Visit esphome.io