Synchronizes and maintains consistency across repository documentation files and agent configurations automatically.
The Docs Sync skill automates the tedious task of keeping repository documentation in sync by propagating changes across READMEs, agent guidelines, and project-specific documentation files. It ensures that when commands, paths, or tool behaviors change, those updates are reflected globally within README.md, AGENTS.md, and the .codex directory. By handling automated formatting and basic validation, this skill prevents stale references and conflicting instructions, ensuring that both human contributors and AI agents are working with the most accurate information.
Key Features
01Automated propagation of command and path updates to prevent stale references
020 GitHub stars
03Smart handling of symlinked files to maintain documentation integrity
04Multi-file documentation synchronization across README, AGENTS, and .codex files
05Integrated formatting support using project-specific tools like pnpm format
06Detailed change reporting with specific flags for human review requirements
Use Cases
01Ensuring internal agent instructions stay aligned with public project READMEs
02Updating CLI command syntax across multiple documentation files simultaneously
03Maintaining consistent terminology and examples throughout complex project documentation
