ports: Rename stray board readme/README files to board.md. - #19660
Open
dpgeorge wants to merge 1 commit into
Open
ports: Rename stray board readme/README files to board.md.#19660dpgeorge wants to merge 1 commit into
dpgeorge wants to merge 1 commit into
Conversation
Using `board.md` is the standard (and only) way to add information about a board to the top of its download page. The `board.md` file is processed by `tools/autobuild/build-downloads.py`. A lot of boards already use this facility, but some had stray markdown files named `readme.md` and `README.md`. Rename those files to `board.md` so their contents appears on the board download page. Signed-off-by: Damien George <damien@micropython.org>
|
Code size report: |
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
1 participant
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
Using
board.mdis the standard (and only) way to add information about a board to the top of its download page. Theboard.mdfile is processed bytools/autobuild/build-downloads.py.A lot of boards already use this facility, but some had stray markdown files named
readme.mdandREADME.md. Rename those files toboard.mdso their contents appears on the board download page.Testing
Ran
./tools/autobuild/build-downloads.py . ./boardsand inspected the output of the boards changed in this PR, both before and after this change. After the change the relevant info is added to the board markdown file.Trade-offs and Alternatives
This info already exists for these boards so may as well make it available on the download page, instead of users needing to discover it by searching the repo source.
Generative AI
I did not use generative AI tools when creating this PR.