add more models

Author: keychron-dev

.github/badges/model-count.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "label": "models uploaded",
-  "message": "70",
+  "message": "88",
   "color": "brightgreen",
   "namedLogo": "github"
 }

.github/workflows/update-badge.yml

@@ -3,18 +3,6 @@ name: Update Model Count Badge
 on:
   push:
     branches: [main]
-    paths:
-      - 'Q-Series/**'
-      - 'Q-Pro-Series/**'
-      - 'Q-HE-Series/**'
-      - 'K-Pro-Series/**'
-      - 'K-Max-Series/**'
-      - 'K-HE-Series/**'
-      - 'V-Max-Series/**'
-      - 'P-HE-Series/**'
-      - 'L-Series/**'
-      - 'Mice/**'
-      - 'Keycap Profiles/**'
   workflow_dispatch:
 
 jobs:
@@ -30,29 +18,7 @@ jobs:
       - name: Count model directories
         id: count
         run: |
-          # Only count actual device model directories (not Keycap Profiles)
-          SERIES_DIRS=(
-            "Q-Series"
-            "Q-Pro-Series"
-            "Q-HE-Series"
-            "K-Pro-Series"
-            "K-Max-Series"
-            "K-HE-Series"
-            "V-Max-Series"
-            "P-HE-Series"
-            "L-Series"
-            "Mice"
-          )
-
-          COUNT=0
-          for dir in "${SERIES_DIRS[@]}"; do
-            if [ -d "$dir" ]; then
-              n=$(find "$dir" -mindepth 1 -maxdepth 1 -type d | wc -l)
-              echo "  $dir: $n models"
-              COUNT=$((COUNT + n))
-            fi
-          done
-
+          COUNT=$(python3 scripts/repo_inventory.py count --device-only)
           echo "Total models: $COUNT"
           echo "count=$COUNT" >> "$GITHUB_OUTPUT"
 

README.md

@@ -26,7 +26,7 @@ Study real CAD. Remix plates and cases. Design compatible accessories. Learn fro
 If you're new, begin with one of these paths:
 
 - **Browse keyboard files**  
-  Explore Q, Q Pro, Q HE, K Pro, K Max, K HE, V Max, and P HE models.
+  Explore C Pro, Q, Q Pro, Q HE, Q Max, Q Ultra 8K, K Pro, K Max, K HE, V Max, and P HE models.
 
 - **Browse mouse files**  
   Explore shell and full-model files for M and G series mice.
@@ -61,25 +61,34 @@ If you're new, begin with one of these paths:
 
 | Series | Type | Models | Components |
 |---|---|---|---|
+| **C Pro Series** | Keyboard | C3 Pro | Plate, Full Model |
 | **Q Series** | Keyboard | Q0 Plus, Q1–Q12, Q60, Q65 | Case, Plate, Encoder, Full Model, Stabilizer, OSA Keycap |
-| **Q Pro Series** | Keyboard | Q1 Pro–Q14 Pro | Case, Plate, Encoder, Full Model, Stabilizer, KSA Keycap |
-| **Q HE Series** | Hall Effect | Q1 HE, Q3 HE, Q5 HE, Q6 HE | Plate, Full Model |
+| **Q Pro Series** | Keyboard | Q1 Pro–Q14 Pro (10 models) | Case, Plate, Encoder, Full Model, Stabilizer, KSA Keycap |
+| **Q HE Series** | Hall Effect | Q1 HE, Q3 HE, Q5 HE, Q6 HE, Q12 HE | Plate, Full Model, selected case parts |
+| **Q Max Series** | Keyboard | Q6 Max | Case, Plate, Full Model, Stabilizer |
+| **Q Ultra 8K Series** | Keyboard | Q6 Ultra 8K | Plate |
 | **K Pro Series** | Keyboard | K1 Pro–K17 Pro (16 models) | Case, Plate, Full Model, Stabilizer |
-| **K Max Series** | Keyboard | K1 Max–K17 Max (11 models) | Case, Plate, Full Model, Stabilizer |
+| **K Max Series** | Keyboard | K0 Max, K1 Max–K17 Max (12 models) | Case, Plate, Full Model, Stabilizer, Keycap on selected models |
 | **K HE Series** | Hall Effect | K2 HE–K10 HE | Case, Plate, Full Model, Stabilizer, Keycap (K2 HE; other models pending) |
 | **L Series** | Keyboard | L1, L3 | Case, Plate, Knob, Full Model, Stabilizer |
 | **V Max Series** | Keyboard | V1 Max–V10 Max | Case, Plate, Encoder, Full Model, Stabilizer, OSA Keycap |
-| **P HE Series** | Hall Effect | P1 HE | Case, Plate, Full Model, Stabilizer |
+| **P HE Series** | Hall Effect | P1 HE | Case, Plate, Full Model, Stabilizer, Keycap |
 | **Mouse Series** | Mouse | M1–M7, G1, G2 (11 models) | Shell, Full Model |
 
