Skip to content

docs: replace placeholder install commands with real repo references - #12

Closed
netrajpatel wants to merge 2 commits into
mainfrom
docs/fix-readme-install-commands
Closed

netrajpatel wants to merge 2 commits into
mainfrom
docs/fix-readme-install-commands

Conversation

@netrajpatel

Copy link
Copy Markdown
Contributor

Summary

  • Filled in the <this-repo> placeholder across the Claude Code, Gemini CLI, and skills CLI install snippets so every command in the README is directly copy-pasteable (contentstack/contentstack-agent-skills shorthand where supported, full https://github.com/... URL for Gemini CLI, which requires it).
  • Expanded the skills CLI section from one example to four: whole-bundle install, single-skill shorthand (@<skill-slug>), single-skill via full URL + --skill flag, and multi-skill install via repeated --skill flags — all verified by running them live against this repo (read-only --list mode).
  • Delinked the "skills CLI" bullet from github.com/anthropics/skills — that repo documents the SKILL.md file format, not this CLI's command syntax, so the link was pointing readers at the wrong project.

Test plan

  • Ran npx skills add contentstack/contentstack-agent-skills --list — confirmed shorthand resolves and lists all 21 skills
  • Ran the @<skill-slug> and --skill flag forms against the real repo — confirmed they parse without error
  • Confirmed --list mode performs no local writes (no changes to ~/.claude/skills or ~/.agents/skills)
  • Manual visual check of rendered README on GitHub

🤖 Generated with Claude Code

Fill in the <this-repo> placeholder across Claude Code, Gemini CLI, and
skills-CLI install snippets so they're directly copy-pasteable, expand
the skills-CLI section to cover whole-bundle/single-skill/multi-skill
installs, and delink the "skills CLI" reference to anthropics/skills
since that repo documents the SKILL.md format, not this command.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netrajpatel
netrajpatel requested a review from a team July 9, 2026 14:37
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 0 0 30 / 120 days ✅ Passed
🟡 Medium 0 0 90 / 365 days ✅ Passed
🔵 Low 0 0 180 / 365 days ✅ Passed

✅ BUILD PASSED - All security checks passed

@aniket-shikhare-cstk aniket-shikhare-cstk left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

@netrajpatel
netrajpatel marked this pull request as draft July 10, 2026 07:37
@netrajpatel
netrajpatel marked this pull request as ready for review July 10, 2026 07:37
@github-actions

Copy link
Copy Markdown

🔒 Security Scan Results

ℹ️ Note: Only vulnerabilities with available fixes (upgrades or patches) are counted toward thresholds.

Check Type Count (with fixes) Without fixes Threshold Result
🔴 Critical Severity 0 0 10 ✅ Passed
🟠 High Severity 0 0 25 ✅ Passed
🟡 Medium Severity 0 0 500 ✅ Passed
🔵 Low Severity 0 0 1000 ✅ Passed

⏱️ SLA Breach Summary

✅ No SLA breaches detected. All vulnerabilities are within acceptable time thresholds.

Severity Breaches (with fixes) Breaches (no fixes) SLA Threshold (with/no fixes) Status
🔴 Critical 0 0 15 / 30 days ✅ Passed
🟠 High 0 0 30 / 120 days ✅ Passed
🟡 Medium 0 0 90 / 365 days ✅ Passed
🔵 Low 0 0 180 / 365 days ✅ Passed

✅ BUILD PASSED - All security checks passed

timbenniks-contentstack added a commit that referenced this pull request Oct 14, 2026
- validate.mjs checks relative links in all markdown under skills/
- CHANGELOG.md with the 0.2.0 release notes; release steps mention it
- README: multi-skill skills CLI example (from PR #12 by @netrajpatel)

Co-authored-by: Netraj Patel (Contentstack) <netrajpatel@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
timbenniks-contentstack added a commit that referenced this pull request Oct 14, 2026
- validate.mjs checks relative links in all markdown under skills/
- CHANGELOG.md with the 0.2.0 release notes; release steps mention it
- README: multi-skill skills CLI example (from PR #12 by @netrajpatel)

Co-authored-by: Netraj Patel (Contentstack) <netraj.patel@contentstack.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@timbenniks-contentstack

Copy link
Copy Markdown
Contributor

Thanks @netrajpatel, and for being the first to replace those <this-repo> placeholders! Your change is now part of #21, the combined 0.2.0 release PR. The install section there builds on it with real commands for every tool, and your example for installing several skills with one command made it into the README. You're credited in the PR description and as co-author on the commit. Closing in favour of #21.

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.

4 participants