Skip to content

cpu/esp*: migrate doc files to Markdown files *.md #21589

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 6 commits into from
Jul 10, 2025
Merged

cpu/esp*: migrate doc files to Markdown files *.md #21589

merged 6 commits into from
Jul 10, 2025

Conversation

gschorcht
Copy link
Contributor

Contribution description

This PR migrates the documentation for ESP SoCs to Markdown files *.md

Testing procedure

Generation of documentation should still work.

Issues/PRs references

@github-actions github-actions bot added Area: doc Area: Documentation Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: cpu Area: CPU/MCU ports labels Jul 9, 2025
@gschorcht gschorcht changed the title cpu/esp*: migrate doc files to Markdown files *.md cpu/esp*: rename doc files *.txt to Markdown files *.md Jul 9, 2025
@crasbe
Copy link
Contributor

crasbe commented Jul 9, 2025

I can't add review comments to individual lines, but you'll have to remove the C-comment blocks and change the comment type of the Copyright notice has to be changed to the HTML comment.

Currently it looks like this:

image

@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 Jul 9, 2025
@gschorcht gschorcht added State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet and removed 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 Jul 9, 2025
@crasbe
Copy link
Contributor

crasbe commented Jul 9, 2025 •
edited
Loading

I have some migration hints in the according issue: #21220

Edit: maybe I should add a note about the copyright notice. 🤔

@gschorcht
Copy link
Contributor Author

gschorcht commented Jul 9, 2025 •
edited
Loading

@crasbe Sorry, I pushed it too fast 😎

@gschorcht gschorcht changed the title cpu/esp*: rename doc files *.txt to Markdown files *.md cpu/esp*: migrate doc files to Markdown files *.md Jul 9, 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 9, 2025
@gschorcht gschorcht added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jul 9, 2025
@gschorcht
Copy link
Contributor Author

@crasbe Wow, thanks for the fast approval.

@crasbe
Copy link
Contributor

crasbe commented Jul 9, 2025

You're welcome :)
The changes are quite easy to check :D

@riot-ci
Copy link

riot-ci commented Jul 9, 2025

Murdock results

✔️ PASSED

68ef117 cpu/esp32: migrate doc*.md to Markdown

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

Artifacts

@crasbe
Copy link
Contributor

crasbe commented Jul 9, 2025

Is this still WIP? Otherwise you're good to merge.

@gschorcht gschorcht removed the State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet label Jul 9, 2025
@gschorcht
Copy link
Contributor Author

Is this still WIP? Otherwise you're good to merge.

No, thanks. I removed it.

@crasbe crasbe added this pull request to the merge queue Jul 9, 2025
Merged via the queue into RIOT-OS:master with commit 82ef55f Jul 10, 2025
29 checks passed
@gschorcht
Copy link
Contributor Author

@crasbe Thanks for reviewing and merging.

@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 2025
@gschorcht gschorcht deleted the cpu/esp_doc_md branch July 30, 2025 13:22
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

Assignees
No one assigned
Labels
Area: cpu Area: CPU/MCU 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 Platform: ESP Platform: This PR/issue effects ESP-based platforms Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Milestone
Release 2025.07
Development

Successfully merging this pull request may close these issues.
4 participants
@gschorcht @crasbe @riot-ci @Teufelchen1