Skills

Skillshare Update Docs

Update website docs to match recent code changes, cross-validating every flag against...

Install

npx skills add runkids/skillshare --skill skillshare-update-docs -g -a claude-code -y
Repository
runkids/skillshare2.9k
Category
Writing
Updated
3d ago
License
MIT
Context cost
Lightabout 1,112 tokens
Runs scripts
No, instructions only

What it does

Update website docs to match recent code changes, cross-validating every flag against source. Use this skill whenever the user asks to: update documentation, sync docs with code, document a new flag or command, fix stale docs, or update the README. This skill covers all website/docs/ categories (commands, reference, understand, how-to, troubleshooting, getting-started) plus the built-in skill description and README. If you just implemented a feature and need to update docs, this is the skill to use. Never manually edit website docs without cross-validating flags against Go source first.

Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command name (e.g., install), commit range, or omit to auto-detect from git diff HEAD~1.

Scope: This skill updates website/docs/, the built-in skill (skills/skillshare/), and README.md. It does NOT write Go code (use implement-feature) or CHANGELOG (use changelog).

Before acting, run python3 scripts/ai-context.py documentation. That topic is the source of truth for documentation ownership, code cross-validation and verification; this skill retains the update workflow.

Workflow

Step 1: Detect Changes

# Auto-detect recently changed code
git diff HEAD~1 --stat -- cmd/skillshare/ internal/

# Also check for structural changes that affect concept/reference docs
git diff HEAD~1 --stat -- internal/config/targets.yaml internal/audit/rules.yaml

Map changed files to affected documentation using this guide:

Command docs (website/docs/reference/commands/):

  • cmd/skillshare/<cmd>.go → website/docs/reference/commands/<cmd>.md
  • Flag changes, new subcommands, output format changes

Concept docs (website/docs/understand/):

  • internal/audit/ → understand/audit-engine.md
  • internal/sync/ → understand/sync-modes.md, understand/source-and-targets.md
  • internal/install/tracked.go → understand/tracked-repositories.md
  • internal/config/ → understand/declarative-manifest.md
  • .skillshare/ project config changes → understand/project-skills.md
  • skills/skillshare/SKILL.md format → understand/skill-format.md

Reference docs (website/docs/reference/):

  • internal/config/targets.yaml → reference/targets/
  • internal/audit/rules.yaml → reference/commands/audit-rules.md
  • reference/appendix/ for CLI quick-reference tables

How-to guides (website/docs/how-to/):

  • New workflow patterns → how-to/daily-tasks/, how-to/advanced/, how-to/recipes/
  • Sharing/org features → how-to/sharing/
Read the whole SKILL.md on GitHub

More in Writing