Skip to content

boards: rename doc.txt -> doc.md for remaining boards#21644

Merged
crasbe merged 2 commits intoRIOT-OS:masterfrom
krzysztof-cabaj:boards_rename_doc_txt_part4
Aug 4, 2025
Merged

boards: rename doc.txt -> doc.md for remaining boards#21644
crasbe merged 2 commits intoRIOT-OS:masterfrom
krzysztof-cabaj:boards_rename_doc_txt_part4

Conversation

@krzysztof-cabaj
Copy link
Copy Markdown
Contributor

Contribution description

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

All remaining doc.txt files in boards directory are renamed.

In touched files I correct indentation - if I well understand, in the group definition there should be indentation of 12 chars.
I checked other files randomly ... and many have wrong indentation of 13 chars - but this is a work for a new PR, and probably
a custom script.

Testing procedure

Generate doc and check if everything looks good:

make doc
xdg-open ./doc/doxygen/html/group__boards__seeedstudio-gd32.html
xdg-open ./doc/doxygen/html/group__boards__teensy31.html
xdg-open ./doc/doxygen/html/group__boards__udoo.html
xdg-open ./doc/doxygen/html/group__boards__z1.html
.  .  .

Issues/PRs references

PR #21220

@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Aug 4, 2025
@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 4, 2025
@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part4 branch from 4b30f10 to 7a683e8 Compare August 4, 2025 15:27
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Aug 4, 2025

I think you can probably squash the four commits into one or two commits.

@crasbe crasbe changed the title boards: rename doc.txt -> doc.md for remainig boards boards: rename doc.txt -> doc.md for remaining boards Aug 4, 2025
@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt_part4 branch from 99a80a7 to d45f828 Compare August 4, 2025 16:31
@riot-ci
Copy link
Copy Markdown

riot-ci commented Aug 4, 2025

Murdock results

✔️ PASSED

d45f828 boards:rename doc.txt->doc.md for remaining boards

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

Artifacts

@krzysztof-cabaj
Copy link
Copy Markdown
Contributor Author

Fixed, squashed and Murdock is green :D

@crasbe crasbe added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Aug 4, 2025
@crasbe crasbe enabled auto-merge August 4, 2025 16:47
@crasbe crasbe added this pull request to the merge queue Aug 4, 2025
Merged via the queue into RIOT-OS:master with commit 58302ce Aug 4, 2025
27 of 28 checks passed
@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

4 participants