# docs-review

This skill checks markdown documentation changes against the Metabase style guide and returns a numbered list of issues.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 2000 installs · ★ 49845
- Author: metabase
- License: LicenseRef-Unknown · policy=link-only · description only; the file stays with the author
- Source: https://github.com/metabase/metabase/tree/HEAD/.claude/skills/docs-review/SKILL.md
- Updated: 2026-10-24
- HTML: https://affpapa.org/en/nevibecode/skills/docs-review

## What it does

The skill fires when a diff touches `docs/**/*.md`. It reads the changes once to understand intent, then walks a checklist: tone and voice, structure, links, formatting, code examples, sentence construction. Every issue gets a number starting at Issue 1, so an author can point at specific ones.

There are two modes. With the `mcp__github__create_pending_pull_request_review` tool available, the skill opens a pending review, collects all comments and publishes them as one review through `mcp__github__submit_pending_pull_request_review` using the `COMMENT` event type. Without that MCP tool, issues are printed into the conversation as a numbered list.

Under the hood it pulls in a shared style guide file, `_shared/metabase-style-guide.md`, plus a quick scan table: “click here” instead of descriptive link text, “easy” and “simple” as condescending qualifiers, “users” where “people” or “companies” fits. Allowed tools are `Read`, `Grep`, `Bash` and `Glob`. The pull request mode needs a GitHub MCP server connected — otherwise you only get local output.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add metabase/metabase --skill docs-review -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/docs-review/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/docs-review/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add metabase/metabase --skill docs-review -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/docs-review/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add metabase/metabase --skill docs-review -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/docs-review/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install metabase/metabase docs-review
```

2. **Manually: put the files in place**
- File: `.github/skills/docs-review/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add metabase/metabase --skill docs-review -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/metabase/metabase --path .claude/skills/docs-review
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/docs-review/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add metabase/metabase --skill docs-review -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/metabase/metabase/tree/HEAD/.claude/skills/docs-review/SKILL.md

## When to use it
- check markdown edits under `docs/` before merging
- catch condescending wording like “easy” and “simple”
- replace “click here” with descriptive link text
- spot code examples that would error
- post one review instead of scattered comments

## Example prompts
- Review the documentation changes against the Metabase style guide
- Run docs-review on the `docs/` diff and number the issues
- Post the documentation issues as a pull request review

## Similar
- [grill-with-docs](https://affpapa.org/en/nevibecode/skills/grill-with-docs.md) — skill · 1219756 installs
- [skill-creator](https://affpapa.org/en/nevibecode/skills/skill-creator.md) — skill · 414180 installs
- [setup-matt-pocock-skills](https://affpapa.org/en/nevibecode/skills/setup-matt-pocock-skills.md) — skill · 1052851 installs
- [handoff](https://affpapa.org/en/nevibecode/skills/handoff.md) — skill · 1038491 installs
- [triage](https://affpapa.org/en/nevibecode/skills/triage.md) — skill · 990453 installs
- [domain-modeling](https://affpapa.org/en/nevibecode/skills/domain-modeling.md) — skill · 876391 installs

From the same set: [metabase/metabase](https://affpapa.org/en/nevibecode/by/metabase/metabase.md) — 9 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md