docs-review

Name: docs-review
Rating: 5 (44733 reviews)
Author: metabase

Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.

TL;DR

Review documentation for style compliance; number all issues sequentially in PR or local mode.

What Is It

Detect PR or local review mode based on tool availability
Check documentation against Metabase style guide
Flag tone, structure, formatting, and clarity issues
Number all feedback sequentially starting at Issue 1

Key Features

Mandatory sequential numbering of issues (Issue 1, 2, 3...)
Use pending review workflow in PR mode with parallel comments
Local mode: output issues in numbered markdown list
PR mode: post all issues as one cohesive review with no body message
Critical: all issues must be numbered and referenced in sequence
No material issues should be missed or skipped

How to Use

1.Check if mcp__github__create_pending_pull_request_review is available
2.Read changes to understand intent and identify issues
3.Number all issues sequentially starting from Issue 1
4.In PR mode: use pending review workflow with parallel comments
5.In local mode: output issues in numbered markdown list
6.Always start each issue comment with 'Issue N: [Brief title]'

Guardrails & Gotchas

MUST number all feedback sequentially starting from Issue 1
MUST add all comments in parallel in a single response (PR mode)
DO NOT include body message when submitting pending review
DO NOT skip issues that materially impact readability
CRITICAL: use bold for UI elements, not backticks
FORBIDDEN: use 'users' instead of 'people' or 'companies'

GitHub Stats

Author

@metabase

Repository

metabase/metabase

Stars

44733

Explore More Skills

move-code-quality

@davila7

Analyzes Move language packages against the official Move Book Code Quality Checklist. Use this skill when reviewing Move code, checking Move 2024 Edition compliance, or analyzing Move packages for best practices. Activates automatically when working with .move files or Move.toml manifests.

12.4k

1.1k

1w ago

docs-review

Explore More Skills

move-code-quality

e2e-testing-patterns

testing-anti-patterns