Skip to content
alyn
runkids

Skillshare Update Docs skill

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.

$npx skills add runkids/skillshare --skill skillshare-update-docs
View this skill on GitHubrunkids/skillshare/.skillshare/skills/skillshare-update-docs/SKILL.md
Pack stars
3,012
Pack installs
48
Alyn Score
52/99
Updated
7 h ago
License
MIT
– views – installs via Alyn

Install Skillshare Update Docs

Pick your agent. Every command is ready to paste.

$npx skills add runkids/skillshare --skill skillshare-update-docs

The open skills CLI detects your agents (Claude Code, Cursor, Codex and 70+ more) and installs to the right folder. Add -g to install globally.

01

Install it

Run the command above, or upload the folder in Claude.

02

Ask naturally

Describe the task. Your agent loads skillshare-update-docs when the request matches its description.

03

Name it if needed

If it does not trigger, say “use the skillshare-update-docs skill”. In Codex, type $skillshare-update-docs.

The skill itself

SKILL.md

FolderGitHub

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/

Troubleshooting (website/docs/troubleshooting/):

  • New error messages → troubleshooting/common-errors.md
  • FAQ additions → troubleshooting/faq.md

Getting started (website/docs/getting-started/):

  • Breaking changes to init/install flow → getting-started/first-sync.md
  • Quick reference updates → getting-started/quick-reference.md

Learn (website/docs/learn/):

  • New target integrations → learn/with-<tool>.md

Step 2: Cross-Validate Flags

For each affected command:

  1. Read the Go source to extract actual flags and behavior. Commands parse arguments by hand, so flags appear as string literals ("--force") in the parse function of cmd/skillshare/<cmd>.go; ss <cmd> --help inside the devcontainer lists them too.

  2. Read the corresponding doc page:

    website/docs/reference/commands/<cmd>.md
    
  3. Compare and fix:

    • New flags in code → add to docs with usage example
    • Removed flags from code → remove from docs
    • Changed behavior → update description
    • Every --flag in docs must appear as a string literal in the command's source

Step 3: Update Documentation

Apply changes following existing doc conventions:

  • Match heading structure of neighboring doc pages
  • Include CLI examples with expected output
  • Keep flag tables consistent in format

Step 4: Check Built-in Skill

If changes affect user-visible CLI behavior:

  1. Read skills/skillshare/SKILL.md
  2. Check if the built-in skill description needs updating
  3. Verify description stays under 1024 characters (CodeX limit)

Step 5: Check README

Review README.md for sections that may need updates:

  • Recent Updates callout
  • Why skillshare bullet points (5 selling points)
  • Highlights section (core feature examples)

Step 6: Build Verification

docker exec "$CONTAINER" bash -c 'cd /workspace/website && npm run build'   # as the Website Pages workflow builds

Confirm no broken links or build errors.

Step 7: Report

List all changes made with rationale:

== Documentation Updates ==

Modified:
  website/docs/reference/commands/install.md
    - Added --into flag documentation
    - Updated install examples

  skills/skillshare/SKILL.md
    - Added --into to feature list (desc: 987/1024 chars)

Build: PASS (no broken links)

Rules

Apply the documentation topic. Keep this adapter scoped to documentation; use the implementation or release workflows for other changes.

Tips for Skillshare Update Docs

  • • Start a fresh session after installing so your agent picks up the new skill.
  • • It is part of a pack with 10 skills. Install only the ones you need with --skill to keep triggers precise.
  • • If two skills overlap, mention the one you want by name.

Questions about Skillshare Update Docs

What does the Skillshare Update Docs skill do?

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.

How do I install Skillshare Update Docs?

Run "npx skills add runkids/skillshare --skill skillshare-update-docs" in your project. The skills CLI installs it for Claude Code, Cursor, Codex and 70+ other agents. In Claude on the web, upload the skill folder as a ZIP under Customize > Skills.

Does Skillshare Update Docs work in Cursor and Codex?

Yes. Skillshare Update Docs uses the open SKILL.md format, so it works in Claude Code, Claude, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot and other agents that support agent skills.

Is Skillshare Update Docs free?

Skillshare Update Docs is open source on GitHub under the MIT license. It is free to install; check the license before commercial use.

Who made Skillshare Update Docs?

Skillshare Update Docs is published by runkids in the runkids/skillshare repository, together with 9 other skills.

Similar skills. From other creators.