Repository navigation
docs: clarify installation and first use - #36
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. Summary
Merge Risk:
 |
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.
Summary
First-time users had to infer the prerequisites, installation scope, and how to confirm that a skill was ready to use. The root and both skill READMEs now walk through prerequisites, explicit Claude Code/Codex installation commands, installation checks, and a first request in English, Korean, Japanese, and Simplified Chinese.
Clarify that
npx skillsneeds Node.js 22.20+ and Git, distinguish global from project installation, and explain that the server/browser tools used for 3D validation are prepared separately. Replace skill README links to repository-level files with GitHub URLs so they remain usable after standalone installation.The documented shell commands install skill files into the chosen agent/scope or list installed skills; the version commands only inspect the environment. The changed external links point to this repository and its existing license/contribution guide. Skill execution instructions and assets are unchanged.
Closes #35
Type of change
SKILL.md,references/, orassets/)How I verified it
node scripts/check-readme-translations.mjs— all 12 READMEs pass; code blocks, URLs, images, table rows, language switches, and relative links are consistent.git diff --check— passes.Checklist
node scripts/check-readme-translations.mjspasses (or I only changed things it does not cover)ENGINEintemplate.html, I applied the same change toexample-agent-sandbox.html, andnode scripts/check-templates.mjspasses (not applicable)UI_TEXTkey, I added it foren,ko,ja, andzh-CN, andnode scripts/check-templates.mjspasses (not applicable)references/preferences.md, generated pages, or verification screenshots