Change the doc.txt templates to doc.md and Markdown format#18
Merged
aabadie merged 2 commits intoaabadie:mainfrom Mar 3, 2025
Merged
Change the doc.txt templates to doc.md and Markdown format#18aabadie merged 2 commits intoaabadie:mainfrom
doc.txt templates to doc.md and Markdown format#18aabadie merged 2 commits intoaabadie:mainfrom
Conversation
aabadie
approved these changes
Mar 3, 2025
Contributor
Author
|
Thank you @aabadie :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In RIOT-OS/RIOT#21220 it became apparent that the current practise of using
doc.txtwith a C-style comment block that contains Doxygen/Markdown information is not ideal.The consenus was to change the
doc.txtfiles todoc.mdMarkdown files, avoiding issues with the comment block and enabling GitHub to render the files as well.This requires a change of the
riotgenas well to generate correctly formatted files.Also I updated the copyright notices to avoid
toxyelling at me when running the tests :)The required changes will be merged in the following PR in the RIOT repository:
RIOT-OS/RIOT#21255
It would be nice to update
riotgenbefore merging this PR that updates the documentation:RIOT-OS/RIOT#21257