Merge pull request #34 from PyDevices/docs/fix-moved-links

Point moved docs links at their new homes

Author: bdbarnett

audiocomponents/index.html

@@ -28,7 +28,7 @@ <h1>audiocomponents — 55 classic instruments and 45 effects, in pure Python, o
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         GitHub Repo
       </a>
-      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/audiocomponents/blob/main/docs/audio-component-api.md">Component API</a>
+      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/audiocomponents/blob/main/docs/reference/component-api.md">Component API</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://test.pypi.org/project/pydevices-audioinstruments/">TestPyPI: instruments</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://test.pypi.org/project/pydevices-audioeffects/">TestPyPI: effects</a>
       </div>

audioif/index.html

@@ -29,7 +29,7 @@ <h1>audioif has moved into micropython-pydevices.</h1>
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         modules/audioif
       </a>
-      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/pydevices/blob/main/docs/audio.md">Audio in pydevices</a>
+      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/pydevices/blob/main/docs/guides/audio.md">Audio in pydevices</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://pydevices.github.io/micropython-pydevices/">micropython-pydevices</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/audioif">Archived repo</a>
     </div>

install.sh

@@ -327,7 +327,7 @@ main_windows() {  # dir branch [build_mp.py arguments]
     say "  ${PYTHON:-python} build_mp.py --port windows --variant pydevices --modules all"
     say ""
     say "Every other port (esp32, rp2, webassembly, unix) builds from WSL, as on Linux."
-    say "The guide: https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md#on-windows"
+    say "The guide: https://github.com/PyDevices/micropython-pydevices/blob/main/docs/guides/build-on-windows.md"
 }
 
 main() {
@@ -375,7 +375,7 @@ main() {
     say "  ./build_mp.py --port unix --variant pydevices --modules all"
     say "  ./build_mp.py --port esp32 --board ESP32_GENERIC_S3 --variant SPIRAM_OCT --flash 8MB --modules all"
     say ""
-    say "The guide: https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md"
+    say "The guide: https://github.com/PyDevices/micropython-pydevices/blob/main/docs/get-started/install.md"
 }
 
 main "$@"

lvgl-circuitpython/index.html

@@ -35,7 +35,7 @@ <h1>lvgl-circuitpython — CircuitPython native LVGL C module.</h1>
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         GitHub Repo
       </a>
-      <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://github.com/PyDevices/lvgl-circuitpython/blob/main/docs/newcomers.md">Newcomer's guide</a>
+      <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://github.com/PyDevices/lvgl-bindings/blob/main/docs/get-started/install.md#circuitpython-compatible-firmware-with-lvgl-circuitpython">Get started</a>
       <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://pydevices.github.io/lvgl-bindings/">lvgl-bindings</a>
       <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://pydevices.github.io/pydevices/">pydevices Core</a>
       </div>

lvgl-micropython/index.html

@@ -35,7 +35,7 @@ <h1>lvgl-micropython — MicroPython C usermod for LVGL v9.</h1>
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         GitHub Repo
       </a>
-      <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://github.com/PyDevices/lvgl-micropython/blob/main/docs/newcomers.md">Newcomer's guide</a>
+      <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://github.com/PyDevices/lvgl-bindings/blob/main/docs/get-started/install.md#micropython-compatible-firmware-with-lvgl-micropython">Get started</a>
       <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://pydevices.github.io/lvgl-bindings/">lvgl-bindings</a>
       <a class="btn" style="border-color: var(--tier-3-blue); color: var(--tier-3-blue);" href="https://pydevices.github.io/pydevices/">pydevices Core</a>
       </div>

micropython-pydevices/index.html

@@ -29,7 +29,7 @@ <h1>micropython-pydevices — the versioned MicroPython runtime overlay.</h1>
         GitHub Repo
       </a>
       <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/micropython-pydevices/tree/main/patches">Patch series</a>
-      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md">Newcomer's guide</a>
+      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/how-it-works/index.md">How it works</a>
       <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://pydevices.github.io/pydevices/">pydevices Core</a>
       </div>
     </div>
@@ -53,7 +53,7 @@ <h2>Install</h2>
       <pre><code>curl -fsSL https://pydevices.github.io/install.sh | sh</code></pre>
     </div>
     <p class="prose" style="margin-top: 14px;">It clones this repository into <code>micropython-pydevices</code> in the current directory (or updates the clone already there), checks the tools every build needs, and tells you what's missing for each port. Add a build after <code>--</code> to do both at once: <code>curl -fsSL https://pydevices.github.io/install.sh | sh -s -- --port unix --variant pydevices --modules all</code></p>
-    <p class="prose">On Windows, run it from Git Bash (Start menu, Git Bash), not PowerShell. It clones first, then checks for Python and the MSYS2 toolchain that builds the windows port natively, and prints the install lines for whatever is missing. After that you build from PowerShell or Git Bash with <code>python build_mp.py --port windows --variant pydevices --modules all</code>; the <a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md#on-windows">Windows steps</a> have the rest. The other ports build from WSL.</p>
+    <p class="prose">On Windows, run it from Git Bash (Start menu, Git Bash), not PowerShell. It clones first, then checks for Python and the MSYS2 toolchain that builds the windows port natively, and prints the install lines for whatever is missing. After that you build from PowerShell or Git Bash with <code>python build_mp.py --port windows --variant pydevices --modules all</code>; the <a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/guides/build-on-windows.md">Windows steps</a> have the rest. The other ports build from WSL.</p>
     <div class="section-head" style="margin-top: 36px;">
       <h2>Build</h2>
       <span class="hint">One command; the first run fetches what it needs</span>
@@ -73,15 +73,15 @@ <h2>Read more</h2>
     <div class="spec-block">
       <div class="spec-grid">
         <div class="spec-item tier-5">
-          <h4><a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md">Newcomer's guide</a></h4>
+          <h4><a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/how-it-works/index.md">How it works</a></h4>
           <p>How a build is put together: the pinned release, our patches, the modules and the variants.</p>
         </div>
         <div class="spec-item tier-5">
           <h4><a href="https://github.com/PyDevices/micropython-pydevices/tree/main/patches">Patch series</a></h4>
           <p>Every downstream patch, each justified in its own header.</p>
         </div>
         <div class="spec-item tier-5">
-          <h4><a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/newcomers.md#boards-we-build-for">Boards we build for</a></h4>
+          <h4><a href="https://github.com/PyDevices/micropython-pydevices/blob/main/docs/reference/boards.md">Boards we build for</a></h4>
           <p>The esp32 boards and variants, the Picos, and the unix, Windows and WebAssembly variants.</p>
         </div>
       </div>

mpftp/index.html

@@ -35,8 +35,8 @@ <h1>mpftp — board tools for the editor, CLI, and agents.</h1>
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         GitHub Repo
       </a>
-      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpftp/blob/main/docs/user-guide.md">User Guide</a>
-      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpftp/blob/main/docs/agent-guide.md">Agent guide</a>
+      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpftp/blob/main/docs/index.md">Docs</a>
+      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpftp/blob/main/docs/guides/drive-a-board-from-an-agent.md">Agent guide</a>
       <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpftp/releases/latest">Releases</a>
       </div>
     </div>

mpvst/index.html

@@ -29,7 +29,7 @@ <h1>MPVST — audio effects and instruments as a VST3 plug-in.</h1>
         GitHub Repo
       </a>
       <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpvst/releases/latest">Releases</a>
-      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpvst/blob/main/docs/getting-started.md">Getting Started</a>
+      <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://github.com/PyDevices/mpvst/blob/main/docs/get-started/install.md">Getting Started</a>
       <a class="btn" style="border-color: var(--tier-5-steel); color: var(--tier-5-steel);" href="https://pydevices.github.io/audiocomponents/">audiocomponents</a>
       </div>
     </div>

usbif/index.html

@@ -29,7 +29,7 @@ <h1>usbif has moved, to two homes.</h1>
         <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.9a3.4 3.4 0 0 0-1-2.6c3-.3 6-1.5 6-6.5a5 5 0 0 0-1.4-3.5 4.6 4.6 0 0 0-.1-3.5s-1.1-.3-3.5 1.3a12 12 0 0 0-6 0C6.6 1.7 5.5 2 5.5 2a4.6 4.6 0 0 0-.1 3.5A5 5 0 0 0 4 9c0 5 3 6.2 6 6.5a3.4 3.4 0 0 0-1 2.6V22"/></svg>
         modules/usbhost
       </a>
-      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/pydevices/blob/main/docs/usb.md">USB packages in pydevices</a>
+      <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/pydevices/blob/main/docs/guides/usb.md">USB packages in pydevices</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://pydevices.github.io/micropython-pydevices/">micropython-pydevices</a>
       <a class="btn" style="border-color: var(--tier-1-amber); color: var(--tier-1-amber);" href="https://github.com/PyDevices/usbif">Archived repo</a>
     </div>