Conversation
Wrap the existing bare Discord / Community Forum buttons in a friendlier
note admonition ("New to ESPHome? We're here to help.") and extend the
CTA to every page under the ESPHome Starter Kit product, not just the
four module pages that had the bare button row before.
The admonition lives in one shared snippet so the CTA copy and buttons
stay in sync as they evolve:
- New: `docs/_snippets/community-help.md` (single source of truth)
- 4 module pages: replace the bare Discord/Forum row with the snippet
include, keeping the existing "Try it in an automation" automation
buttons above it
- 17 other starter-kit pages (start-here, first-steps, 3 tutorials,
5 automations, 6 learning-the-basics entries, FAQ): append the snippet
include at the very bottom
Convention documented in three places following the precedent set by
the difficulty-pills PR (#920):
- `STYLE_GUIDE.md` — new section 11 "Community CTA on starter-kit pages"
(renumbers "When in doubt" to section 12)
- `CONTRIBUTING.md` — one-line bullet under Doc Standards pointing at
the new style-guide section
- `AGENTS.md` — new bullet under "High-impact rules AI tools get wrong
most often" so future AI editors don't forget the snippet on new pages
|
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 live wiki picks up #924 (community help CTA snippet rolled out across every ESPHome Starter Kit page) plus anything else that has accumulated ondev.Types of changes
mkdocs.yml)Checklist:
devbranch (notmain)mkdocs servemkdocs.ymlmkdocs.yml