claude-settings/commands/doc-sync.md

Documentation Sync

Update all project documentation to reflect recent changes.

Documentation Files to Review

Core Documentation

1. README.md - Entry point and quick start

   • Is the project description current?
   • Are installation steps accurate?
   • Do examples still work?
   • Are links valid?

2. CLAUDE.md - Project-specific AI context

   • Are critical system notes up to date?
   • Do file paths still exist?
   • Are workflows current?
   • Any new gotchas to document?

3. Feature Status/Changelog

   • Document new features
   • Mark fixed issues as resolved
   • Update version numbers if applicable

User Guides

Check each guide in docs/guides/:

• Are commands still correct?
• Do examples work as written?
• Are screenshots up to date (if any)?
• Cross-references still valid?

API Documentation

If applicable:

• Function signatures match implementation?
• Parameter descriptions accurate?
• Return values correct?
• Examples tested?

Troubleshooting

• Add new issues encountered
• Update solutions if procedures changed
• Remove obsolete issues
• Test all diagnostic commands

Update Process

1. Identify changes:

   git log --since="1 week ago" --oneline
   git diff HEAD~10..HEAD --stat
   

2. Check for breaking changes:

   • API changes
   • Configuration format changes
   • Dependency updates
   • Command line interface changes

3. Update affected documentation:

   • Use the Read tool to check current content
   • Use the Edit tool to make precise changes
   • Maintain consistent formatting
   • Update "Last Modified" dates

4. Verify cross-references:

   • Check all links still work
   • Update paths if files moved
   • Ensure examples reference correct files

5. Test examples:

   • Run all code examples
   • Verify output matches documentation
   • Update if behavior changed

6. Commit documentation updates:

   git add docs/ README.md CLAUDE.md
   git commit -m "docs: sync documentation with recent changes"
   

Checklist

• README.md reviewed and updated
• CLAUDE.md reflects current state
• All guides checked for accuracy
• Code examples tested
• Cross-references validated
• Breaking changes documented
• Version updated (if applicable)
• Commit message follows conventions