readme-audit

To audit README.md and AGENTS.md files, run the audit tool to check for stale counts, missing table entries, and other discrepancies against the current repository contents, ensuring your documentation accurately reflects the project state.

Keeping project documentation consistent involves running an automated documentation audit that checks for missing rows and outdated count headers in README and AGENTS files, then applying corrections to align the text with the actual repository structure.

You can automatically update stale file counts and missing table entries in your README by running an audit command with a fix flag, which detects discrepancies between the documentation and repository contents and applies the necessary corrections.

You should run a documentation audit on your software project before closing a milestone or whenever the documentation feels outdated, ensuring that all information in the README and AGENTS files aligns with the current state of the repository.

Yes, you can automatically correct outdated documentation without manual edits by executing the audit tool with an automated fixing flag, which applies corrections directly to the README and AGENTS files to resolve detected discrepancies.

Yes, the documentation audit works for both README.md and AGENTS.md files, checking both documents for consistency with the repository contents and handling missing rows, count headers, and other discrepancies across both files.