Reviews documentation changes for style guide compliance and clarity within GitHub PRs or local Markdown files.
The Docs Review skill automates the editorial process by enforcing the Metabase writing style guide across Markdown documentation. It intelligently detects its environment to provide feedback either as a numbered list in a local session or as a batched, cohesive review on GitHub Pull Requests. By analyzing tone, voice, structure, and formatting, the skill ensures that technical content remains conversational, accessible, and professional while eliminating common pitfalls like corporate jargon and non-descriptive links.
Key Features
01Smart batching of GitHub comments to provide a single, non-blocking review event.
024 GitHub stars
03Automated enforcement of the Metabase writing style guide for consistent documentation.
04Dual-mode operation for local terminal feedback or integrated GitHub PR review comments.
05Comprehensive scanning for tone, clarity, link formatting, and code example validity.
06Sequential issue numbering for streamlined referencing and tracking of requested changes.
Use Cases
01Auditing documentation Pull Requests for style and clarity before merging into production.
02Standardizing technical voice across multiple contributors in a large open-source project.
03Performing local scans of Markdown files to catch prose issues during the drafting phase.
