Link the board wizard help to the new boards guide#654
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes the “I don’t know what board I have” helper in the board-selection wizard actually navigate to the new ESPHome “Understanding boards” guide, and centralizes the ESPHome docs origin into a single constant for reuse across the UI.
Changes:
- Convert the previously no-op helper control in the board wizard into an external docs link to the new boards guide.
- Introduce
ESPHOME_DOCS_BASEand rebuild existing Script/API docs fallback links from it. - Add a shared docs URL constant for the new “Understanding boards” guide.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/components/wizard/wizard-step-board.ts | Implements the “don’t know board” helper as an external docs link built from the shared docs base. |
| src/components/device/automation-editor/script-editor.ts | Builds the script docs fallback URL from ESPHOME_DOCS_BASE instead of hardcoding the origin. |
| src/components/device/automation-editor/api-action-editor.ts | Builds the API component docs URL from ESPHOME_DOCS_BASE instead of hardcoding the origin. |
| src/common/docs.ts | Adds ESPHOME_DOCS_BASE as a shared constant for constructing docs links. |
Contributor
PR Review — Link the board wizard help to the new boards guideClean, well-scoped enhancement. Merge-ready pending the companion docs PR.
Checklist
Automated review by Kōan (Claude) |
Member
Author
|
no harm in merging now the link is already missing |
Wire the "I don't know what board I have" link on the board wizard step to the new Understanding boards guide; it was a no-op button before. Add a shared ESPHOME_DOCS_BASE constant and build the api and script doc links from it too.
0807987 to
993dc61
Compare
9 tasks
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
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?
Wires the "I don't know what board I have" link on the board wizard step to the new boards guide; it was a no-op
<button>before. It now openshttps://esphome.io/guides/understanding_boards/in a new tab. While here, adds a sharedESPHOME_DOCS_BASEconstant and builds the existing api and script doc links from it too, so the docs origin lives in one place.The guide page itself is esphome/esphome.io#6744; merge that first so the link is not a 404.
Related issue or feature (if applicable):
I don't know what board I havelink #114Types of changes
bugfixnew-featureenhancementbreaking-changerefactordocsmaintenancecidependenciesChecklist
npm run lintpasses.npm run testpasses.