-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
component:docsDocumentation filesDocumentation filescomponent:skillSkills layerSkills layerdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort:small< 1 hour< 1 hourgood first issueGood for newcomersGood for newcomerspriority:mediumShould be addressedShould be addressed
Description
Which documentation needs improvement?
- Skill documentation
- README.md
Specific Location
plugins/plugin-dev/skills/hook-development/SKILL.md- Add prerequisitesplugins/plugin-dev/README.md- Add requirements section
What's unclear or missing?
Several utility scripts require external tools that aren't documented as dependencies:
jqis required for JSON validation in multiple scriptsbash 4.0+is required for certain syntax (e.g., associative arrays,${var,,})grepwith-Esupport (ERE)sed(GNU or BSD compatible)
Users may encounter confusing errors if these tools are missing or outdated.
Suggested Improvement
Add a Prerequisites section:
## Prerequisites
The utility scripts in this plugin require:
| Tool | Version | Purpose |
|------|---------|---------|
| bash | 4.0+ | Shell scripting with modern features |
| jq | 1.6+ | JSON parsing and validation |
| grep | - | Pattern matching (with `-E` support) |
| sed | - | Stream editing (GNU or BSD) |
### Checking Your Environment
\`\`\`bash
# Check versions
bash --version | head -1
jq --version
grep --version | head -1
\`\`\`Type of issue
- Missing information
Additional Context
Scripts affected:
validate-hook-schema.sh- requires jqparse-frontmatter.sh- requires sed, grepvalidate-agent.sh- requires grep with ERE- Multiple others
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
component:docsDocumentation filesDocumentation filescomponent:skillSkills layerSkills layerdocumentationImprovements or additions to documentationImprovements or additions to documentationeffort:small< 1 hour< 1 hourgood first issueGood for newcomersGood for newcomerspriority:mediumShould be addressedShould be addressed