sync-docs
Installation
SKILL.md
Update and maintain project documentation for CLAUDE.md and README.md:
1. CLAUDE.md Management
Purpose: Keep Claude's project instructions current and accurate
- Scan project structure: Check for new tools, scripts, build systems
- Update build commands: Sync with package.json, Makefile, or build configs
- Add new patterns: Document coding conventions, file organization
- Refresh tool commands: Update linting, testing, deployment instructions
- Check environment setup: Verify installation and setup steps
2. README.md Maintenance
Purpose: Keep public project documentation up-to-date
- Update installation: Check dependencies, requirements, setup steps
- Refresh usage examples: Verify code samples and API documentation
- Validate links: Test external links, badges, and references
- Update project status: Current features, roadmap, version info
- Check screenshots/demos: Ensure visual examples are current
Related skills
More from ruchernchong/claude-kit
create-branch
Create and checkout a new git branch with smart validation and GitHub issue integration
1.2Kcreate-issue
Create a GitHub issue with title and description (auto-assigned)
9folder-org
Project code structure and file organization. Use when creating files, organizing components, or deciding where code should live. (project)
8update-issue
Update a GitHub issue with new title, body, labels, or assignees
8security
Run security audit with GitLeaks pre-commit hook setup and code analysis
7commit
Smart git commit with short, concise messages
6