docs: update copilot instructions for scadm export-png and ADR convention#16
Merged
Conversation
…tion - Update export-png references in openscad and markdown instructions - Change ADR naming convention to kebab-case (no numeric prefixes)
There was a problem hiding this comment.
Pull request overview
Updates GitHub Copilot and documentation instruction markdown to reflect the scadm export-png workflow and a new (non-numeric) decision-record filename convention.
Changes:
- Replace
cmd/export/export-png.sh/export-png.shreferences withscadm export-pngin OpenSCAD + Markdown instruction docs. - Update the Copilot instructions’ decision-record naming guidance to
kebab-case-title.md(no numeric prefixes). - Adjust the referenced decision-doc link text/target in Copilot instructions.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/instructions/openscad.instructions.md | Updates preview PNG generation guidance to use scadm export-png. |
| .github/instructions/markdown.instructions.md | Updates the model README template to reference scadm export-png for preview generation. |
| .github/copilot-instructions.md | Updates export-png tooling reference and changes the decision-record naming convention + linked decision doc reference. |
Comments suppressed due to low confidence (1)
.github/instructions/markdown.instructions.md:75
- The Catalog example still links previews as
parts/part_name.png, but elsewhere these instructions state previews live under arenders/subfolder (and the Assets Policy references**/renders/*.png). Consider updating the example path to match the documented output location to avoid confusing readers.
## 📸 Catalog
Preview images for each part. Generate with `scadm export-png`:
| Part | Preview |
|------|---------|
| Part Name |  |
kellerlab-release-please Bot
added a commit
that referenced
this pull request
May 11, 2026
🤖 I have created a release *beep* *boop* --- ## [0.3.2](pre-commit-hooks-v0.3.1...pre-commit-hooks-v0.3.2) (2026-05-09) ### 📚 Documentation * update copilot instructions for scadm export-png and ADR convention ([#16](#16)) ([9557df4](9557df4)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: kellerlab-release-please[bot] <246533846+kellerlab-release-please[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📦 What
export-pngreferences in openscad and markdown instructionskebab-case-title.md(no numeric prefixes)💡 Why
Keeps copilot instructions in sync across all kellerlabs repos after
scadm export-pngmigration.🔧 How
Doc-only changes. No functional impact.
📋 Companion PR: kellerlabs/homeracker
feat/export-png