skillshare-update-docs
- Repo stars 1,897
- Author updated Live
- Author repo skillshare
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @runkids · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- macOS · Linux · Windows
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: skillshare-update-docs
description: >- Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command na…
category: documentation
runtime: no special runtime
---
# skillshare-update-docs output preview
## PART A: Task fit
- Use case: >- 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. runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “>- 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. runs entirely locally. Works with Claude Code, Cursor, Cline and 23 more.”.
- **02** When the source has headings, the agent prioritizes “Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. The source does not require a stable slash command. After installation, invoke the skill by name and describe the task.
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files.
Start with a small task and check whether the result follows “Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags”. Inspect diffs, logs, previews, or tests before expanding scope.
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: skillshare-update-docs
description: >- Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command na…
category: documentation
source: runkids/skillshare
---
# skillshare-update-docs
## When to use
- >- Sync website documentation with recent code changes. $ARGUMENTS specifies scope: a command name (e.g., install), co…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags” and keep inference separate from source facts.
- read files, write/modify files; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "skillshare-update-docs" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Workflow / Step 1: Detect Changes / Step 2: Cross-Validate Flags
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
} 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 only updates website/docs/. It does NOT write Go code (use implement-feature) or CHANGELOG (use changelog).
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:
grep -n 'flag\.\|Usage\|Args' cmd/skillshare/<cmd>.goRead the corresponding doc page:
website/docs/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 have a matchinggrephit in 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
cd website && npm run build
Confirm no broken links or build errors.
Step 7: Report
List all changes made with rationale:
== Documentation Updates ==
Modified:
website/docs/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
- Source of truth is code — docs must match what the code actually does
- Every flag claim must be verified — grep source before writing docs
- No speculative docs — never document planned but unimplemented features
- No code changes — this skill only touches
website/docs/,skills/skillshare/SKILL.md, andREADME.md - Preserve style — match existing doc page structure and tone
- Built-in skill desc limit — must stay under 1024 characters
Decide Fit First
Design Intent
How To Use It
Boundaries And Review