review-docs

Reviews rendered documentation for structure, visual quality, and factual accuracy using Gemini.

1|1|Updated Nov 25, 2024
One-click install
npx skills add https://github.com/joeledwardson/dev-setup --skill review-docs-joeledwardson
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/joeledwardson/dev-setup/tree/main/configs/claude/skills/review-docs
Command: npx skills add https://github.com/joeledwardson/dev-setup --skill review-docs-joeledwardson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation that looks fine in Markdown source often renders badly, contains broken links, stale code references, or assumes knowledge the reader does not have. This Skill automates a multi-pass review of a live documentation site so these issues are caught before readers hit them. ## Core Features & Use Cases - Structural review: Passes the full docs tree to Gemini with a junior-researcher persona to flag unclear navigation, orphan pages, missing sections, unexplained acronyms, and assumed knowledge. - Visual review: Screenshots each rendered page via a Chrome DevTools Protocol helper (avoiding headless-browser hangs on mkdocs-material) and analyzes it with Gemini vision for broken diagrams, illegible text, poor hierarchy, and truncation. - Factual verification: Checks external links for non-200 responses, verifies referenced file paths exist in the repo, and compares documented claims against current source code and screenshots. - Use Case: Run /review-docs before publishing a docs update to receive a dated report in docs/appendix/reviews/ listing every flagged issue across structure, visuals, and accuracy. ## Quick Start Run /review-docs to audit the entire documentation site, or pass a specific page path to review just that page.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I review documentation for broken links and stale code references?

Run the review-docs skill, which extracts every external URL from your markdown files and HTTP-checks each one, then verifies that file paths and code symbols mentioned in docs still exist in the repository. Results are written to a dated report under docs/appendix/reviews/.

How to screenshot mkdocs pages when headless chromium hangs?

Use the included cdp-shot.mjs helper, which drives the browser over the Chrome DevTools Protocol instead of the one-shot --screenshot flag. It navigates, waits a fixed time, then captures the full scrollable page regardless of network-idle state, which is what causes the hang on mkdocs-material pages.

What Gemini models are used for documentation review?

The skill uses the gemini CLI with native filesystem access for the full-project structure pass, gemini-2.5-pro via the llm CLI for vision-based screenshot analysis, and gemini-2.5-flash for isolated per-page content and fact-checking passes.

Can I review a single documentation page instead of the whole project?

Yes, pass the page path as an argument, for example /review-docs docs/path/to/page.md. Single-page mode skips the project-wide structure pass and runs only the visual, content, and factual checks for that page.

Why does the review use a junior researcher persona?

The persona has no domain knowledge, so it flags acronyms, assumed concepts, and logical leaps that a familiar reviewer would gloss over. This simulates a genuine cold read of the documentation by a new user.

What are the limitations of the full-page screenshot approach?

Chrome caps a single screenshot at roughly 16000 pixels in height, so very tall pages get clipped and the helper logs the clip. For those pages you must split the review or capture the lower half separately.