ruchernchong/sync-docs
skills/sync-docs/SKILL.md
Update and maintain CLAUDE.md and README.md documentation
documentation
Updated May 19, 2026
$ install --global
skillsauthnpx skillsauth add ruchernchong/claude-kit sync-docsInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 19, 2026, 2:03 AM175.6s1 file scanned
SKILL.md
- name:
- sync-docs
- description:
- Update and maintain CLAUDE.md and README.md documentation
- allowed-tools:
- Read(*) Write(*) Edit(*) MultiEdit(*) Glob(*) Grep(*) Bash(npm*) Bash(yarn*) Bash(find*) Bash(ls*) WebFetch(*)
- model:
- sonnet
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
3. Smart Detection Process
- File existence: Create CLAUDE.md or README.md if missing
- Project analysis: Scan codebase for changes since last update
- Cross-reference: Compare project structure with documented instructions
- Outdated sections: Identify stale information automatically
- Consistency check: Ensure both files complement each other
4. Validation Steps
- Run project commands mentioned in docs to verify they work
- Test installation steps from scratch perspective
- Validate all external links and references
- Check that CLAUDE.md instructions match current project setup
- Ensure README.md accurately represents current project state
Focus on keeping both files synchronized with the actual project state and useful for their respective audiences: Claude for CLAUDE.md, users/developers for README.md.
Related Skills
ruchernchong/update-issue
tools
VerifiedTrustedCommunity
Update a GitHub issue with new title, body, labels, or assignees
SKILL.mdUpdated May 19, 2026
ruchernchong/tailwind
development
VerifiedTrustedCommunity
Audit and fix Tailwind CSS anti-patterns. Enforces spacing direction (bottom-only), size-* usage, gap preference, 8px grid, and other best practices.
SKILL.mdUpdated May 19, 2026
ruchernchong/security
development
VerifiedTrustedCommunity
Run security audit with GitLeaks pre-commit hook setup and code analysis
SKILL.mdUpdated May 19, 2026
ruchernchong/skills/heroui
development
VerifiedTrustedCommunity
--- name: heroui description: Build accessible UIs using HeroUI v3 components (React + Tailwind CSS v4 + React Aria). Use when creating React interfaces, selecting UI components, implementing forms, navigation, overlays, or data display. Use when installing HeroUI v3, customizing themes, accessing component documentation, building with compound components, or working with component APIs. Keywords: HeroUI, Hero UI, heroui, React Aria, accessible components, Tailwind CSS v4, @heroui/react@beta, @h
SKILL.mdUpdated May 19, 2026