Skip to content

boards: rename doc.txt -> doc.md for boards which name's starts from e to p #21641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Aug 4, 2025
Merged

boards: rename doc.txt -> doc.md for boards which name's starts from e to p #21641

merged 7 commits into from
Aug 4, 2025

Conversation

@krzysztof-cabaj
Copy link
Contributor

Contribution description

This PR moves doc.txt to doc.md accordingly to the guide from ISSUE #21220.

In this PR boards which name's starts from letter e to p are renamed and cleaned. After this PR, around three quarters doc files have target format.

BTW. @crasbe do you plan finalize PR #21337 soon? If you would like, I could cherry-pick two your commits which rename nucleo boards.

Testing procedure

Generate doc and check if everything looks good:

make doc
xdg-open ./doc/doxygen/html/group__boards__esp32.html
xdg-open ./doc/doxygen/html/group__boards__frdm-k64f.html 
xdg-open ./doc/doxygen/html/group__boards__mega-xplained.html 
xdg-open ./doc/doxygen/html/group__boards__pyboard.html
.  .  .

Issues/PRs references

PR #21220

@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Aug 1, 2025
@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part3 branch from d1be93a to ca53f08 Compare August 1, 2025 16:11
@crasbe crasbe added Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Aug 1, 2025
@crasbe
Copy link
Contributor

crasbe commented Aug 1, 2025

BTW. @crasbe do you plan finalize PR #21337 soon? If you would like, I could cherry-pick two your commits which rename nucleo boards.

No, please feel free to continue it :)

@riot-ci
Copy link

riot-ci commented Aug 1, 2025 •
edited
Loading

Murdock results

✔️ PASSED

dd28827 boards/nucleo64: change to doc.md format

Success Failures Total Runtime
1 0 1 01m:13s

Artifacts

@krzysztof-cabaj
Copy link
Contributor Author

@crasbe I cherry-picked two your commits with changes for nucleo boards.

We could process this PR.

crasbe
crasbe reviewed Aug 3, 2025
View reviewed changes
Copy link
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately the indentation of the commands has to be adapted, when there is the * in front, since that is only three characters and not four like the standard indentation.

@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part3 branch from 7a1213e to 38a63b8 Compare August 4, 2025 07:48
@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part3 branch from 0cf6bcb to 521bb74 Compare August 4, 2025 07:56
@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part3 branch from 1cc15a4 to dd28827 Compare August 4, 2025 08:01
@krzysztof-cabaj
Copy link
Contributor Author

@crasbe thanks for careful review.

All remarks fixed and squashed.
After all actions CI is green.

@crasbe crasbe enabled auto-merge August 4, 2025 08:38
@crasbe crasbe added this pull request to the merge queue Aug 4, 2025
Merged via the queue into RIOT-OS:master with commit a5c0bfa Aug 4, 2025
26 checks passed
@crasbe crasbe mentioned this pull request Oct 8, 2025
Merged
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crasbe crasbe crasbe approved these changes

@MrKevinWeiss MrKevinWeiss Awaiting requested review from MrKevinWeiss MrKevinWeiss is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

@leandrolanzieri leandrolanzieri Awaiting requested review from leandrolanzieri leandrolanzieri is a code owner

@basilfx basilfx Awaiting requested review from basilfx basilfx is a code owner

@gschorcht gschorcht Awaiting requested review from gschorcht gschorcht is a code owner

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

Assignees

No one assigned

Labels

Area: boards Area: Board ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@krzysztof-cabaj @crasbe @riot-ci