docs-review

To check markdown documentation diffs against a writing style guide, provide the diff to the tool and it returns a prioritized list of style issues. It parses Markdown to identify formatting, tone, and terminology violations.

Documentation linting for pull requests is the automated process of scanning markdown changes to surface style inconsistencies before merging. It ensures documentation updates conform to predefined writing standards and quality rules.

Yes, you can use this for local markdown file analysis outside of Metabase. While it uses Metabase writing standards, the logic applies to any documentation project requiring markdown diff parsing and style conformance checks.

To review a PR diff for writing style violations, input the commit diff into the tool. It recognizes specific guide rules and outputs structured feedback highlighting tone, terminology, and formatting issues for maintainers.

A markdown documentation review detects tone, terminology, and formatting issues. By parsing the markdown diff against the style guide, it identifies deviations in writing standards and provides structured feedback for remediation.