Add a driver installation guide and link it from the web installer - #10
Open
Ptitlouis6012 wants to merge 1 commit into
Open
Add a driver installation guide and link it from the web installer#10Ptitlouis6012 wants to merge 1 commit into
Ptitlouis6012 wants to merge 1 commit into
Conversation
Add a second info box on the web installer's Install step, shown right under the "first install wipes the board" note: "No COM port detected?" pointing to a new INSTALL_DRIVER_ESP32_S3.md, which walks through getting the ESP32-S3 to show up as a serial port on macOS, Windows and Linux. Translated into all 9 site languages.
Ptitlouis6012
force-pushed
the
docs/no-com-port-guide
branch
from
August 12, 2026 17:01
48802bf to
1abed76
Compare
Contributor
Author
|
Fixed — the guide had emoji in its section headings (macOS/Windows/Linux), which tripped the "no emoji in documentation" guard. Replaced the checkmark with the allowed U+2713 too. Force-pushed a single clean commit rebased on main. |
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 change?
Adds a new INSTALL_DRIVER_ESP32_S3.md guide (macOS / Windows / Linux) for getting the ESP32-S3 to show up as a COM/serial port, and links it from a new info box on the web installer's Install step ("No COM port detected?"), right under the existing "first install wipes the board" note. Translated into all 9 site languages.
Why?
This isn't hypothetical: users have actually run into the flasher showing no serial port at all, and manually installing the Espressif USB driver fixed it for them every time. Right now the installer page gives no hint that this is even a known, fixable problem — someone stuck on it has no obvious next step. Surfacing the guide right there, at the exact moment the "Connect and install" button would otherwise silently do nothing, should save those users the trouble of figuring it out (or giving up).
How was it tested?
Docs and web-installer assets only — no firmware code touched. Verified by serving web-installer/ locally and confirming in-browser that the new note renders in the right place, in the right style, and that the link resolves to the guide.
Checklist
bash scripts/check-codemap.shpasses — N/A,.inonot touchedbash scripts/check-i18n.shpasses — N/A, onlyweb-installer/i18n.jstouched, not the firmwarei18n.hbash scripts/update_toc.shrun — N/A, no// §N —banner touchedWORKLOG.mdupdated — N/A, WORKLOG.md is maintainer-scoped, not touched by this fork PRFor a UI change