review-docs

A review process for Markdown documentation, especially documentation built with Docus or Nuxt Content. It checks project structure, formatting, technical accuracy, clarity, search visibility, and translations.

In plain words
What is it for?
Use it to audit documentation and receive a report of critical, important, and optional improvements.
Why use it?
It finds issues that can make documentation invalid, hard to navigate, difficult to find, or misleading to readers.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/pleaseai/claude-code-plugins/review-docs
Any agent
npx skills add pleaseai/claude-code-plugins --skill review-docs
Clone the repo
git clone --depth 1 https://github.com/pleaseai/claude-code-plugins

Made for: Claude Code, Codex.

Per session 108 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,694 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00108 $0.03694
Opus 5 $0.00054 $0.01847
Sonnet 5 $0.00022 $0.00739
Haiku 4.5 $0.00011 $0.00369

Measured 2d ago against content hash 4dadf688ddd1, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

review-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to review-docs — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

plugins/docus/.agents/skills/review-docs/SKILL.md · 480 lines

How it starts

The opening of the file, as written. The whole thing — 480 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Review Docs

Comprehensive documentation review, optimized for Docus/Nuxt Content but compatible with any Markdown documentation.

Workflow Overview

This skill performs a 5-step review process:

  1. Detect Project Type - Identify Docus/Nuxt Content vs generic Markdown
  2. Analyze Structure - Map documentation organization, locales, sections
  3. Technical Validation - Check frontmatter, MDC syntax (if applicable), file naming
  4. Content Quality Review - Evaluate clarity, SEO, structure, i18n
  5. Generate Report - Provide categorized, actionable recommendations

Priority Levels

  • Critical - Blocks deployment or causes errors (missing frontmatter, invalid MDC syntax)
  • Important - Significantly impacts UX/SEO (poor metadata, passive voice, unclear headings)
  • Nice-to-have - Polish and optimization suggestions (add callouts, improve examples)

Expectations

This skill generates a detailed report only. After reviewing, it offers to fix identified issues if requested.


Step 1: Detect Project Type

Goal: Determine if this is a Docus/Nuxt Content project or generic Markdown documentation.

Detection Indicators

Check for Docus/Nuxt Content:

  1. package.json dependencies:

    • "docus" - Docus theme
    • "@nuxt/content" - Nuxt Content module
    • "@nuxtjs/mdc" - MDC support
  2. Configuration files:

    • nuxt.config.ts or nuxt.config.js with @nuxt/content module
    • content.config.ts - Content collections configuration
  3. Content structure:

    • content/ or docs/content/ directory
    • .navigation.yml files in subdirectories
    • MDC syntax in markdown files (::component-name)
  4. Project structure:

    • Numbered directories (1.getting-started/, 2.guide/)
    • Frontmatter with navigation, seo fields

Project Type Classification

Type A: Docus/Nuxt Content Project

  • All Docus-specific validations apply
  • MDC component syntax checks (u- prefix requirement)
  • Nuxt Content frontmatter structure
  • Navigation files (.navigation.yml)
  • Full technical validation

Read the full file on GitHub · 480 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 480 lines · 108 tokens per session scan A 4dadf688ddd1

Subscribe to this mod's changes

review-docs is a skill published in the GitHub repository pleaseai/claude-code-plugins (13 stars, last pushed 7d ago), licensed MIT. It adds 108 tokens to every session and 3,694 once invoked, about $0.0005 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to review-docs, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

planning-with-files-ar

تخطيط مستمر قائم على الملفات لعمل وكلاء الذكاء الاصطناعي متعدد الخطوات. يحتفظ بملفات taskplan.md و findings.md و progress.md على القرص، وتحقن خطافات دورة الحياة سياق التخطيط المحدد للمشروع. تقرأ الاستعادة التلقائية ملفات تخطيط المشروع فقط. يمكن للأمر الصريح session-catchup.py --metadata فحص بيانات وصفية لجلسات الوكيل…

OthmanAdi/planning-with-files · 189 tokens

kl-consistency-test

Write, calibrate, and debug the prefill-vs-decode logprob (KL) consistency tests in sglang -- the two independent conditions a zero requires (every operator batch-invariant, and the two paths computing the same function), which helper separates them, how to pick a threshold once they hold, and how to localize a…

sgl-project/sglang · 108 tokens

i18n-localization

Internationalization and localization patterns. Detecting hardcoded strings, managing translations, locale files, RTL support.

vudovn/ag-kit · 27 tokens

dsh-web-documentation

Use when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.

zhu1090093659/dsh-web · 34 tokens

baoyu-youtube-transcript

Downloads YouTube video transcripts/subtitles and cover images by URL or video ID. Supports multiple languages, translation, chapters, and speaker identification. Caches raw data for fast re-formatting. Use when user asks to "get YouTube transcript", "download subtitles", "get captions", "YouTube字幕", "YouTube封面"…

JimLiu/baoyu-skills · 107 tokens

indication-dossier

Build a source-backed biomedical indication dossier. Use when a research task asks for disease biology, target rationale, patient segmentation, biomarkers, trials, drugs, competitive landscape, or translational evidence.

companion-inc/feynman · 43 tokens