skillshare-update-docs

Solid

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.

AI & Automation 2,072 stars 130 forks Updated today MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

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 ```bash # 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/app...

Details

Author
runkids
Repository
runkids/skillshare
Created
4 months ago
Last Updated
today
Language
Go
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

skillshare-changelog

Generate CHANGELOG.md entry from recent commits in conventional format. Also syncs the website changelog page. Use this skill whenever the user asks to: generate a changelog, document what changed between tags, or create a new CHANGELOG entry. If you see requests like "write the changelog for v0.17", "what changed since last release", this is the skill to use. Do NOT manually edit CHANGELOG.md without this skill — it ensures proper formatting, user-perspective writing, and website changelog sync. For full release workflows (tests, changelog, release notes, version bump, announcements), use /release instead.

2,072 Updated today
runkids
AI & Automation Solid

doc-updates

Update documentation after code changes with quality gates, slop detection, consolidation, and accuracy verification.

294 Updated today
athola
Data & Documents Solid

skillshare-codebase-audit

Cross-validate CLI flags, docs, tests, and targets for consistency across the codebase. Use this skill whenever the user asks to: audit the codebase, check for consistency issues, find undocumented flags, verify test coverage, validate targets.yaml, check handler split conventions, or verify oplog instrumentation. This is a read-only audit — it reports issues but never modifies files. Use after large refactors, before releases, or whenever you suspect docs/code/tests have drifted out of sync.

2,072 Updated today
runkids
Data & Documents Solid

sync-skills

(project) Use when a skill in skills/ has its name or description changed, or is added or removed — syncs README.md, settings.json, and hal_dotfiles.json

115 Updated 4 days ago
vinta
Data & Documents Listed

doc-sync

Keeps IdeaVim documentation in sync with code changes. Use this skill when you need to verify documentation accuracy after code changes, or when checking if documentation (in doc/, README.md, CONTRIBUTING.md) matches the current codebase. The skill can work bidirectionally - from docs to code verification, or from code changes to documentation updates.

335 Updated today
aiskillstore