Skip to content

Docs: the five-section template, with the release runbook split and re-checked - #92

Merged
bdbarnett merged 1 commit into
mainfrom
docs/template
Oct 30, 2026
Merged

bdbarnett merged 1 commit into
mainfrom
docs/template

Conversation

@bdbarnett

Copy link
Copy Markdown
Contributor

Sorts docs/ into Get started, Guides, Reference and How it works, with an index page, and re-checks each claim against the workflows and scripts it describes.

  • The 800-line publishing runbook becomes a release guide, a production-PyPI guide, a rollback guide, a failed-release guide, a workflow and tag reference, and a how-it-works page. Pin tables that rot are replaced by the command that lists them.
  • Stale parts corrected: the LVGL release now describes omnipython-lvgl's release.yml; the repository and build-kind tables match the current workflows (omnipython-audiodsp, the palettes/pdwidgets folder releases, six publishing repositories); the maintenance schedule adds the daily hero check and the weekly firmware and dev-container jobs; the GitHub map drops claims that no longer hold (wikis off org-wide, Discussions categories).
  • history.md and the two long planned-work sections leave the repository. The two plans are now ROADMAP bullets.
  • Links fixed: README, AGENTS, CONTRIBUTING, the docs-site pages that pointed at moved pydevices pages, and two code comments (comment-only; no workflow logic changed).
  • The docs-site Sphinx build runs clean with -W.

No sibling repository links to these pages.

…the workflows

The twelve docs pages become get-started, guides, reference and how-it-works
pages. The release runbook is split into a release guide, a production-PyPI
guide, a rollback guide, a failed-release guide, a workflow and tag reference
and a how-it-works page. The LVGL release, the repository table, the build
kinds, the maintenance schedule and the GitHub map now describe the current
repositories. The history and the long planned-work notes leave the repo; the
two planned items are roadmap bullets. Links into the flagship's moved pages
are fixed. Comment-only edits in two files point at the new pages.
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 pydevices | 🛠️ Build #35535938 | 📁 Comparing 75725a7 against latest (8899bec)

  🔍 Preview build  

1 file changed
± install.html

@bdbarnett
bdbarnett merged commit 9df0c14 into main Oct 30, 2026
8 checks passed
@bdbarnett
bdbarnett deleted the docs/template branch October 30, 2026 22:43
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