Skip to content

boards: rename doc.txt -> doc.md for particle, Microchip, nrf ... boards #21596

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.

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

Merged
merged 5 commits into from
Jul 12, 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 designed by particle, Microchip, NRF, {blue, black}pill, and Texas Instruments
are moved.

Testing procedure

Generate doc and check if everything looks good:

make doc
xdg-open ./doc/doxygen/html/group__boards__samd10-xmini.html 
dg-open ./doc/doxygen/html/group__boards__particle-xenon.html
xdg-open ./doc/doxygen/html/group__boards__cc1350__launchpad.html 
xdg-open ./doc/doxygen/html/group__boards__nrf52840dongle.html
.  .  .

Issues/PRs references

ISSUE #21220.

@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Jul 12, 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 labels Jul 12, 2025
@crasbe crasbe added the CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs label Jul 12, 2025
@crasbe crasbe enabled auto-merge July 12, 2025 20:19
@riot-ci
Copy link

riot-ci commented Jul 12, 2025

Murdock results

✔️ PASSED

50f8982 boards: rename doc.txt -> doc.md for Microchip boards

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

Artifacts

@crasbe
Copy link
Contributor

crasbe commented Jul 12, 2025

Looks good, there are two "Empty Line at EOF" errors that the static-tests complain about. You can fixup and squash directly.

auto-merge was automatically disabled July 12, 2025 20:54

Head branch was pushed to by a user without write access

@krzysztof-cabaj krzysztof-cabaj force-pushed the boards_rename_doc_txt branch from 4d1a79d to 50f8982 Compare July 12, 2025 20:54
@krzysztof-cabaj
Copy link
Contributor Author

@crasbe thanks for rapid serving this PR.

Fixed!

@crasbe crasbe enabled auto-merge July 12, 2025 20:57
@crasbe crasbe added this pull request to the merge queue Jul 12, 2025
Merged via the queue into RIOT-OS:master with commit 41e2da1 Jul 12, 2025
25 checks passed
@crasbe
Copy link
Contributor

crasbe commented Jul 12, 2025

Thank you for your continued effort on the migration :)

@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 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