docs-sync

To check if documentation is out of sync with code, you audit the repository by analyzing git history for recent code changes and scanning related docs to identify discrepancies. This generates a prioritized checklist flagging actual problems and required updates to ensure consistency.

Finding outdated documentation after updating Python or TypeScript files involves analyzing git history for changes in code files and scanning /docs, READMEs, and docstrings for references. This verifies that examples, API signatures, and field types still align with the current code.

A documentation audit for software repositories is the process of verifying that docs and code match. It scans your project to identify discrepancies between current code and documentation, flagging actual problems like outdated API signatures rather than simply missing items, resulting in an update checklist.

Yes, you can automatically generate a checklist of required documentation updates by running a docs-sync check on your project. It analyzes recent code changes and scans your documentation directory to output a prioritized list of discrepancies that need attention.

Yes, the documentation audit works for repositories with separate docs directories, READMEs, or docstrings. It scans these specific locations for references related to changed code files and validates that the documented examples and API signatures accurately align with the code.