Skip to content

docs: update copilot instructions for scadm export-png and ADR convention #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kellervater merged 2 commits into from
May 9, 2026
Merged

docs: update copilot instructions for scadm export-png and ADR convention #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d6ed91
docs: update copilot instructions for scadm export-png and ADR conven…
kellervater May 9, 2026
9779060
fix: point image-hosting ADR link to homeracker source
kellervater May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<repo>/<path>`. 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/<repo>/<path>`. 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 an ADR in `docs/decisions/`.
- Format: `ADR-NNN-<slug>.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.
Comment thread
kellervater marked this conversation as resolved.
- **Commits**: Use [Conventional Commits](https://www.conventionalcommits.org/) format
- Types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`
- Format: `type(scope): description` or `type: description`
Expand Down
6 changes: 3 additions & 3 deletions .github/instructions/markdown.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|------|---------|
Expand All @@ -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/<name>/parts/<part>.scad
scadm export-png models/<name>/parts/<part>.scad

## 📚 References

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion .github/instructions/openscad.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading