Add Understanding boards in ESPHome guide#6744
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
e9420ab to
cafa2c3
Compare
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
cafa2c3 to
b69b9d7
Compare
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
b69b9d7 to
e23ce4d
Compare
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
e23ce4d to
0630add
Compare
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
0630add to
69c3d12
Compare
|
|
|
Too much diff to scan? Review this PR in Change Stack to start with the highest-impact changes. Warning Review limit reached
More reviews will be available in 3 minutes and 53 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (8)
📒 Files selected for processing (2)
WalkthroughAdds a new "Understanding Boards in ESPHome" guide and registers it in the guides index; the guide MDX includes frontmatter, Figure and image imports, sections on identifying boards, starting with generic variants, changing variants (UI/YAML), and "See Also" links. ChangesUnderstanding Boards Guide
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/guides/understanding_boards.mdx`:
- Line 103: Replace the user-facing phrase "drop down" with hyphenated
"drop-down" wherever it appears, starting with the sentence fragment "input
fields and places to type you should find a drop down that allows you to
select"; also update any related captions and alt text that use "drop down" to
maintain consistent UI terminology throughout the document
"understanding_boards.mdx".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fd31f6b2-3e3e-4040-be8d-e57ce5fec516
⛔ Files ignored due to path filters (8)
src/content/docs/guides/images/board-variants-pill-list.pngis excluded by!**/*.pngsrc/content/docs/guides/images/change-board-platform-dropdown.pngis excluded by!**/*.pngsrc/content/docs/guides/images/create-a-new-project-fig-1.pngis excluded by!**/*.pngsrc/content/docs/guides/images/generic-boards-examples.pngis excluded by!**/*.pngsrc/content/docs/guides/images/i-dont-know-what-board-i-have-fig-1.pngis excluded by!**/*.pngsrc/content/docs/guides/images/i-dont-know-what-board-i-have-fig-2.pngis excluded by!**/*.pngsrc/content/docs/guides/images/i-dont-know-what-board-i-have-fig-3.pngis excluded by!**/*.pngsrc/content/docs/guides/images/yaml-board-variant-screenshot.pngis excluded by!**/*.png
📒 Files selected for processing (2)
src/content/docs/guides/index.mdxsrc/content/docs/guides/understanding_boards.mdx
There was a problem hiding this comment.
Pull request overview
Adds a new “Understanding Boards in ESPHome” guide intended to support the ESPHome Device Builder flow (specifically the “I don't know what board I have” link), and makes it discoverable from the Guides index.
Changes:
- Added a new guide page explaining how to identify boards/variants and how to change board selection in the UI/YAML.
- Added the new guide to the Guides landing page list.
Reviewed changes
Copilot reviewed 2 out of 10 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| src/content/docs/guides/understanding_boards.mdx | New guide content with figures/screenshots and internal links for identifying/changing board variants. |
| src/content/docs/guides/index.mdx | Adds a nav entry so the new guide is discoverable from the Guides index. |
bdraco
force-pushed
the
understanding-boards-guide
branch
from
69c3d12 to
c2ba04f
Compare
|
|
bdraco
force-pushed
the
understanding-boards-guide
branch
from
c2ba04f to
24af3f7
Compare
|
|
A guide that explains how to identify your board, what to do when you do not have one yet, and how to change the board variant; linked from the guides index and from the Device Builder board wizard.
bdraco
force-pushed
the
understanding-boards-guide
branch
from
24af3f7 to
e2079cc
Compare
PR Review — Add Understanding boards in ESPHome guideClean, merge-ready documentation-only PR. No blocking issues.
Checklist
Automated review by Kōan (Claude) |
Description
Revives #6743 (closed because it was opened from the fork's protected
currentbranch) and adds the "Understanding boards in ESPHome" guide that the Device Builder's "I don't know what board I have" link points to.The original page broke the build because the eight images were imported with hyphenated identifiers that are not valid JavaScript; this imports each with a camelCase identifier matching the other guides, adds alt text to the figures for accessibility, title cases the section headings, and switches internal links to relative paths. The first commit is the original work by @Erioldoesdesign; the cleanup is layered on top. Builds clean locally and the page was verified in the browser.
Related issue (if applicable): esphome/device-builder-frontend#114 (this is the page its "I don't know what board I have" link needs)
Pull request in esphome with YAML changes (if applicable):
Checklist
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.