cmd-documentation-doc-sync

To find stale documentation after a code merge, provide a git range to analyze. The tool scans git diffs and compares them against common doc patterns like README, ARCHITECTURE, and CHANGELOG files to identify outdated sections.

Yes, you can sync markdown docs with git changes by scanning a specified git range. The tool detects outdated markdown files and proposes minimal, targeted edits designed to preserve the original style for reviewer approval.

The best way to audit documentation against a git diff is using an automated diff-driven workflow. This process scans specified git ranges to detect stale docs and generates surgical, review-ready markdown patches.

No, you do not manually apply updates immediately. The tool generates minimal, review-ready edits that propose surgical changes to markdown files, allowing maintainers to review and approve the patches before they are applied.

Staleness detection supports common markdown doc patterns including README, ARCHITECTURE, CHANGELOG, and any files matching the docs/*.md directory structure, ensuring broad coverage for standard project documentation.

You should run a documentation sync during post-release maintenance, after feature merges, or as part of scheduled documentation audits to ensure your markdown files remain accurately aligned with recent code changes.