Does this skill work on local files?

Yes, if the GitHub MCP tool is not available, the skill defaults to Local Review Mode and outputs a numbered list of issues directly in the terminal or chat.

Can I use this for non-Metabase documentation?

While optimized for the Metabase style guide, its checks for clarity, active voice, and consistent formatting are beneficial for any high-quality technical documentation.

How does it handle GitHub Pull Requests?

It uses a pending review workflow to batch all identified issues into a single, cohesive review, posting individual comments to the specific lines in the PR diff.

What is the Metabase style guide used by this skill?

It is a set of writing principles focused on a conversational tone, avoiding corporate jargon, and using specific formatting like bolding UI elements instead of using backticks.

Metabase Documentation Reviewer

Name: Metabase Documentation Reviewer
Author: Microck

byMicrock

•

Content Management

Reviews documentation pull requests and markdown files for compliance with the Metabase writing style guide to ensure clarity and consistency.

About

This skill automates the editorial process for technical documentation by enforcing the Metabase style guide across markdown files. It analyzes content for tone, structure, and formatting, providing sequentially numbered feedback to streamline the revision process. Capable of operating in both local environments and directly within GitHub Pull Requests, it helps developers and technical writers eliminate corporate jargon, fix improper UI element formatting, and improve instructional clarity without manual proofreading overhead.

Key Features

Comprehensive tone and voice auditing to remove formal or corporate jargon
Formatting validation for UI elements, links, and code examples
Automatic detection between local conversation mode and GitHub PR review mode
81 GitHub stars
Parallel GitHub commenting for cohesive, non-blocking PR reviews
Numbered feedback system for easy tracking and referencing of issues

Use Cases

Ensuring technical writing consistency across large documentation repositories
Reviewing documentation Pull Requests for style guide compliance on GitHub
Auditing local markdown files before committing documentation changes

About

Key Features

Comprehensive tone and voice auditing to remove formal or corporate jargon
Formatting validation for UI elements, links, and code examples
Automatic detection between local conversation mode and GitHub PR review mode
81 GitHub stars
Parallel GitHub commenting for cohesive, non-blocking PR reviews
Numbered feedback system for easy tracking and referencing of issues

Use Cases

Ensuring technical writing consistency across large documentation repositories
Reviewing documentation Pull Requests for style guide compliance on GitHub
Auditing local markdown files before committing documentation changes