Skillshare update docs skill
Update website docs to match recent code changes, cross-validating every flag against source.
by runkids·MIT license·★ 2,712 Stars on the repo·GitHub ↗
npx degit runkids/skillshare/.skillshare/skills/skillshare-update-docs#main ~/.claude/skills/skillshare-update-docsChecked ·commit main
Files of Skillshare update docs
Show the full text136 lines
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.mdinternal/sync/→understand/sync-modes.md,understand/source-and-targets.mdinternal/install/tracked.go→understand/tracked-repositories.mdinternal/config/→understand/declarative-manifest.md.skillshare/project config changes →understand/project-skills.mdskills/skillshare/SKILL.mdformat →understand/skill-format.md
Reference docs (website/docs/reference/):
internal/config/targets.yaml→reference/targets/internal/audit/rules.yaml→reference/commands/audit-rules.mdreference/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:
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 ofcmd/skillshare/<cmd>.go;ss <cmd> --helpinside the devcontainer lists them too.Read the corresponding doc page:
website/docs/reference/commands/<cmd>.mdCompare and fix:
- New flags in code → add to docs with usage example
- Removed flags from code → remove from docs
- Changed behavior → update description
- Every
--flagin 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:
- Read
skills/skillshare/SKILL.md - Check if the built-in skill description needs updating
- 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.
| 1 | |
| 2 | name skillshare-update-docs |
| 3 | description >- |
| 4 | Update website docs to match recent code changes, cross-validating every flag |
| 5 | against source. Use this skill whenever the user asks to: update documentation, |
| 6 | sync docs with code, document a new flag or command, fix stale docs, or update |
| 7 | the README. This skill covers all website/docs/ categories (commands, reference, |
| 8 | understand, how-to, troubleshooting, getting-started) plus the built-in skill |
| 9 | description and README. If you just implemented a feature and need to update |
| 10 | docs, this is the skill to use. Never manually edit website docs without |
| 11 | cross-validating flags against Go source first. |
| 12 | argument-hint "[command-name | commit-range]" |
| 13 | metadata |
| 14 | targets [claude, universal] |
| 15 | |
| 16 | |
| 17 | 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`. |
| 18 | |
| 19 | **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`). |
| 20 | |
| 21 | 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. |
| 22 | |
| 23 | ## Workflow |
| 24 | |
| 25 | ### Step 1: Detect Changes |
| 26 | |
| 27 | |
| 28 | # Auto-detect recently changed code |
| 29 | git diff HEAD~1 --stat -- cmd/skillshare/ internal/ |
| 30 | |
| 31 | # Also check for structural changes that affect concept/reference docs |
| 32 | git diff HEAD~1 --stat -- internal/config/targets.yaml internal/audit/rules.yaml |
| 33 | |
| 34 | |
| 35 | Map changed files to affected documentation using this guide: |
| 36 | |
| 37 | **Command docs** (`website/docs/reference/commands/`): |
| 38 | `cmd/skillshare/<cmd>.go` → `website/docs/reference/commands/<cmd>.md` |
| 39 | Flag changes, new subcommands, output format changes |
| 40 | |
| 41 | **Concept docs** (`website/docs/understand/`): |
| 42 | `internal/audit/` → `understand/audit-engine.md` |
| 43 | `internal/sync/` → `understand/sync-modes.md`, `understand/source-and-targets.md` |
| 44 | `internal/install/tracked.go` → `understand/tracked-repositories.md` |
| 45 | `internal/config/` → `understand/declarative-manifest.md` |
| 46 | `.skillshare/` project config changes → `understand/project-skills.md` |
| 47 | `skills/skillshare/SKILL.md` format → `understand/skill-format.md` |
| 48 | |
| 49 | **Reference docs** (`website/docs/reference/`): |
| 50 | `internal/config/targets.yaml` → `reference/targets/` |
| 51 | `internal/audit/rules.yaml` → `reference/commands/audit-rules.md` |
| 52 | `reference/appendix/` for CLI quick-reference tables |
| 53 | |
| 54 | **How-to guides** (`website/docs/how-to/`): |
| 55 | New workflow patterns → `how-to/daily-tasks/`, `how-to/advanced/`, `how-to/recipes/` |
| 56 | Sharing/org features → `how-to/sharing/` |
| 57 | |
| 58 | **Troubleshooting** (`website/docs/troubleshooting/`): |
| 59 | New error messages → `troubleshooting/common-errors.md` |
| 60 | FAQ additions → `troubleshooting/faq.md` |
| 61 | |
| 62 | **Getting started** (`website/docs/getting-started/`): |
| 63 | Breaking changes to init/install flow → `getting-started/first-sync.md` |
| 64 | Quick reference updates → `getting-started/quick-reference.md` |
| 65 | |
| 66 | **Learn** (`website/docs/learn/`): |
| 67 | New target integrations → `learn/with-<tool>.md` |
| 68 | |
| 69 | ### Step 2: Cross-Validate Flags |
| 70 | |
| 71 | For each affected command: |
| 72 | |
| 73 | 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. |
| 74 | |
| 75 | Read the corresponding doc page: |
| 76 | |
| 77 | website/docs/reference/commands/<cmd>.md |
| 78 | |
| 79 | |
| 80 | Compare and fix: |
| 81 | **New flags** in code → add to docs with usage example |
| 82 | **Removed flags** from code → remove from docs |
| 83 | **Changed behavior** → update description |
| 84 | **Every `--flag` in docs** must appear as a string literal in the command's source |
| 85 | |
| 86 | ### Step 3: Update Documentation |
| 87 | |
| 88 | Apply changes following existing doc conventions: |
| 89 | Match heading structure of neighboring doc pages |
| 90 | Include CLI examples with expected output |
| 91 | Keep flag tables consistent in format |
| 92 | |
| 93 | ### Step 4: Check Built-in Skill |
| 94 | |
| 95 | If changes affect user-visible CLI behavior: |
| 96 | |
| 97 | Read `skills/skillshare/SKILL.md` |
| 98 | Check if the built-in skill description needs updating |
| 99 | Verify description stays under 1024 characters (CodeX limit) |
| 100 | |
| 101 | ### Step 5: Check README |
| 102 | |
| 103 | Review `README.md` for sections that may need updates: |
| 104 | Recent Updates callout |
| 105 | Why skillshare bullet points (5 selling points) |
| 106 | Highlights section (core feature examples) |
| 107 | |
| 108 | ### Step 6: Build Verification |
| 109 | |
| 110 | |
| 111 | docker exec "$CONTAINER" bash -c 'cd /workspace/website && npm run build' # as the Website Pages workflow builds |
| 112 | |
| 113 | |
| 114 | Confirm no broken links or build errors. |
| 115 | |
| 116 | ### Step 7: Report |
| 117 | |
| 118 | List all changes made with rationale: |
| 119 | |
| 120 | == Documentation Updates == |
| 121 | |
| 122 | Modified: |
| 123 | website/docs/reference/commands/install.md |
| 124 | - Added --into flag documentation |
| 125 | - Updated install examples |
| 126 | |
| 127 | skills/skillshare/SKILL.md |
| 128 | - Added --into to feature list (desc: 987/1024 chars) |
| 129 | |
| 130 | Build: PASS (no broken links) |
| 131 | |
| 132 | |
| 133 | ## Rules |
| 134 | |
| 135 | Apply the `documentation` topic. Keep this adapter scoped to documentation; use the implementation or release workflows for other changes. |
| 136 |
Discussion
Alternatives
Browse more free Claude skills or everything in Development.