Skip to content

Docs: the shared README shape, and docs/ in five sections - #14

Merged
bdbarnett merged 3 commits into
mainfrom
docs/template
Oct 27, 2026
Merged

bdbarnett merged 3 commits into
mainfrom
docs/template

Conversation

@bdbarnett

@bdbarnett bdbarnett commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

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.md is new, made from the README's run-locally and customise sections.
  • pwa-guide.md becomes guides/make-it-installable.md.
  • packages.md becomes guides/bring-in-a-bigger-app.md.
  • workers.md becomes guides/run-in-a-worker.md.
  • The repository map is now reference/files.md.
  • newcomers.md becomes how-it-works/index.md.
  • docs/README.md becomes docs/index.md.

The old page URLs stop resolving.

CONTRIBUTING.md is new. It has the tests, how to update the PyScript and PyDevices pins, the sw.js cache version, and releasing.

Claims checked against the tree:

  • audiodev is a dozen or more files, not fourteen.
  • The Dependabot comment no longer names a docs/requirements.txt that doesn't exist.
  • The sw.js comment points at the new guide.

What ran:

  • ./scripts/vendor_pyscript.sh ran.
  • python3 -m unittest discover -s tests passed all 8 tests, before and after the change.
  • main.py loaded in headless Chromium from a local server. The colour strip drew and the paint strokes rendered; the lead image is from that run.
  • The 20-line README example ran the same way: PyScript started, the display came up, and four strokes drew on the canvas.

@bdbarnett
bdbarnett merged commit 8dca164 into main Oct 27, 2026
1 check passed
@bdbarnett
bdbarnett deleted the docs/template branch October 27, 2026 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant