documentation-review

To audit markdown documentation for consistency, review files to detect drift, verify links and file paths, and flag unfilled placeholders like [TODO]. This generates a prioritized findings table highlighting critical issues and linter errors first.

Yes, you can check mdx, rst, and plain text files for documentation drift within a pull or merge request. The review validates YAML frontmatter, detects version mismatches, and produces a structured findings table for pre-commit checks.

The best way to lint documentation directories before committing is to run a bulk audit that checks formatting, naming mismatches, and template deviations. It classifies issues as critical or minor and includes linter errors when tooling is available.

Documentation review works on plain text files as well as markdown, mdx, and rst formats. It limits changes to documentation formats only, ensuring version drift and unfilled placeholders are flagged without altering code.

You generate a prioritized findings table for documentation issues by reviewing files for correctness and consistency. The table classifies issues as critical or minor, highlights critical issues first, and includes linter errors when tooling is available.