doc-sync

dtsvetkov1's avatarfrom dtsvetkov1

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.

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 27, 2025
[Technical Writing]

When & Why to Use This Skill

The Doc Sync skill is designed to automate the maintenance of project documentation, ensuring that files like README.md, AGENTS.md, and architectural guides stay perfectly aligned with the actual codebase. It eliminates the 'documentation rot' that occurs during rapid development by verifying directory structures, updating library references, and validating cross-file links, ultimately serving as a guardian for your project's Source of Truth.

Use Cases

  • Architectural Refactoring: Automatically update project structure descriptions in README.md when folders are moved or renamed during a major refactor.
  • AI Context Optimization: Keep AGENTS.md and .cursor/rules updated with the latest coding patterns and library choices to ensure AI assistants have the correct context for code generation.
  • Dependency Onboarding: When adding new state management or UI libraries, use the skill to propagate these changes across technical guidelines and setup instructions.
  • Consistency Auditing: Synchronize version numbers between package.json and documentation files to ensure users and CI/CD pipelines are referencing the correct release information.
namedoc-sync
descriptionEnsures 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.

Doc Sync Skill

This skill helps maintain the "Source of Truth" in your documentation.

Instructions

  1. Verify Structure: Compare the actual directory structure with what is documented in README.md.
  2. Update Guidelines: If a new library is added (e.g., a new state manager), update AGENTS.md, .cursor/rules/ and docs/ files if needed.
  3. Cross-Reference: Ensure that links between documentation files are valid.
  4. Version Sync: Keep version numbers in package.json and documentation consistent.

Best Practices

  • Keep README.md focused on setup and high-level architecture.
  • Use AGENTS.md for AI-specific instructions and coding patterns.
  • Regularly update MCP.md if new tools are added to the environment.