Ensures that documentation files like README.md and AGENTS.md stay in sync with the actual code and project structure. Use when adding new features or changing project architecture.
Install
npx skillscat add dtsvetkov1/agent-rules/doc-sync Install via the SkillsCat registry.
SKILL.md
Doc Sync Skill
This skill helps maintain the "Source of Truth" in your documentation.
Instructions
- Verify Structure: Compare the actual directory structure with what is documented in
README.md. - Update Guidelines: If a new library is added (e.g., a new state manager), update
AGENTS.md,.cursor/rules/anddocs/files if needed. - Cross-Reference: Ensure that links between documentation files are valid.
- Version Sync: Keep version numbers in
package.jsonand documentation consistent.
Best Practices
- Keep
README.mdfocused on setup and high-level architecture. - Use
AGENTS.mdfor AI-specific instructions and coding patterns. - Regularly update
MCP.mdif new tools are added to the environment.