sync-docs

Featured

Sync documentation with code. Use when user asks to update docs, check docs, fix stale documentation, update changelog, or after code changes.

AI & Automation 967 stars 111 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 99/100

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

Skill Content

# sync-docs Unified skill for syncing documentation with code state. Combines discovery, analysis, and CHANGELOG update into a single workflow. ## Parse Arguments ```javascript const args = '$ARGUMENTS'.split(' ').filter(Boolean); const mode = args.find(a => ['report', 'apply'].includes(a)) || 'report'; const scope = args.find(a => a.startsWith('--scope='))?.split('=')[1] || 'recent'; const includeUndocumented = args.includes('--include-undocumented'); ``` ## Quick Start - Agent Instructions **Step 1**: Get changed files (use Bash): ```bash # Recent changes (default scope) git diff --name-only origin/main..HEAD 2>/dev/null || git diff --name-only HEAD~5..HEAD # Or for all files git ls-files '*.md' ``` **Step 2**: Find docs that reference changed files (use Grep): - Search for filenames, function names, class names in `*.md` files - Check README.md, CHANGELOG.md, docs/*.md **Step 3**: Analyze each doc for issues: - Version mismatches (compare doc versions to package.json) - Removed exports (symbols in docs but not in code) - Outdated code examples - Import path changes **Step 4**: Check CHANGELOG: - Look for `## [Unreleased]` section - Compare recent commit messages to CHANGELOG entries **Step 5**: If repo-map exists (`{stateDir}/repo-map.json` - platform state directory): - Load it to get accurate export list - Find exports not mentioned in any documentation - Report as `undocumented-export` issues ## Input Arguments: `[report|apply] [--scope=all|recent|before-pr]...

Details

Author
agent-sh
Repository
agent-sh/agentsys
Created
7 months ago
Last Updated
4 days ago
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category