Repository navigation
Docs: short README, and a docs tree - #15
Merged
Merged
Conversation
The README now has the index's page, one sentence, two install commands and an example with its real output. The install details, micropython-lib usage, the generated package list and how the index is built each get a page under docs/. update_package_list.py and the refresh workflow write the package list to docs/reference/packages.md instead of README.md.
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
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.
The README now shows the index's web page, says what the index is in one sentence, and gives the two install commands. It ends with an example that installs
palettesand uses it. That example was run with unix MicroPython 1.30 and the printed output (0xF800 0x07E0 0x001F) is copied verbatim.Everything else moves under
docs/:get-started/install.md: installing from a board, with mpremote, with the unix port, and from GitHubguides/install-micropython-lib-packages.md: upstream's usage notes and the terminology sectionreference/packages.md: the generated package listhow-it-works/index.md: the lockfile, the publication queue, latest-onlyBecause the generated list moved,
scripts/update_package_list.pynow defaults--readmetodocs/reference/packages.mdand the refresh workflow'sgit addnames that file.--self-checkpasses all 11 cases, and a live refresh against the deployed index leaves the page byte-identical.