Skip to content

Commit 07399fe

Browse files
committed
fix some document
1 parent d1f54fd commit 07399fe

4 files changed

Lines changed: 15 additions & 10 deletions

File tree

.github/workflows/validate-inventory.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,8 @@ jobs:
2020

2121
- name: Validate README counts
2222
run: python3 scripts/repo_inventory.py validate
23+
24+
- name: Validate generated inventory document
25+
run: |
26+
python3 scripts/repo_inventory.py generate > /tmp/repo-inventory.md
27+
diff -u docs/repo-inventory.md /tmp/repo-inventory.md

Q-Series/Q0 Plus/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ The Q0 Plus is a 27-key gasket-mounted aluminum numpad designed for productivity
2424

2525
| File | Description | Format |
2626
|------|-------------|--------|
27-
| `Q0-Plus-Enclosure.step` | Full enclosure model (top case, bottom case, weight) | STEP |
28-
| `Q0-Plus-Switch-Plate.dxf` | Switch plate cutout drawing | DXF |
29-
| `Q0-Plus-Assembly.step` | Complete assembly with all components | STEP |
30-
| `Q0-Plus-Stabilizer-Specs.pdf` | Stabilizer dimensions and layout reference | PDF |
27+
| `Q0-Plus-Top-Case.stp` and `Q0-Plus-Bottom-Case.stp` | Split enclosure models for the aluminum case | STEP |
28+
| `Q0-Plus-Plate.dxf` and `Q0-Plus-Plate.pdf` | Switch plate geometry and reference drawing | DXF / PDF |
29+
| `Q0-Plus-US-Full-Model-20230105.stp` | Complete assembled model with the current dated filename | STEP |
30+
| `Q0-Plus-Knob.stp` and `Stabilizer-Q0-Plus.stp` | Rotary encoder knob and stabilizer reference parts | STEP |
3131

3232
## Compatible Software
3333

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Study real CAD. Remix plates and cases. Design compatible accessories. Learn fro
1515

1616
## Latest Updates
1717

18-
- **2026-04-11:** Added add c3 Pro 8k, K4 HE, K8 HE, K2 QMK, Q0 HE and Q12 HE.
18+
- **2026-04-11:** Added C3 Pro 8K, K4 HE, K8 HE, K2 QMK, Q0 HE, and Q12 HE.
1919
- **2026-04-10:** Added more K0 Max files, Q12 HE and more Q6 Max files and more keycap profiles.
2020
- **2026-04-09:** Added K10 HE, Q6 Max and K0 Max design files. Update: make the accessories not subject to licensing.
2121
- **2026-04:** Added Q HE and mouse design files.
@@ -65,12 +65,12 @@ If you're new, begin with one of these paths:
6565
| **C Pro 8K Series** | Keyboard | C1 Pro 8K, C2 Pro 8K, C3 Pro 8K | Case, Plate, Full Model, Stabilizer |
6666
| **Q Series** | Keyboard | Q0 Plus, Q1–Q12, Q60, Q65 | Case, Plate, Encoder, Full Model, Stabilizer, OSA Keycap |
6767
| **Q Pro Series** | Keyboard | Q1 Pro–Q14 Pro (10 models) | Case, Plate, Encoder, Full Model, Stabilizer, KSA Keycap |
68-
| **Q HE Series** | Hall Effect | Q1 HE, Q3 HE, Q5 HE, Q6 HE, Q12 HE | Plate, Full Model, selected case parts |
68+
| **Q HE Series** | Hall Effect | Q0 HE, Q1 HE, Q3 HE, Q5 HE, Q6 HE, Q12 HE | Plate, Full Model, selected case parts |
6969
| **Q Max Series** | Keyboard | Q6 Max | Case, Plate, Full Model, Stabilizer |
7070
| **Q Ultra 8K Series** | Keyboard | Q6 Ultra 8K | Plate |
7171
| **K Pro Series** | Keyboard | K1 Pro–K17 Pro (16 models) | Case, Plate, Full Model, Stabilizer |
7272
| **K Max Series** | Keyboard | K0 Max, K1 Max–K17 Max (12 models) | Case, Plate, Full Model, Stabilizer, Keycap on selected models |
73-
| **K HE Series** | Hall Effect | K2 HEK10 HE | Case, Plate, Full Model, Stabilizer, Keycap (K2 HE; other models pending) |
73+
| **K HE Series** | Hall Effect | K2 HE, K4 HE, K6 HE, K8 HE, K10 HE | Published models include case, plate, full model, stabilizer, and selected keycap files; K6 HE is currently folder-only |
7474
| **K QMK Series** | Keyboard | K2 QMK | Case, Plate, Stabilizer, Keycap |
7575
| **L Series** | Keyboard | L1, L3 | Case, Plate, Knob, Full Model, Stabilizer |
7676
| **V Max Series** | Keyboard | V1 Max–V10 Max | Case, Plate, Encoder, Full Model, Stabilizer, OSA Keycap |
@@ -88,7 +88,7 @@ C-Pro-8K-Series/
8888
Q-Series/
8989
Q0 Plus/ — Numpad files alongside Q1–Q12, Q60, and Q65
9090
Q-HE-Series/
91-
Q12 HE/ — Hall Effect files alongside Q1 HE, Q3 HE, Q5 HE, and Q6 HE
91+
Q0 HE/ — Hall Effect numpad files alongside Q1 HE, Q3 HE, Q5 HE, Q6 HE, and Q12 HE
9292
Q-Pro-Series/
9393
Q1 Pro/ — Wireless Q-series hardware files across 10 models
9494
Q-Max-Series/

docs/repo-inventory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,8 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
206206

207207
- Path: `Q-HE-Series/Q0 HE`
208208
- Data files: 9
209-
- README present: no
210-
- Extensions: `.dwg` x1, `.dxf` x1, `.pdf` x1, `.stp` x6
209+
- README present: yes
210+
- Extensions: `.dwg` x1, `.dxf` x1, `.md` x1, `.pdf` x1, `.stp` x6
211211

212212
### Q-HE-Series / Q1 HE
213213

0 commit comments

Comments
 (0)