Repository navigation
docs(guides): first setup and updates - #417
Merged
Merged
Conversation
A new guide, First Setup & Updates (#380), after Flashing Firmware: - which release file goes on which board for the first flash, and how (ST-Link, drag and drop onto RPI-RP2, `pio run -t bootstrap`); - checking the Gateway in SkyHawkClient, and updating it there, USB side first (a hand-made SVG of the update order); - the other boards by ST-Link for now; moving a board to another node number by flashing that node's firmware; - red and green together: "Needs firmware" and "Won't start", Retry then the reset button on the board being updated, and the power-cut recipe. Client board updates (SkyHawkClient#175/#176/#177) are left out until they land. Linked from Flashing Firmware, the guides index and the client page. The last "PanelBridge chip" mentions (flashing, bring-up) become "the Gateway's cockpit side", and bootloader.md says "Won't start" for an unstable board. Part of #380.
This was referenced Nov 10, 2026
The crash-loop count survives an ST-Link flash and its reset; only a bus commit, GO or a power cycle clears it. Say so on the first-setup page and in FirmwarePlan § Recovery.
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.
Third PR for #380 (deliverable 2): the public first-setup page.
New page:
docs/guides/first-setup.md, "First Setup & Updates"It sits in the Build Guides nav after Flashing Firmware. It covers only what works today; client board updates (SkyHawkClient#175/#176/#177) are held for follow-ups.
Firmware/Examples/PanelGroupSample/.-full.hex;RPI-RP2, BOOTSEL only if the drive never appears;-full.hex;pio run -t bootstrap..elf, orpio run -t upload, both of which keep the bootloader). To move a board to another node number, flash that node's firmware by ST-Link.The client labels were checked against SkyHawkClient
mainbd8e53e(after #201): the Cockpit tab, Firmware · n, Update / Retry, MANUAL UPDATE ONLY, the usb-first redirect, and the relay check. The shipped client uses the same Retry + reset-button wording.Other pages
flashing.md: a link to the new page.:32"the Gateway's PanelBridge chip" becomes "the Gateway's cockpit side".guides/index.md: a "Start here" entry.getting-started/client-app.md: a one-sentence pointer.bring-up.md:76: "PanelBridge chip" becomes "cockpit side".bootloader.md:20: the unstable board is now "Won't start" in SkyHawkClient (the LED description is kept).:88: "won't start it" becomes "treats it as no firmware at all", so it doesn't read like the new label.mkdocs.yml: the nav entry.Firmware/ScratchPad/FirmwarePlan/12-bootloader.md§ Recovery: the same ST-Link Won't start line.docs/assets/images/diagrams/update-order.svg: new. It goes with the repo's other diagrams rather than indocs/guides/.Checks
tools/docs-drift/check_doc_refs.py: OK (43 citations, 80 pages).mkdocs build -f docs/mkdocs.yml: exit 0. The only warning is the pre-existing mkdoxydocs/apianchor one./OpenSkyhawk/: the page, the table, the SVG and every link render.Part of #380. Board updates from the client come in follow-up PRs as SkyHawkClient#175, #176 and #177 land.