Skip to content

boards/nrf52840{dk,dongle}: add MCU table, move to doc.md#21271

Merged
mguetschow merged 1 commit intoRIOT-OS:masterfrom
Ollrogge:improve_nrf5840dk_doc
Mar 10, 2025
Merged

boards/nrf52840{dk,dongle}: add MCU table, move to doc.md#21271
mguetschow merged 1 commit intoRIOT-OS:masterfrom
Ollrogge:improve_nrf5840dk_doc

Conversation

@Ollrogge
Copy link
Copy Markdown
Member

@Ollrogge Ollrogge commented Mar 5, 2025

Contribution description

This PR adds MCU table for nrf52840dk and nrf52840-dongle. Also, it moves documentations from doc.txt do doc.md.

Testing procedure

make doc
xdg-open ./doc/doxygen/html/group__boards__nrf52840dk.html
xdg-open ./doc/doxygen/html/group__boards__nrf52840dongle.html

Issues/PRs references

#21255

@Ollrogge Ollrogge requested a review from aabadie as a code owner March 5, 2025 17:57
@github-actions github-actions bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Mar 5, 2025
@Ollrogge Ollrogge force-pushed the improve_nrf5840dk_doc branch from 43acd13 to 0ab8df9 Compare March 5, 2025 18:06
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Mar 5, 2025

Thank you for addressing this. I started an issue about the state of the nRF52 documentation here: #20592

@dylad dylad added 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 Mar 6, 2025
@Ollrogge
Copy link
Copy Markdown
Member Author

Ollrogge commented Mar 6, 2025

Thank you for addressing this. I started an issue about the state of the nRF52 documentation here: #20592

Oh nice ! Wasn't aware of this issue

mguetschow
mguetschow reviewed Mar 6, 2025
View reviewed changes
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Mar 6, 2025

Due to the issue Doxygen has with creating empty pages from the doc.md files (see #21220 (comment) ), we should wait before merging this PR until we have a solution (either update Doxygen once the new release is out or the temporary fix that kfessel proposed).

@riot-ci
Copy link
Copy Markdown

riot-ci commented Mar 6, 2025 •
edited
Loading

Murdock results

✔️ PASSED

40c7b6b boards/nrf52840{dk,dongle}: add MCU table, move to doc.md

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

Artifacts

crasbe
crasbe reviewed Mar 7, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@crasbe crasbe left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I still have some nitpicks, but nothing major.

Due to the issue Doxygen has with creating empty pages from the doc.md files (see #21220 (comment) ), we should wait before merging this PR until we have a solution (either update Doxygen once the new release is out or the temporary fix that kfessel proposed).

With #21273 merged, this does not have to wait longer.

But the comments mentioned by @mguetschow should still be removed :)

@Ollrogge Ollrogge force-pushed the improve_nrf5840dk_doc branch from 0ab8df9 to a6051d7 Compare March 10, 2025 07:52
@Ollrogge
Copy link
Copy Markdown
Member Author

Ollrogge commented Mar 10, 2025

I still have some nitpicks, but nothing major.

Due to the issue Doxygen has with creating empty pages from the doc.md files (see #21220 (comment) ), we should wait before merging this PR until we have a solution (either update Doxygen once the new release is out or the temporary fix that kfessel proposed).

With #21273 merged, this does not have to wait longer.

But the comments mentioned by @mguetschow should still be removed :)

All fixed :)

crasbe
crasbe reviewed Mar 10, 2025
View reviewed changes
Copy link
Copy Markdown
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.

I found two more small typos 😅
But after that I think this is good for merging.

A small administrative note: You don't have to change it for this PR, but it would be easier to review if the PR is split in two commits: One with the changes to the documentation and one with the move to Markdown. GitHub now just shows "old file deleted, new file with all changes added".

@Ollrogge Ollrogge force-pushed the improve_nrf5840dk_doc branch from a6051d7 to 40c7b6b Compare March 10, 2025 13:21
@mguetschow mguetschow added this pull request to the merge queue Mar 10, 2025
Merged via the queue into RIOT-OS:master with commit 4d28d7b Mar 10, 2025
26 checks passed
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Mar 10, 2025

@Ollrogge thank you for doing this PR. Improving the documentation is always very good :)

@Ollrogge
Copy link
Copy Markdown
Member Author

Ollrogge commented Mar 10, 2025

@Ollrogge thank you for doing this PR. Improving the documentation is always very good :)

Thanks for taking the time to review !

@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mguetschow mguetschow mguetschow left review comments

@crasbe crasbe crasbe approved these changes

@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

Projects

None yet

Milestone

Release 2025.04

Development

Successfully merging this pull request may close these issues.

5 participants

@Ollrogge @crasbe @riot-ci @mguetschow @dylad