doc-maintenance

Documentation drift is detected by auditing top-level files like README.md, SPEC.md, and PRODUCT.md against recent git history to find mismatches between shipped features and current docs. The audit compares recent commits to identify outdated content.

The best way to automate documentation updates after a release is to trigger a drift audit that proposes minimal, non-breaking edits and automatically opens a pull request with the suggested changes. This ensures docs stay aligned with shipped features.

You can generate a pull request for outdated documentation by running a drift-detection workflow that proposes minimal edits to README.md and SPEC.md files. This workflow creates a feature branch and opens a PR with the suggested updates.

Yes, you can schedule periodic documentation reviews or trigger them on demand to maintain accuracy. The audit checks for drift between your shipped features and public docs, proposing minimal non-breaking edits whenever mismatches are found.

Automated documentation drift detection works by comparing the content of top-level documentation files against recent git commit history. When the audit discovers a mismatch between shipped features and existing docs, it generates minimal proposed edits and opens a pull request.

No special dependencies are required to run the documentation audit. The workflow operates independently to analyze your git history and documentation files, then creates a feature branch and opens a PR directly without needing external tools.