From 519c3a22e4806d1f65feb99a5f423fecabf3c62d Mon Sep 17 00:00:00 2001 From: William Rickert Date: Fri, 28 Aug 2026 08:26:38 -0500 Subject: [PATCH] Fix paths after the docs/Documents merge Every image and link pointed at docs/, which no longer exists - the README rendered with six broken images. Repoints them at Documents/, updates the board table to the real Schematics/Left|Right|Numpad tree, and renames firmware/ to Firmware/ to match the capitalised convention. Documents/README.md now describes the whole folder rather than just the datasheets, since the diagrams and BOM live there too. Co-Authored-By: Claude Opus 5 --- Documents/README.md | 26 ++++++++++++++++++++---- {firmware => Firmware}/README.md | 0 LICENSE.md | 6 +++--- README.md | 34 ++++++++++++++++---------------- 4 files changed, 42 insertions(+), 24 deletions(-) rename {firmware => Firmware}/README.md (100%) diff --git a/Documents/README.md b/Documents/README.md index ff5f0fa..b20eb22 100644 --- a/Documents/README.md +++ b/Documents/README.md @@ -1,8 +1,26 @@ -# Datasheets in use +# Documents -Only the parts this design actually depends on. The wider WCH collection — -including the CH32X035 and CH32V203 docs used to rule out crystal-less USB — -lives in `~/Documents/Projects/WCH CH ICs/`. +Diagrams, the BOM, and the datasheets for parts this design actually depends on. + +## Diagrams + +| File | Shows | +|---|---| +| `three-board-overview.svg` | All three boards at the same key spacing | +| `half-left-staggered.svg` | Left half — 34 keys, six clean columns | +| `half-right-staggered.svg` | Right half — 41 keys | +| `numpad-layout.svg` | Numpad — 25 keys plus the volume encoder | +| `104-key-split.svg` | How a full 104 maps across the three boards | +| `half-left.svg`, `half-right.svg` | The earlier row-staggered split, kept for reference | + +`bom.csv` carries LCSC part numbers, JLC basic/extended status and the +swap-dependent parts. + +## Datasheets + +Only the parts this design depends on. The wider WCH collection — including the +CH32X035 and CH32V203 docs used to rule out crystal-less USB — lives in +`~/Documents/Projects/WCH CH ICs/`. | File | Part | Why it's here | |---|---|---| diff --git a/firmware/README.md b/Firmware/README.md similarity index 100% rename from firmware/README.md rename to Firmware/README.md diff --git a/LICENSE.md b/LICENSE.md index 800f3dc..e85ce9f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -4,9 +4,9 @@ This project is under **two** licences, because it has to be. | Path | Licence | |---|---| -| `hardware/`, `docs/`, `README.md` | **CC BY-NC-SA 4.0** — [`LICENSES/CC-BY-NC-SA-4.0.txt`](LICENSES/CC-BY-NC-SA-4.0.txt) | -| `firmware/` | **GPL-2.0-or-later** — [`LICENSES/GPL-2.0.txt`](LICENSES/GPL-2.0.txt) | -| `Documents/` | Third-party vendor datasheets. Not mine to license. | +| `Schematics/`, `Documents/`, `README.md` | **CC BY-NC-SA 4.0** — [`LICENSES/CC-BY-NC-SA-4.0.txt`](LICENSES/CC-BY-NC-SA-4.0.txt) | +| `Firmware/` | **GPL-2.0-or-later** — [`LICENSES/GPL-2.0.txt`](LICENSES/GPL-2.0.txt) | +| `Documents/*.PDF` | Third-party vendor datasheets. Not mine to license. | ## The hardware: CC BY-NC-SA 4.0 diff --git a/README.md b/README.md index 5632297..c08154f 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,19 @@ board that also carries the USB hub. One cable reaches the computer. Status: **design**. No boards ordered, no firmware written. -![All three boards to scale](docs/three-board-overview.svg) +![All three boards to scale](Documents/three-board-overview.svg) - - + +
Left half, 34 keysRight half, 41 keysLeft half, 34 keysRight half, 41 keys
-![Numpad layout](docs/numpad-layout.svg) +![Numpad layout](Documents/numpad-layout.svg) Derived from a full 104 rather than a compact ergo core — see -[`docs/104-key-split.svg`](docs/104-key-split.svg) for how the original layout +[`Documents/104-key-split.svg`](Documents/104-key-split.svg) for how the original layout maps across the three boards. ## Licence @@ -30,7 +30,7 @@ commercial products. permits commercial use. See [`LICENSE.md`](LICENSE.md) for why the two can't be the same, and for the caveats on what "NonCommercial" actually means. -Datasheets under `Documents/` are third-party vendor PDFs and aren't covered by +The vendor PDFs inside `Documents/` (WCH, ST) are third-party and aren't covered by either. --- @@ -39,12 +39,12 @@ either. | Board | Qty | Keys | Carries | |---|---|---|---| -| `hardware/half-left` | 1 | **34** | MCU, matrix, USB-C, SBU split link | -| `hardware/half-right` | 1 | **41** | MCU, matrix, USB-C, SBU split link | -| `hardware/numpad` | 1 | 25 (16 numpad + 9 nav) | MCU, matrix, 1 encoder, **CH334R hub**, 3 downstream ports | +| `Schematics/Left` | 1 | **34** | MCU, matrix, USB-C, SBU split link | +| `Schematics/Right` | 1 | **41** | MCU, matrix, USB-C, SBU split link | +| `Schematics/Numpad` | 1 | 25 (16 numpad + 9 nav) | MCU, matrix, 1 encoder, **CH334R hub**, 3 downstream ports | -**Numpad layout is settled** — see `docs/numpad-layout.svg`, and -`docs/three-board-overview.svg` for all three at the same scale. Six columns by five +**Numpad layout is settled** — see `Documents/numpad-layout.svg`, and +`Documents/three-board-overview.svg` for all three at the same scale. Six columns by five rows, ~114 × 95 mm. Arrows take the **outer** left column on the principle that the most-used keys go furthest out, PgUp/PgDn sit beside them, and Del/Home/End fill the rest of the two nav columns. **No Num key** — the firmware resolves @@ -186,7 +186,7 @@ diode and socket counts. A reversible PCB was never on the table anyway — the hotswap socket footprint isn't mirror-symmetric, so it would have needed two socket footprints per key with one populated. -See `docs/half-left.svg` and `docs/half-right.svg`. +See `Documents/half-left.svg` and `Documents/half-right.svg`. ### Column stagger, not row stagger @@ -195,7 +195,7 @@ room, hands didn't. Since these are new PCBs, the columns get offset vertically to match finger length instead: middle column highest, pinky and inner-reach columns down ~0.4u. -`docs/half-left-staggered.svg` is the left half rebuilt this way. **Same 36 +`Documents/half-left-staggered.svg` is the left half rebuilt this way. **Same 36 keys**, and it resolves into a clean 7-column grid: | Column | Holds | @@ -225,7 +225,7 @@ The right is worse: **five** thumb keys (Space / Alt / Win / Menu / Ctrl). One thumb will not cover five. Menu is the obvious deletion — nothing else on the board is used less. -`docs/half-right-staggered.svg`. +`Documents/half-right-staggered.svg`. ### The outer edge — resolved @@ -241,8 +241,8 @@ leads the number row and `F6` leads the function row, both sitting above `Y`. and `\` sharing the outer pinky column. `\` no longer sits alone two columns out — it pairs with Backspace, and both -are genuine outer-pinky reaches. `docs/half-left-staggered.svg`, -`docs/half-right-staggered.svg`. +are genuine outer-pinky reaches. `Documents/half-left-staggered.svg`, +`Documents/half-right-staggered.svg`. Still open: the right thumb is carrying **five** keys (Space / Alt / Win / Menu / Ctrl) and one thumb will not cover five. Menu is the obvious deletion. @@ -323,7 +323,7 @@ Rules file is now just `ENCODER_ENABLE` + `EXTRAKEY_ENABLE`. - **The layout.** Undesigned, and it's the only input the PCB can't defer. If a thumb layer on one half reaches keys on the other, the halves must be a QMK split. If each half is self-sufficient, they can be three independent - keyboards. The hardware supports both — see `docs/104-key-split.svg` for how a + keyboards. The hardware supports both — see `Documents/104-key-split.svg` for how a 104-key layout maps onto three boards, and note a straight chop gives 36 vs 39 keys, so a symmetric core plus layers is needed for mirrored boards. - Pin-number overlay of L103 vs F103 (above).