update-documents

To keep project documentation in sync, this tool analyzes sections across CLAUDE.md, README.md, and docs/ to detect differences and update targets based on configurable rules. It performs whitespace-tolerant comparisons to minimize unnecessary edits while maintaining a single source of truth.

Automating markdown documentation synchronization is best handled by configurable rules that analyze sections, detect differences, and update targets while tolerating whitespace variations. This approach minimizes unnecessary edits, creates missing sections, and preserves backups when applying updates.

Yes, you need Python to run the documentation sync scripts. The tool requires Python along with a config/sync_rules.json file and the extractor, writer, and rules loader scripts to perform analysis and updates across project documentation files.

Whitespace-tolerant comparison works by analyzing documentation sections and detecting differences while ignoring minor whitespace variations. This prevents unnecessary edits when synchronizing CLAUDE.md, README.md, and docs/ files according to your configured sync rules.

Yes, you can configure custom sync rules for reconciling README.md and docs/ sections. The tool loads settings from a config/sync_rules.json file to determine how sections are analyzed, compared, and updated across your project documentation files.

Yes, the documentation sync tool preserves backups when applying updates. It creates missing sections and updates targets across CLAUDE.md, README.md, and docs/ while ensuring your original content is backed up during the synchronization process.