Repository navigation
Docs: the shared README shape, and docs/ in five sections - #14
Merged
Merged
Conversation
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 every PyDevices repository shares: a picture of the app, one sentence, the commands to serve it, a 20-line paint app, and links to the docs, examples and roadmap.
The docs move into five sections as plain Markdown, read on GitHub:
docs/get-started/index.mdis new, made from the README's run-locally and customise sections.pwa-guide.mdbecomesguides/make-it-installable.md.packages.mdbecomesguides/bring-in-a-bigger-app.md.workers.mdbecomesguides/run-in-a-worker.md.reference/files.md.newcomers.mdbecomeshow-it-works/index.md.docs/README.mdbecomesdocs/index.md.The old page URLs stop resolving.
CONTRIBUTING.mdis new. It has the tests, how to update the PyScript and PyDevices pins, thesw.jscache version, and releasing.Claims checked against the tree:
audiodevis a dozen or more files, not fourteen.docs/requirements.txtthat doesn't exist.sw.jscomment points at the new guide.What ran:
./scripts/vendor_pyscript.shran.python3 -m unittest discover -s testspassed all 8 tests, before and after the change.main.pyloaded in headless Chromium from a local server. The colour strip drew and the paint strokes rendered; the lead image is from that run.