What problem does it solve?
Outdated or inconsistent documentation for dotfiles leads to confusion, incorrect usage, and wasted time for both the user and other developers trying to understand the setup. This Skill automates the tedious process of keeping your docs current.
Core Features & Use Cases
- Documentation Synchronisation: Ensures both
CLAUDE.md (technical details for AI) and README.md (user-facing guide) are consistent and reflect the latest configuration.
- Content Updates: Automatically updates documentation to reflect changes in Homebrew packages, shell aliases, new scripts, and other configuration modifications.
- Accuracy Verification: Checks that documented command examples, file paths, and package lists precisely match the actual setup, preventing misleading information.
- Use Case: After adding new Homebrew packages and Git aliases, use this Skill to automatically update both your
README.md and CLAUDE.md files, ensuring your documentation is always current, accurate, and ready for others (or your future self) to reference.
Quick Start
Update the documentation for the new packages I added to my Brewfile.