review-docs

Audit Markdown documentation quality and output a prioritized report.

66|12|Updated Feb 15, 2024
One-click install
npx skills add https://github.com/atoms-studio/nuxt-swiftsearch --skill review-docs-atoms-studio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/atoms-studio/nuxt-swiftsearch/tree/main/.agents/skills/review-docs
Command: npx skills add https://github.com/atoms-studio/nuxt-swiftsearch --skill review-docs-atoms-studio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams audit documentation quality across Docus/Nuxt Content projects and generic Markdown sites to ensure consistency, accuracy, and optimized SEO.

Core Features & Use Cases

  • Detect project type (Docus/Nuxt Content vs generic Markdown)
  • Analyze structure, locales, sections, and navigation
  • Perform technical validation (frontmatter, MDC syntax)
  • Content quality review (clarity, SEO, i18n)
  • Generate actionable report with prioritized issues

Quick Start

Provide the repository path or documentation to review and I will generate a detailed, prioritized report with actionable recommendations.

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 in a Nuxt Content project?

Documentation quality audits review frontmatter, MDC syntax, SEO, and structure across Docus or generic Markdown files. They produce a prioritized report identifying clarity issues and technical errors to ensure content consistency.

Can I review SEO and MDC syntax across multiple documentation locales?

Yes, you can review SEO and MDC syntax across multiple documentation locales. The process analyzes structure, sections, and navigation to deliver i18n review and SEO guidance tailored for each language variant in your project.

Does the documentation review work for generic Markdown sites or only Docus?

The documentation review works for both generic Markdown sites and Docus projects. It detects your project type automatically to apply the appropriate technical validation, ensuring accurate frontmatter and syntax checks regardless of your specific setup.

What is the best way to find frontmatter and clarity issues in Markdown docs?

The best way to find frontmatter and clarity issues in Markdown docs is through an automated technical validation process. It identifies structural inconsistencies and SEO gaps, delivering a comprehensive assessment with prioritized issues to fix.

How do I get a prioritized audit report for my Docus documentation?

To get a prioritized audit report for your Docus documentation, provide the repository path for analysis. The system evaluates technical validation and content quality, outputting a detailed report with prioritized issues and actionable recommendations.