Conversation
* Shorten Learn the Basics sidebar headings Trim the within-page H2s on Explaining ESPHome and What is YAML? so the left sidebar entries don't wrap or feel unwieldy. - ESPHome vs ESPHome Device Builder -> ESPHome vs Device Builder - How you talk to your device -> Controlling your device - Why the Starter Kit is built on ESPHome -> Why ESPHome - What this looks like in ESPHome -> ESPHome example * Reword surfaces and promote Spacing matters to its own section Customer feedback flagged 'surfaces' as jargon and asked for stronger coverage of YAML spacing rules. - Replace 'This surfaces your device's sensors, switches, and lights as entities' with a plainer 'Each of your device's sensors, switches, and lights then appears in Home Assistant as an entity' - New 'Spacing matters' H2 with the three core rules (no tabs, consistent indent, space after colon) and a correct vs broken example - Trim the 'Indentation groups things together' H4 lead-in now that the spaces vs tabs detail lives in the new section - Remove the 'Common gotchas' H4, now fully covered by Spacing matters * Add backup-before-editing tip to Spacing matters Customer feedback suggested adding advice to copy the existing YAML into a notepad before hand-editing, as a safety net if a bad indent breaks the build. Lands at the end of Spacing matters where the failure mode just got explained. * Drop Back to First Steps button from Learn the Basics pages These pages can be reached from anywhere in the sidebar or via inbound links, so a Back to First Steps button at the bottom assumes a path that may not exist. The remaining buttons are the external resource and cross-link CTAs.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (1)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this implement/fix?
Routine sync of
devintomainso the wiki rebuilds and publishes the changes from #823.Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs servemkdocs.ymlmkdocs.yml