Repository navigation
Docs: the shared README shape, and a Read the Docs site - #176
Merged
Merged
Conversation
README leads with the one sentence, the install, a built-and-run example and its output. docs/ becomes Get started, Guides, Reference and How it works, built with Sphinx for Read the Docs. newcomers.md, esp-vision.md and firmware-release.md are split into those pages and CONTRIBUTING.md.
…fest names the new guide
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 follows the shape shared across PyDevices repositories: one sentence, the install, a desktop build with a five-line program and its output, the command for a board, and links to the docs, the gallery and the roadmap.
The docs are Markdown under
docs/: the README's Docs link opensdocs/index.mdon GitHub, where every page is listed. They also build with Sphinx throughpydevices_docs.configure.newcomers.mdis split across five sections:build_mp.py's options, the modules, and the boards and variants built.newcomers.md, with CircuitPython and esp-vision.CONTRIBUTING.mdis new. It takes the contributor map, the first contributions, and the firmware-set release steps fromfirmware-release.md. The build plan and the upstream reports leave the repository. The old page URLs stop resolving.Claims checked against the tree:
build_mp.pyinstalls, not four..mkfile, not its header.provenance.jsonholds the MicroPython pin and the checksum of every patch.What ran:
curl -fsSL https://pydevices.github.io/install.sh | shcloned the repository and printed the build lines../build_mp.py --port unix --modules pygraphicsbuilt, and the README'shello.pyprintedmicropython native_cmod Area(8, 8, 64, 40).sphinx-build -W --keep-going -b html docsexits 0.Not run here: the ESP32-P4 build command and the esp32, rp2 and Windows output quoted in "Read build warnings".
Left for a follow-up:
build_mp.py's help epilog and two comments still namedocs/newcomers.mdanddocs/build-plan.md. This PR leavesbuild_mp.pyalone.The size and timing figures in the esp-vision pages and the small-flash guide have no record in the repository and are being re-measured.