doc-sync
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.
Here's a thinking process: 1. **Analyze the Request:** - **Goal:** Write a 2-3 sentence plain-text summary in English - **Subject:** An AI agent skill for maintaining documentation sync with code/project structure - **Key Points to Cover:** What it does, what problem it solves, when to use it - **Constraints:** - Objective, factual tone - No marketing language, superlatives, calls to action - Natural prose, no keywords stuffing - No bullet points, no headings, no markdown formatting - No quotes wrapping the answer - At most 60 words - **Output:** ONLY the summary text 2.
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.
Categories
Install
npx skillscat add dtsvetkov1/agent-rules/doc-sync Install via the SkillsCat registry.