Skip to main content
affpapa.org
RU EN
skill CX Codex

docs-review — Claude Code skill: review docs against a style guide

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓ 
npx skills add metabase/metabase --skill docs-review -a claude-code
Open on GitHub

What docs-review 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.

What it helps with

  • 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 for the agent

  • 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

How to install docs-review

1Skills CLI (Vercel)

npx skills add metabase/metabase --skill docs-review -a claude-code

2Manually: put the files in place

~/.claude/skills/docs-review/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/docs-review/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about docs-review

How do I install docs-review in Claude Code?

Run npx skills add metabase/metabase --skill docs-review -a claude-code. The skill lands in ~/.claude/skills/docs-review/SKILL.md.

What does docs-review do?

It reviews markdown documentation changes against the Metabase style guide and returns a numbered list of issues with suggested fixes.

How do the two review modes differ?

With the mcp__github__create_pending_pull_request_review tool available, issues go to the pull request as comments in a single review. Without it, the skill prints them in the conversation.

Similar skills

Everything for Writing and docs →
grill-with-docs Matt Pocock This skill interviews you about a plan or design and creates ADRs and a glossary along the way. Use it when decisions need sharper definition. 1,219,756installs skill-creator official anthropics Creates and refines skills, then tests them with prompts, evaluations, and performance checks. 414,180installs setup-matt-pocock-skills Matt Pocock This skill configures a repository for Matt Pocock's engineering skills by setting its issue tracker, triage labels, and domain docs layout. Run it before using the other skills. 1,052,851installs handoff Matt Pocock Creates a handoff document from the current conversation so another agent can continue the work. Use it when a task moves to a new session or agent. 1,038,491installs triage Matt Pocock This skill moves issues and external PRs through triage states, verification, and agent briefs. It fits maintainers managing an issue queue. 990,453installs domain-modeling Matt Pocock This skill sharpens project terminology, maintains GLOSSARY.md, and records selected architecture decisions in ADRs. Use it while the domain model is changing. 876,391installs

From the same set9

typescript-review Reviews TypeScript and JavaScript changes against Metabase coding rules. Use it for pull requests or diffs that include TS or JS files. CX Codex +1 2,300installs docs-write This skill helps write and edit Markdown and MDX in Metabase’s style. Use it when a documentation file needs a clear structure, checked examples, and consistent formatting. CX Codex +1 2,100installs typescript-write Skill for writing and editing TypeScript and JavaScript code to Metabase standards. Enforces strict typing without any and requires type checking before completion. CX Codex +1 2,100installs add-malli-schemas This skill adds Malli schemas to Metabase API endpoints, covering request inputs and responses. Use it when changing Clojure API code. CX Codex +1 2,000installs analytics-events A skill that teaches coding agents how to add Snowplow analytics events to the Metabase frontend. Use it when tracking clicks, form submissions, and entity creation. CX Codex +1 2,000installs clojure-review Reviews Clojure and ClojureScript code against Metabase engineering guidelines and flags styling mistakes in diffs. CX Codex +1 2,000installs clojure-write This skill guides REPL-driven Clojure and ClojureScript development and refactoring. Use it when functions need step-by-step checks. CX Codex +1 2,000installs Metabase Connects AI assistants directly to a Metabase instance to search catalog items, execute SQL queries, and build charts under user permissions. CX Codex +1 ★ 49,845repo stars

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor