update-docs

To keep project documentation aligned with code changes, you can audit the repository structure, git history, and markdown files to identify outdated content, then apply targeted updates to architecture notes and changelogs.

Updating a changelog from git commits involves scanning project history and tags to detect missing entries, then appending accurate release notes while preserving existing correct sections.

Verifying internal markdown links after updating README cross-references requires checking the modified documentation structure to ensure navigability and prevent broken paths.

You can audit OSS policy files and architecture notes without rewriting correct sections by comparing existing markdown content against the current repository layout and applying only targeted patches.

You need to scan your repository structure for missing documentation files when a project has evolved significantly and its README, architecture notes, or OSS policy pages no longer match the implementation.

Updating docs with this method preserves existing accurate markdown content by scanning internal links, git tags, and commits to refresh only outdated or missing documentation files.