Skip to content

Sync dev -> main#819

Merged
bharvey88 merged 1 commit into
mainfrom
dev
May 16, 2026
Merged

Sync dev -> main#819
bharvey88 merged 1 commit into
mainfrom
dev

Conversation

@bharvey88

Copy link
Copy Markdown
Contributor

Routine sync of dev into main to publish the latest merged docs changes, including #818 (ESPHome Starter Kit style-guide drafts for side-by-side comparison).

Side-by-side drafts of every ESPHome Starter Kit page rewritten to follow
STYLE_GUIDE.md so the user can compare them with the live versions.

- start-here-sg.md
- setup/first-steps-sg.md
- setup/getting-started-advanced-sg.md
- modules/button-module-sg.md
- modules/motion-module-sg.md
- modules/rgb-buzzer-module-sg.md
- modules/temperature-humidity-module-sg.md
- tutorials/using-secrets-sg.md

UI labels are preserved verbatim from the GUI. Mkdocs nav is intentionally
untouched, the drafts are reachable by URL only.

Style-guide changes applied:
- Removed body H1 (mkdocs uses front matter title)
- Sentence-case headings throughout, flattened H4 prerequisites to H2
- Front matter title/description normalized
- Relative .md links (../start-here.md) instead of absolute /products/... URLs
- Numbered steps reframed with lead-in + success-check pattern
- Banned softeners removed (easy/simply/just/very/easily where present)
- HA terminology fixed in getting-started-advanced (add-on -> app, Add-on Store -> App Store)
- Fixed broken inline backslash-pipe pseudo-tables in motion and rgb-buzzer
  module pages to render as real markdown tables
- Corrected copy-paste "snap the button module off the panel" lead-in on
  motion, rgb-buzzer, and temp-humidity module pages
- Descriptive image alt text on every figure
- Code fences declare a language and use title= where appropriate
- "Casita" terminology fully replaced with LED & Buzzer
@coderabbitai

coderabbitai Bot commented May 16, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)
  • beta

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6686c8cc-9b97-440c-830d-57e11bec2a12

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

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.

@bharvey88 bharvey88 merged commit 2fd7e6a into main May 16, 2026
2 checks passed
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