From 8d6ed9102d7e6ad911adfae25003cf2f043e1e15 Mon Sep 17 00:00:00 2001 From: kellervater Date: Sat, 9 May 2026 09:40:15 +0200 Subject: [PATCH 1/2] docs: update copilot instructions for scadm export-png and ADR convention - Update export-png references in openscad and markdown instructions - Change ADR naming convention to kebab-case (no numeric prefixes) --- .github/copilot-instructions.md | 10 +++++----- .github/instructions/markdown.instructions.md | 6 +++--- .github/instructions/openscad.instructions.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 529f85f..d795fea 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -28,12 +28,12 @@ HomeRacker is a modular 3D-printable rack-building system. Core components use p - Every code change that adds, modifies, or removes functionality **must** include a documentation update. - Follow the What / Why / How / References structure defined in the markdown instructions. - When renaming or restructuring code, update or rename the associated docs to keep everything tidy. - - When adding or modifying model parts (`parts/*.scad`), **generate preview PNGs** with `cmd/export/export-png.sh` and update both the model's README 📸 Catalog and the parent `models/README.md` index. -- **Assets Policy**: All manually-created images (photos, diagrams, logos, MakerWorld description images) are hosted in [`kellerlabs/assets`](https://github.com/kellerlabs/assets). Push directly to its `main` branch. Reference via `https://raw.githubusercontent.com/kellerlabs/assets/main//`. Only auto-generated render PNGs (`**/renders/*.png`) are tracked in source repos. See [ADR-001](docs/decisions/ADR-001-image-hosting-assets-repo.md). + - When adding or modifying model parts (`parts/*.scad`), **generate preview PNGs** with `scadm export-png` and update both the model's README 📸 Catalog and the parent `models/README.md` index. +- **Assets Policy**: All manually-created images (photos, diagrams, logos, MakerWorld description images) are hosted in [`kellerlabs/assets`](https://github.com/kellerlabs/assets). Push directly to its `main` branch. Reference via `https://raw.githubusercontent.com/kellerlabs/assets/main//`. Only auto-generated render PNGs (`**/renders/*.png`) are tracked in source repos. See [image-hosting-assets-repo](docs/decisions/image-hosting-assets-repo.md). - **Architecture Decision Records (ADRs)**: - - When the user makes an architectural or design decision during a session, create an ADR in `docs/decisions/`. - - Format: `ADR-NNN-.md`, numbered sequentially. - - Cross-link the ADR from related docs (READMEs, instructions, other ADRs) where viable. + - When the user makes an architectural or design decision during a session, create a decision record in `docs/decisions/`. + - Format: `kebab-case-title.md` (no numeric prefixes). + - Cross-link from related docs (READMEs, instructions, other decisions) where viable. - **Commits**: Use [Conventional Commits](https://www.conventionalcommits.org/) format - Types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test` - Format: `type(scope): description` or `type: description` diff --git a/.github/instructions/markdown.instructions.md b/.github/instructions/markdown.instructions.md index 4dd5fef..46c4f26 100644 --- a/.github/instructions/markdown.instructions.md +++ b/.github/instructions/markdown.instructions.md @@ -68,7 +68,7 @@ How to use/customize the model: ## 📸 Catalog -Preview images for each part. Generate with `export-png.sh`: +Preview images for each part. Generate with `scadm export-png`: | Part | Preview | |------|---------| @@ -78,7 +78,7 @@ Preview images for each part. Generate with `export-png.sh`: To generate or refresh previews: - ./cmd/export/export-png.sh models//parts/.scad + scadm export-png models//parts/.scad ## 📚 References @@ -87,7 +87,7 @@ To generate or refresh previews: ``` > - The 📸 Catalog section must list **every** `.scad` file under `parts/` (or the model's main `.scad` for flat models) with a preview PNG. -> - PNGs are generated by `cmd/export/export-png.sh` and stored next to their source `.scad` file. +> - PNGs are generated by `scadm export-png` and stored next to their source `.scad` file. > - When adding or modifying a parts file, **always** generate/refresh its PNG and update the Catalog table. > - When adding a new model or part, also update the parent `models/README.md` index with a description and preview image. diff --git a/.github/instructions/openscad.instructions.md b/.github/instructions/openscad.instructions.md index 24c61a4..46d8193 100644 --- a/.github/instructions/openscad.instructions.md +++ b/.github/instructions/openscad.instructions.md @@ -36,6 +36,6 @@ applyTo: "**/*.scad" ## Preview PNGs -- When adding or modifying a parts file, **generate a preview PNG** with `cmd/export/export-png.sh`. +- When adding or modifying a parts file, **generate a preview PNG** with `scadm export-png`. - PNGs are stored in a `renders/` subfolder next to their source (e.g., `parts/foo.scad` → `parts/renders/foo.png`). - Update the model's README 📸 Catalog table and the `models/README.md` index accordingly. From 9779060f88b84625cc6e2725cd42c15b07803e74 Mon Sep 17 00:00:00 2001 From: kellervater Date: Sat, 9 May 2026 10:10:55 +0200 Subject: [PATCH 2/2] fix: point image-hosting ADR link to homeracker source --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index d795fea..89d9775 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -29,7 +29,7 @@ HomeRacker is a modular 3D-printable rack-building system. Core components use p - Follow the What / Why / How / References structure defined in the markdown instructions. - When renaming or restructuring code, update or rename the associated docs to keep everything tidy. - When adding or modifying model parts (`parts/*.scad`), **generate preview PNGs** with `scadm export-png` and update both the model's README 📸 Catalog and the parent `models/README.md` index. -- **Assets Policy**: All manually-created images (photos, diagrams, logos, MakerWorld description images) are hosted in [`kellerlabs/assets`](https://github.com/kellerlabs/assets). Push directly to its `main` branch. Reference via `https://raw.githubusercontent.com/kellerlabs/assets/main//`. Only auto-generated render PNGs (`**/renders/*.png`) are tracked in source repos. See [image-hosting-assets-repo](docs/decisions/image-hosting-assets-repo.md). +- **Assets Policy**: All manually-created images (photos, diagrams, logos, MakerWorld description images) are hosted in [`kellerlabs/assets`](https://github.com/kellerlabs/assets). Push directly to its `main` branch. Reference via `https://raw.githubusercontent.com/kellerlabs/assets/main//`. Only auto-generated render PNGs (`**/renders/*.png`) are tracked in source repos. See [image-hosting-assets-repo](https://github.com/kellerlabs/homeracker/blob/main/docs/decisions/image-hosting-assets-repo.md). - **Architecture Decision Records (ADRs)**: - When the user makes an architectural or design decision during a session, create a decision record in `docs/decisions/`. - Format: `kebab-case-title.md` (no numeric prefixes).