-**83 device models. 640+ design files. Source-available. Accessory-friendly.**
+**88 device models. 686+ design files. Source-available. Accessory-friendly.**
 ![Keychron keyboards structure design](docs/assets/keychron-keyboards-structures.webp)
 
 ## Directory Structure
 
 ```
+C-Pro-Series/
+  C3 Pro/               — Plate and full-model files for the C3 Pro
 Q-Series/
   Q1/                   — Case, plate, encoder, stabilizer, full model
+Q-Max-Series/
+  Q6 Max/               — Wireless Q-series case, plate, full model, and stabilizer files
+Q-Ultra-8K-Series/
+  Q6 Ultra 8K/          — Ultra 8K plate files
 Q-Pro-Series/
   Q1 Pro/               — Wireless Q-series hardware files
 K-Pro-Series/

docs/repo-inventory.md

@@ -2,27 +2,37 @@
 
 Generated from the current filesystem using `scripts/repo_inventory.py`.
 
-- Total model directories: **89**
-- Total data files across model directories: **643**
+- Total model directories: **94**
+- Total data files across model directories: **686**
 
 ## Series Summary
 
 | Series | Models | Data Files |
 |---|---:|---:|
+| C-Pro-Series | 1 | 4 |
 | Q-Series | 15 | 147 |
 | Q-Pro-Series | 10 | 86 |
-| Q-HE-Series | 4 | 18 |
+| Q-HE-Series | 5 | 22 |
+| Q-Max-Series | 1 | 10 |
+| Q-Ultra-8K-Series | 1 | 4 |
 | K-Pro-Series | 16 | 129 |
-| K-Max-Series | 11 | 122 |
-| K-HE-Series | 5 | 11 |
+| K-Max-Series | 12 | 130 |
+| K-HE-Series | 5 | 19 |
 | V-Max-Series | 8 | 94 |
 | P-HE-Series | 1 | 9 |
 | L-Series | 2 | 16 |
 | Mice | 11 | 11 |
-| Keycap Profiles | 6 | 0 |
+| Keycap Profiles | 6 | 5 |
 
 ## Per-Model Manifests
 
+### C-Pro-Series / C3 Pro
+
+- Path: `C-Pro-Series/C3 Pro`
+- Data files: 4
+- README present: no
+- Extensions: `.dwg` x1, `.pdf` x1, `.stp` x2
+
 ### Q-Series / Q0 Plus
 
 - Path: `Q-Series/Q0 Plus`
@@ -205,6 +215,13 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 - README present: yes
 - Extensions: `.dwg` x2, `.md` x1, `.pdf` x2, `.stp` x2
 
+### Q-HE-Series / Q12 HE
+
+- Path: `Q-HE-Series/Q12 HE`
+- Data files: 4
+- README present: no
+- Extensions: `.stp` x4
+
 ### Q-HE-Series / Q3 HE
 
 - Path: `Q-HE-Series/Q3 HE`
@@ -226,6 +243,20 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 - README present: yes
 - Extensions: `.dwg` x1, `.md` x1, `.pdf` x1, `.stp` x2
 
+### Q-Max-Series / Q6 Max
+
+- Path: `Q-Max-Series/Q6 Max`
+- Data files: 10
+- README present: no
+- Extensions: `.dwg` x2, `.pdf` x2, `.stp` x5, `.zip` x1
+
+### Q-Ultra-8K-Series / Q6 Ultra 8k
+
+- Path: `Q-Ultra-8K-Series/Q6 Ultra 8k`
+- Data files: 4
+- README present: no
+- Extensions: `.dwg` x2, `.pdf` x2
+
 ### K-Pro-Series / K1 Pro
 
 - Path: `K-Pro-Series/K1 Pro`
@@ -338,6 +369,13 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 - README present: yes
 - Extensions: `.dwg` x1, `.md` x1, `.pdf` x1, `.stp` x3, `.zip` x1
 
+### K-Max-Series / K0 Max
+
+- Path: `K-Max-Series/K0 Max`
+- Data files: 8
+- README present: no
+- Extensions: `.dwg` x1, `.pdf` x1, `.stp` x6
+
 ### K-Max-Series / K1 Max
 
 - Path: `K-Max-Series/K1 Max`
@@ -418,9 +456,9 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 ### K-HE-Series / K10 HE
 
 - Path: `K-HE-Series/K10 HE`
-- Data files: 0
+- Data files: 8
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.dwg` x1, `.md` x1, `.pdf` x1, `.stp` x6
 
 ### K-HE-Series / K2 HE
 
@@ -607,16 +645,16 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 ### Keycap Profiles / Cherry Profile
 
 - Path: `Keycap Profiles/Cherry Profile`
-- Data files: 0
+- Data files: 1
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.md` x1, `.stp` x1
 
 ### Keycap Profiles / KSA Profile
 
 - Path: `Keycap Profiles/KSA Profile`
-- Data files: 0
+- Data files: 1
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.md` x1, `.stp` x1
 
 ### Keycap Profiles / LSA Profile
 
