Pico SDK version bump + assimilate old READMEs into RST #14621
Merged
Conversation
This file contains 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
version of the Pico SDK in their install instructions. All information in the board README.txt files are now moved into the RST files to help with the removal of the old READMEs.
github-actions
bot
added
Area: Documentation
|
This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size. |
xiaoxiang781216
approved these changes
Nov 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 changes all of the RP2040 documentation (chip and all RP2040-based boards) to use the 2.0.0 SDK version in their installation instructions. I have also moved all of the information from the boards'
README.txtfiles into theirindex.rstfiles to help with transitioning the old READMEs into the new RST format.Closes #13566, since now all pages document requirement to install picotool.
This PR comes from InSpace.
Impact
The installation instructions will now be up to date with the latest changes in the NuttX kernel which support the 2.0.0 version of the SDK. This should help avoid confusion for first time users who are using an RP2040-based board and encounter a cryptic build error because they cloned the 1.1.4 version and boot files cannot be found.
This all removes the old README.txt files and moves the relevant information into RST files like all newer documentation pages are doing.
Testing
I performed a local build of the documentation with
make htmland verified that there are no build errors. I also visually inspected each documentation page's generated HTML rendered in my browser to make sure that all formatting rendered how I expected.