From 2812f5b684298b9886a637bf4c4681ff242fdb7b Mon Sep 17 00:00:00 2001 From: Brad Barnett <127794626+bdbarnett@users.noreply.github.com> Date: Tue, 27 Oct 2026 02:58:35 -0500 Subject: [PATCH 1/2] Point moved docs links at their new homes The USB guide is now docs/guides/usb.md in pydevices, lvgl-bindings' release notes are in its CONTRIBUTING.md, and palettes, pygraphics and pdwidgets serve their manuals from their own Read the Docs projects. --- AGENTS.md | 2 +- data/repos_db.json | 4 ++-- docs-site/index.md | 6 +++--- docs-site/newcomers.md | 6 +++--- docs-site/projects/palettes.md | 2 +- docs-site/projects/pdwidgets.md | 2 +- docs-site/projects/pygraphics.md | 2 +- profile/README.md | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 9e0018f..e97a19c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -128,5 +128,5 @@ at the workspace root — the single home for this rule. - [micropython-pydevices](https://github.com/PyDevices/micropython-pydevices) — presets, variants, boards and the patch series the builds use -- [lvgl-bindings releasing-bindings.md](https://github.com/PyDevices/lvgl-bindings/blob/main/docs/releasing-bindings.md) — +- [lvgl-bindings CONTRIBUTING.md, Releasing](https://github.com/PyDevices/lvgl-bindings/blob/main/CONTRIBUTING.md#releasing) — binding regeneration and `lvgl-python` release dispatch diff --git a/data/repos_db.json b/data/repos_db.json index 55bcd4e..9a8ccb5 100644 --- a/data/repos_db.json +++ b/data/repos_db.json @@ -35,7 +35,7 @@ "displayif": "now [`modules/displayif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/displayif) in micropython-pydevices. The old repository is archived.", "audioif": "now [`modules/audioif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/audioif) in micropython-pydevices. The old repository is archived.", "cameraif": "now [`modules/cameraif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/cameraif) in micropython-pydevices. The old repository is archived.", - "usbif": "the C module is now [`modules/usbhost`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/usbhost) in micropython-pydevices; the Python USB packages are in [pydevices](https://github.com/PyDevices/pydevices/blob/main/docs/usb.md). The old repository is archived." + "usbif": "the C module is now [`modules/usbhost`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/usbhost) in micropython-pydevices; the Python USB packages are in [pydevices](https://github.com/PyDevices/pydevices/blob/main/docs/guides/usb.md). The old repository is archived." } }, "pydevices": { @@ -236,7 +236,7 @@ }, { "label": "USB packages in pydevices", - "href": "https://github.com/PyDevices/pydevices/blob/main/docs/usb.md", + "href": "https://github.com/PyDevices/pydevices/blob/main/docs/guides/usb.md", "tier_color": true }, { diff --git a/docs-site/index.md b/docs-site/index.md index 303defe..00cabd1 100644 --- a/docs-site/index.md +++ b/docs-site/index.md @@ -30,20 +30,20 @@ you to any of them. If you are new, start with the :gutter: 3 :::{grid-item-card} palettes -:link: https://pydevices.readthedocs.io/projects/palettes/en/latest/ +:link: https://palettes.readthedocs.io/ :link-type: url Color palettes: an HSV wheel, RGB cubes, Material Design swatches and RGB565 helpers. ::: :::{grid-item-card} pygraphics -:link: https://pydevices.readthedocs.io/projects/pygraphics/en/latest/ +:link: https://pygraphics.readthedocs.io/ :link-type: url 2D drawing, bitmap fonts and blitting, in C and in Python. ::: :::{grid-item-card} pdwidgets -:link: https://pydevices.readthedocs.io/projects/pdwidgets/en/latest/ +:link: https://pdwidgets.readthedocs.io/ :link-type: url Buttons, sliders, labels and screens for touch displays, in pure Python. ::: diff --git a/docs-site/newcomers.md b/docs-site/newcomers.md index 017f255..be30e82 100644 --- a/docs-site/newcomers.md +++ b/docs-site/newcomers.md @@ -20,9 +20,9 @@ opens and your program draws into it, which is the quickest way to try an idea. Most programs use three libraries stacked on the display: -- [pygraphics](https://pydevices.readthedocs.io/projects/pygraphics/en/latest/) draws: lines, shapes, text and images. -- [palettes](https://pydevices.readthedocs.io/projects/palettes/en/latest/) supplies colors in the format the display wants. -- [pdwidgets](https://pydevices.readthedocs.io/projects/pdwidgets/en/latest/) builds a user interface out of buttons, sliders and labels, and routes touch and keys to them. +- [pygraphics](https://pygraphics.readthedocs.io/) draws: lines, shapes, text and images. +- [palettes](https://palettes.readthedocs.io/) supplies colors in the format the display wants. +- [pdwidgets](https://pdwidgets.readthedocs.io/) builds a user interface out of buttons, sliders and labels, and routes touch and keys to them. Each project's manual has its own newcomer's guide. diff --git a/docs-site/projects/palettes.md b/docs-site/projects/palettes.md index 0ec38ec..f4e4148 100644 --- a/docs-site/projects/palettes.md +++ b/docs-site/projects/palettes.md @@ -2,4 +2,4 @@ Color for displays: RGB565 and RGB888 output, an HSV color wheel, RGB color cubes, Material Design swatches and Win16 color names, with byte swapping for panels that want it. Pure Python with no C part. -[Read the palettes manual](https://pydevices.readthedocs.io/projects/palettes/en/latest/). +[Read the palettes manual](https://palettes.readthedocs.io/). diff --git a/docs-site/projects/pdwidgets.md b/docs-site/projects/pdwidgets.md index 9a88972..e95e0cd 100644 --- a/docs-site/projects/pdwidgets.md +++ b/docs-site/projects/pdwidgets.md @@ -2,4 +2,4 @@ A lightweight widget toolkit in pure Python: buttons, sliders, progress bars, labels, screens, themes and event routing for touch, mouse, keys and encoders. It redraws only what changed. -[Read the pdwidgets manual](https://pydevices.readthedocs.io/projects/pdwidgets/en/latest/). +[Read the pdwidgets manual](https://pdwidgets.readthedocs.io/). diff --git a/docs-site/projects/pygraphics.md b/docs-site/projects/pygraphics.md index 48e3eff..8de3f70 100644 --- a/docs-site/projects/pygraphics.md +++ b/docs-site/projects/pygraphics.md @@ -2,4 +2,4 @@ Drawing primitives, bitmap font rendering, paletted surface blitting and dirty-area tracking. The core is C for speed on a microcontroller, with a pure-Python version that behaves the same, so a program draws the same on a board, a desktop and a browser tab. -[Read the pygraphics manual](https://pydevices.readthedocs.io/projects/pygraphics/en/latest/). +[Read the pygraphics manual](https://pygraphics.readthedocs.io/). diff --git a/profile/README.md b/profile/README.md index 696ee01..13d0526 100644 --- a/profile/README.md +++ b/profile/README.md @@ -66,7 +66,7 @@ MIP package indexing, multi-usermod builds, and serial/FTP IDE extensions. - **displayif** — now [`modules/displayif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/displayif) in micropython-pydevices. The old repository is archived. - **audioif** — now [`modules/audioif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/audioif) in micropython-pydevices. The old repository is archived. - **cameraif** — now [`modules/cameraif`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/cameraif) in micropython-pydevices. The old repository is archived. -- **usbif** — the C module is now [`modules/usbhost`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/usbhost) in micropython-pydevices; the Python USB packages are in [pydevices](https://github.com/PyDevices/pydevices/blob/main/docs/usb.md). The old repository is archived. +- **usbif** — the C module is now [`modules/usbhost`](https://github.com/PyDevices/micropython-pydevices/tree/main/modules/usbhost) in micropython-pydevices; the Python USB packages are in [pydevices](https://github.com/PyDevices/pydevices/blob/main/docs/guides/usb.md). The old repository is archived. **Deliberately absent from this map:** From 0289e1dd75c7627aac82c166b6174758ed07b6ba Mon Sep 17 00:00:00 2001 From: Brad Barnett <127794626+bdbarnett@users.noreply.github.com> Date: Tue, 27 Oct 2026 03:04:38 -0500 Subject: [PATCH 2/2] repos_db: every docs link points at the page's new home Nine project-page links went to pages the repos moved in their docs restructure (newcomers.md, user-guide.md, agent-guide.md, audio.md, board-bringup.md and others). Each new target returns 200. --- data/repos_db.json | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/data/repos_db.json b/data/repos_db.json index 9a8ccb5..055e997 100644 --- a/data/repos_db.json +++ b/data/repos_db.json @@ -165,7 +165,7 @@ }, { "label": "Audio in pydevices", - "href": "https://github.com/PyDevices/pydevices/blob/main/docs/audio.md", + "href": "https://github.com/PyDevices/pydevices/blob/main/docs/guides/audio.md", "tier_color": true }, { @@ -203,7 +203,7 @@ }, { "label": "Component API", - "href": "https://github.com/PyDevices/audiocomponents/blob/main/docs/audio-component-api.md", + "href": "https://github.com/PyDevices/audiocomponents/blob/main/docs/reference/component-api.md", "tier_color": true }, { @@ -460,8 +460,8 @@ "primary": true }, { - "label": "Newcomer's guide", - "href": "https://github.com/PyDevices/lvgl-micropython/blob/main/docs/newcomers.md", + "label": "Get started", + "href": "https://github.com/PyDevices/lvgl-bindings/blob/main/docs/get-started/install.md#micropython-compatible-firmware-with-lvgl-micropython", "tier_color": true }, { @@ -536,8 +536,8 @@ "primary": true }, { - "label": "Newcomer's guide", - "href": "https://github.com/PyDevices/lvgl-circuitpython/blob/main/docs/newcomers.md", + "label": "Get started", + "href": "https://github.com/PyDevices/lvgl-bindings/blob/main/docs/get-started/install.md#circuitpython-compatible-firmware-with-lvgl-circuitpython", "tier_color": true }, { @@ -650,13 +650,13 @@ "primary": true }, { - "label": "User Guide", - "href": "https://github.com/PyDevices/mpftp/blob/main/docs/user-guide.md", + "label": "Docs", + "href": "https://github.com/PyDevices/mpftp/blob/main/docs/index.md", "tier_color": true }, { "label": "Agent guide", - "href": "https://github.com/PyDevices/mpftp/blob/main/docs/agent-guide.md", + "href": "https://github.com/PyDevices/mpftp/blob/main/docs/guides/drive-a-board-from-an-agent.md", "tier_color": true }, { @@ -689,7 +689,7 @@ }, { "label": "Board bring-up", - "href": "https://github.com/PyDevices/pydevices/blob/main/docs/board-bringup.md", + "href": "https://github.com/PyDevices/pydevices/blob/main/docs/guides/bring-up-a-board.md", "tier_color": true }, { @@ -838,8 +838,8 @@ "tier_color": true }, { - "label": "Newcomer's guide", - "href": "https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md", + "label": "How it works", + "href": "https://github.com/PyDevices/micropython-pydevices/blob/main/docs/how-it-works/index.md", "tier_color": true }, { @@ -903,7 +903,7 @@ }, { "label": "Getting Started", - "href": "https://github.com/PyDevices/mpvst/blob/main/docs/getting-started.md", + "href": "https://github.com/PyDevices/mpvst/blob/main/docs/get-started/install.md", "tier_color": true }, {