@@ -628,21 +666,21 @@ Generated from the current filesystem using `scripts/repo_inventory.py`.
 ### Keycap Profiles / MDA Profile
 
 - Path: `Keycap Profiles/MDA Profile`
-- Data files: 0
+- Data files: 1
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.md` x1, `.stp` x1
 
 ### Keycap Profiles / OEM Profile
 
 - Path: `Keycap Profiles/OEM Profile`
-- Data files: 0
+- Data files: 1
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.md` x1, `.stp` x1
 
 ### Keycap Profiles / OSA Profile
 
 - Path: `Keycap Profiles/OSA Profile`
-- Data files: 0
+- Data files: 1
 - README present: yes
-- Extensions: `.md` x1
+- Extensions: `.md` x1, `.stp` x1
 

scripts/repo_inventory.py

@@ -12,10 +12,13 @@
 
 
 REPO_ROOT = Path(__file__).resolve().parent.parent
-SERIES_ORDER = [
+PREFERRED_SERIES_ORDER = [
+    "C-Pro-Series",
     "Q-Series",
     "Q-Pro-Series",
     "Q-HE-Series",
+    "Q-Max-Series",
+    "Q-Ultra-8K-Series",
     "K-Pro-Series",
     "K-Max-Series",
     "K-HE-Series",
@@ -25,21 +28,41 @@
     "Mice",
     "Keycap Profiles",
 ]
+IGNORED_TOP_LEVEL_DIRS = {"docs", "scripts"}
 
 
-def iter_series():
-    for name in SERIES_ORDER:
-        path = REPO_ROOT / name
-        if path.is_dir():
-            yield path
+def iter_series() -> list[Path]:
+    preferred_index = {
+        name: index for index, name in enumerate(PREFERRED_SERIES_ORDER)
+    }
+    discovered = []
+    for path in REPO_ROOT.iterdir():
+        if not path.is_dir():
+            continue
+        if path.name.startswith(".") or path.name in IGNORED_TOP_LEVEL_DIRS:
+            continue
+        if any(child.is_dir() and not child.name.startswith(".") for child in path.iterdir()):
+            discovered.append(path)
+    return sorted(
+        discovered,
+        key=lambda path: (preferred_index.get(path.name, len(preferred_index)), path.name),
+    )
 
 
 def series_model_dirs(series_path: Path) -> list[Path]:
-    return sorted(path for path in series_path.iterdir() if path.is_dir())
+    return sorted(
+        path
+        for path in series_path.iterdir()
+        if path.is_dir() and not path.name.startswith(".")
+    )
 
 
 def manifest_for_model(model_path: Path) -> dict[str, object]:
-    files = sorted(path for path in model_path.iterdir() if path.is_file())
+    files = sorted(
+        path
+        for path in model_path.iterdir()
+        if path.is_file() and not path.name.startswith(".")
+    )
     ext_counts = Counter(path.suffix.lower() or "[noext]" for path in files)
     readme_present = any(path.name.lower() == "readme.md" for path in files)
     data_files = [path for path in files if path.name.lower() != "readme.md"]
@@ -88,6 +111,14 @@ def collect_inventory() -> dict[str, object]:
     }
 
 
+def device_model_count(inventory: dict[str, object]) -> int:
+    return sum(
+        entry["model_count"]
+        for entry in inventory["series"]
+        if entry["series"] != "Keycap Profiles"
+    )
+
+
 def render_summary_markdown(inventory: dict[str, object]) -> str:
     lines = [
         "# Repository Inventory",
@@ -136,11 +167,7 @@ def validate_readme(inventory: dict[str, object], readme_path: Path) -> list[str
     errors = []
 
     # Count device models (exclude Keycap Profiles which are documentation-only)
-    device_models = sum(
-        entry["model_count"]
-        for entry in inventory["series"]
-        if entry["series"] != "Keycap Profiles"
-    )
+    device_models = device_model_count(inventory)
 
     # Check badge -- either static URL or dynamic endpoint
     badge_match = re.search(r"models%20uploaded-(\d+)-", text)
@@ -220,6 +247,13 @@ def build_parser() -> argparse.ArgumentParser:
         help="README path to validate.",
     )
 
+    count = subparsers.add_parser("count", help="Print the current model count.")
+    count.add_argument(
+        "--device-only",
+        action="store_true",
+        help="Exclude Keycap Profiles from the total.",
+    )
+
     return parser
 
 
@@ -239,6 +273,11 @@ def main() -> int:
             sys.stdout.write(output)
         return 0
 
+    if args.command == "count":
+        count = device_model_count(inventory) if args.device_only else inventory["total_models"]
+        print(count)
+        return 0
+
     errors = validate_readme(inventory, args.readme)
     if errors:
         for error in errors: