Skip to content

docs: show npx form for the sg-material commands - #45

Merged
changeroa merged 1 commit into
changeroa:mainfrom
ayden94:docs/material-npx-commands
Sep 23, 2026
Merged

changeroa merged 1 commit into
changeroa:mainfrom
ayden94:docs/material-npx-commands

Conversation

@ayden94

@ayden94 ayden94 commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Summary

The Material v2 block shows only the global-install form (sg-material ...). That form is not reachable through npx:

$ npx stylegallery sg-material discover
{"ok": false, "failures": [{"code": "command_unknown", "message": "unknown command sg-material", "path": "command"}]}

The working form is npx --package stylegallery sg-material ..., which matches the npx --package stylegallery stylegallery-mcp form already used in the MCP section above.

Changes

  • README.md only: npx forms for discover, search --paths-only, and context, plus one sentence noting the global-install form.

Evidence

Verified against the published package (stylegallery@0.1.7):

$ npx --package stylegallery sg-material discover
{"ok": true, "operation": "material-discover", ...}

Local validation on origin/main (70fde7d):

node scripts/validate-okf.mjs --json    -> "ok": true, "failures": []
node scripts/validate-links.mjs --json  -> "ok": true, "failures": []
node scripts/validate-ia.mjs --json     -> "ok": true, "failures": []

No validator changes, no generated artifacts touched.

@ayden94
ayden94 requested a review from changeroa as a code owner September 23, 2026 01:44

@changeroa changeroa left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Thank you @ayden94 for filling this setup gap.

Verified all three documented npx commands against the published package: discover, search --paths-only, and bounded context all succeed.

The change is correctly scoped to README guidance; no runtime refactor is needed. The combined landing also passes OKF, links, IA, governance, and the full material test suite. README is admitted material, so its changed bytes require a registry refresh: I reproduced material_source_hash_mismatch and regenerated the registry in a separate maintainer commit. Your original commit and authorship are preserved on land/pr-45-46. Full CI will be checked before advancing main.

consumer_reference: consumer-reference/agent-native/registry.json

@changeroa
changeroa merged commit 41de554 into changeroa:main Sep 23, 2026
@changeroa

Copy link
Copy Markdown
Owner

Landed on main with your original commit and authorship preserved. Thanks @ayden94 for improving Material setup documentation in #45.

The only maintainer addition is the generated README registry refresh in 2a9ae14, required because README is admitted material. All six validation jobs passed on that exact commit: https://github.com/changeroa/StyleGallery/actions/runs/35808591172

This is a repository documentation update; no new npm release was published.

islee23520 pushed a commit to islee23520/GameUIStyleGallery that referenced this pull request Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants