Skip to content

Commit c0623c6

Browse files
committed
some clean up
1 parent 32ee590 commit c0623c6

File tree

8 files changed

+12
-10
lines changed

8 files changed

+12
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
- [ ] File opens without errors in FreeCAD or Fusion 360
1919
- [ ] Dimensions are in millimeters
20-
- [ ] File follows the naming convention in [CONTRIBUTING.md](../CONTRIBUTING.md)
20+
- [ ] File follows the naming convention in [CONTRIBUTING.md](../docs/CONTRIBUTING.md)
2121
- [ ] No proprietary-only formats (.f3d, .sldprt)
2222
- [ ] Screenshot or dimension comparison included below (if applicable)
2323

.github/workflows/update-badge.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Count model directories
1919
id: count
2020
run: |
21-
COUNT=$(python3 scripts/repo_inventory.py count --device-only)
21+
COUNT=$(python3 docs/scripts/repo_inventory.py count --device-only)
2222
echo "Total models: $COUNT"
2323
echo "count=$COUNT" >> "$GITHUB_OUTPUT"
2424

.github/workflows/validate-inventory.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
python-version: '3.x'
2020

2121
- name: Validate README counts
22-
run: python3 scripts/repo_inventory.py validate
22+
run: python3 docs/scripts/repo_inventory.py validate
2323

2424
- name: Validate generated inventory document
2525
run: |
26-
python3 scripts/repo_inventory.py generate > /tmp/repo-inventory.md
26+
python3 docs/scripts/repo_inventory.py generate > /tmp/repo-inventory.md
2727
diff -u docs/repo-inventory.md /tmp/repo-inventory.md

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ If you're new, begin with one of these paths:
4646
Open the [Repository Inventory](docs/repo-inventory.md) generated from the repo itself.
4747

4848
- **Contribute fixes or improvements**
49-
Read [Contributing](CONTRIBUTING.md) for workflow, file standards, and submission rules.
49+
Read [Contributing](docs/CONTRIBUTING.md) for workflow, file standards, and submission rules.
5050

5151
- **Join the community**
5252
Join the [Keychron Discord](https://discord.com/invite/HAYbRrTsjN) to share builds, ask questions, and help grow the hardware modding community.
@@ -131,8 +131,10 @@ docs/
131131
file-format-guide.md — How to open and edit these files
132132
getting-started.md — First-stop guide for browsing and remixing
133133
3d-printing-guide.md — Practical printing guidance for compatible parts
134-
scripts/
135-
repo_inventory.py — Regenerates the repository inventory from the live tree
134+
CONTRIBUTING.md — Contribution workflow and file standards
135+
CODE_OF_CONDUCT.md — Community participation guidelines
136+
scripts/
137+
repo_inventory.py — Regenerates the repository inventory from the live tree
136138
```
137139

138140
## Why This Matters
File renamed without changes.
File renamed without changes.

docs/repo-inventory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Repository Inventory
22

3-
Generated from the current filesystem using `scripts/repo_inventory.py`.
3+
Generated from the current filesystem using `docs/scripts/repo_inventory.py`.
44

55
- Total model directories: **118**
66
- Total data files across model directories: **734**
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from pathlib import Path
1212

1313

14-
REPO_ROOT = Path(__file__).resolve().parent.parent
14+
REPO_ROOT = Path(__file__).resolve().parent.parent.parent
1515
PREFERRED_SERIES_ORDER = [
1616
"C-Pro-Series",
1717
"Q-Series",
@@ -123,7 +123,7 @@ def render_summary_markdown(inventory: dict[str, object]) -> str:
123123
lines = [
124124
"# Repository Inventory",
125125
"",
126-
"Generated from the current filesystem using `scripts/repo_inventory.py`.",
126+
"Generated from the current filesystem using `docs/scripts/repo_inventory.py`.",
127127
"",
128128
f"- Total model directories: **{inventory['total_models']}**",
129129
f"- Total data files across model directories: **{inventory['total_files']}**",

0 commit comments

Comments
 (0)