doc/guides: add STM32 Flashing Guide #21767
Merged
Conversation
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
crasbe
added
the
Type: enhancement
crasbe
added
State: WIP
AnnsAnns
requested changes
Oct 8, 2025
|
RE:
A greater migration of board doc.md related stuff will (someday) be done automagically. That's currently our little Hack'n Ack project with no ETA. (Also I appreciate the offer for procrastination projects 😛 ) |
AnnsAnns
reviewed
Oct 8, 2025
AnnsAnns
approved these changes
Oct 8, 2025
14 tasks
crasbe
force-pushed
the
pr/guide_stm32_flashing
branch
from
d287866 to
0c9c643
Compare
crasbe
removed
the
State: WIP
This was referenced Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Contribution description
Currently the STM32 boards have a varying degree of documentation about the flashing process. This PR aims to create a guide to unify that information.
I'm not sure yet whether I want to do the migration of the
doc.mdfiles in this PR or in a separate one.Perhaps @AnnsAnns is looking for a Braindead Procrastination Project 👀
Then I can migrate one board as an example and the rest follows the same scheme.
Open discussion points: should this get a dedicated sidebar entry as I did right now?
Also: Apparently the folder names are a bit inconsistent. Sometimes it's
advanced_tutorialsand sometimes it'sbuild-system.Testing procedure
Run
make doc-starlightand look at the generated documentation.Issues/PRs references
Picks up the work from #21337.