doc-sync
OfficialKeep docs in sync with code.
AuthorBoardPandas
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill ensures your project documentation accurately reflects the current state of your codebase, preventing outdated information and improving developer onboarding and maintenance.
Core Features & Use Cases
- Stale Doc Detection: Identifies documentation referencing non-existent code elements or APIs.
- Missing Doc Identification: Pinpoints public APIs, endpoints, or configurations lacking any documentation.
- Consistency Checks: Verifies code examples, version numbers, and file paths within documentation against the codebase.
- Use Case: After a major refactor, run this Skill to automatically find and flag all the README sections that now point to deprecated functions or incorrect file paths.
Quick Start
Run the doc-sync skill to synchronize documentation with the current codebase.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doc-sync Download link: https://github.com/BoardPandas/project-coder/archive/main.zip#doc-sync Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.