docs-review

Review documentation changes for Metabase writing style guide compliance.

2|Updated Jul 17, 2025
One-click install
npx skills add https://github.com/SouleymaneSy7/dots-files --skill docs-review-souleymanesy7
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/SouleymaneSy7/dots-files/tree/main/opencode/skills/docs-review
Command: npx skills add https://github.com/SouleymaneSy7/dots-files --skill docs-review-souleymanesy7

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of reviewing documentation changes to ensure compliance with the Metabase writing style guide, making it easier to maintain consistent quality and readability across all documentation.

Core Features & Use Cases

  • Compliance Check: Automatically scan documentation for adherence to Metabase's writing style guide.
  • Feedback Formatting: Generate clear and actionable feedback on style guide violations.
  • Review Modes: Support both pull request and local review modes, catering to different collaboration scenarios.

Quick Start

Run the docs-review skill on your pull request to automatically review the documentation changes.

Frequently Asked Questions about docs-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check documentation changes for style guide compliance?

Reviewing documentation for style guide compliance involves scanning changes against the Metabase writing style guide using regex and comparison logic. This process detects non-compliance and provides clear feedback on violations to maintain consistent quality.

Can I review documentation for style guide violations locally instead of in a pull request?

Yes, you can review documentation for style guide violations locally. The review process supports both pull request and local review modes, allowing you to check writing style compliance directly on your machine before committing changes.

How does automated documentation style review work?

Automated documentation style review works by utilizing regex pattern matching and text comparison to detect non-compliance with specified writing guidelines. It scans documentation changes and generates clear, actionable feedback on style guide violations.

Does the documentation review process require any external dependencies?

No, the documentation review process does not require external dependencies. It operates independently using scripts to perform the compliance checks, ensuring adherence to the writing style guide without needing additional packages or libraries.

What is the best way to ensure Metabase writing style guide adherence?

The best way to ensure Metabase writing style guide adherence is to run an automated review on your documentation changes. It actively scans for style guide violations and formats clear feedback to correct any non-compliance.