Description
docs-review is an agent skill that reviews documentation changes for compliance with the Metabase writing style guide. It works in two modes. When the GitHub pending review tool is available, it reviews a pull request and posts all its issues as one cohesive review. When that tool is not available, it reviews locally and lists the issues in the conversation as a numbered markdown list. The skill applies to pull requests, files and diffs that contain documentation. It checks the change against the shared Metabase style guide, which is included in the skill. Use it before merging documentation changes, or when you want an agent to check a draft against the house style. It is for contributors and reviewers in the metabase/metabase repository. The listing shows it as free, and it has about 2,000 installs. Its security audits show passes from Gen Agent Trust Hub and Socket, with a warning from Snyk. Install it with npx skills add https://github.com/metabase/metabase --skill docs-review.…
Highlights
- Reviews documentation against the writing style guide
- Posts one cohesive pull request review when GitHub tools are available
- Falls back to a numbered list of issues locally
- Covers pull requests, files and diffs
- Uses the shared Metabase style guide
Ratings & Reviews
No ratings yet
Be the first to rate docs-review.
People also visit
docs-review FAQ
What does it check?
Documentation changes against the Metabase writing style guide, which is included in the skill.
How does it report?
In PR review mode, it posts all issues as one review. Otherwise it lists them in the conversation as a numbered list.
What can I review with it?
Pull requests, files or diffs that contain documentation.
Who is it for?
Contributors and reviewers working on the Metabase documentation.
How do I install it?
Run npx skills add https://github.com/metabase/metabase --skill docs-review.
Is it checked for security?
Its security audits show passes from Gen Agent Trust Hub and Socket, and a warning from Snyk.
What are the best docs-review alternatives?
Popular alternatives to docs-review include clojure-review, docs-write and writing-guidelines. See all docs-review alternatives