Documentation: Migrate README.txt to RST#18658
Merged
Merged
Conversation
linguini1
requested changes
Mar 31, 2026
Contributor
linguini1
left a comment
linguini1
left a comment
There was a problem hiding this comment.
Looks good to me! Please split the migrations so each one is a commit; makes it easier to keep track of changes that way.
PiyushPatle26
force-pushed
the
migrate-readmes
branch
from
33ff53f to
0509441
Compare
Contributor
Author
|
@linguini1 Done! |
Contributor
|
Please run the checkpatch.sh script locally to make sure everything will pass CI. The workflow is described here: https://nuttx.apache.org/docs/latest/contributing/making-changes.html |
github-actions
Bot
added
Area: Documentation
Contributor
Author
|
@linguini1 Thank you for the review. I’ve run the checkpatch.sh script locally and confirmed that everything passes. Please let me know if there’s anything further I should address. |
xiaoxiang781216
approved these changes
Apr 1, 2026
linguini1
approved these changes
Apr 1, 2026
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
3 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.
Summary
This PR migrates several of the README.txt files mentioned in #11077 to RST format. Each migrated README has its own commit.
Impact
This is part of the documentation unification initiative from #9094 . It allows users to browse documentation in the better-formatted RST markup instead of using legacy README.txt files.
Testing
Used make autobuild locally to verify documentation builds and looks correct in the browser while making this changes.