review-docs

Audit documentation quality across Docus, Nuxt Content, and Markdown projects.

2.9k|274|Updated Nov 12, 2020
One-click install
npx skills add https://github.com/nuxt-content/docus --skill review-docs-nuxt-content
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/nuxt-content/docus/tree/main/skills/review-docs
Command: npx skills add https://github.com/nuxt-content/docus --skill review-docs-nuxt-content

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review documentation quality across Docus/Nuxt Content projects and generic Markdown docs. It identifies gaps in clarity, structure, SEO, and technical accuracy, and provides prioritized, actionable recommendations.

Core Features & Use Cases

  • Detect project type (Docus/Nuxt Content vs generic Markdown) and apply appropriate validations
  • Validate frontmatter, MDC syntax, navigation, and overall content structure
  • Generate a prioritized report with Critical, Important, and Nice-to-have recommendations
  • Support i18n awareness and cross-locale consistency checks when present

Quick Start

Run a comprehensive docs review on your repository to produce a detailed assessment and recommended fixes.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I audit documentation quality for SEO and clarity in Markdown files?

You can audit Markdown documentation quality by validating frontmatter, MDC syntax, structure, and SEO signals. The skill evaluates these aspects across your documentation projects and generates a prioritized report with actionable recommendations.

What is the best way to review Nuxt Content documentation for frontmatter and MDC syntax compliance?

Reviewing Nuxt Content documentation requires validating MDC syntax and frontmatter validity. The skill automatically detects Docus or Nuxt Content projects and applies appropriate validations to ensure technical accuracy and structural compliance.

Does the documentation review process support i18n readiness and cross-locale checks?

Yes, the documentation review process supports i18n readiness. When internationalization is present, the skill evaluates cross-locale consistency to ensure your documentation maintains quality across different languages.

How are documentation review recommendations prioritized when issues are detected?

Recommendations are prioritized into Critical, Important, and Nice-to-have categories. The skill enforces a structured report with clear priorities and provides a file-precise summary to help you address the most significant documentation issues first.

Can I use this review tool for generic Markdown docs or is it limited to Nuxt Content?

You can use this review tool for both generic Markdown docs and Nuxt Content projects. The skill detects the project type and applies the appropriate validations, ensuring flexibility across different documentation setups.

What SEO signals are evaluated during a Markdown documentation audit?

During a Markdown documentation audit, SEO signals are evaluated alongside frontmatter validity and content structure. This ensures your documentation is not only technically correct but also optimized for search engine visibility.