docs-review

docs-review is a skill for Claude Code, Codex from grimoire-rs/grimoire. It costs 120 tokens per session (952 once invoked), scanned A, original, Apache-2.0.

A documentation checker that grades Markdown, MDX, reStructuredText, MyST, or AsciiDoc pages against a documentation-quality rule set. It reports findings with file paths and line numbers but does not fix them.

In plain words
What is it for?
Use it to check a README, documentation page, changelog, directory, or branch changes and report either findings or a clean result.
Why use it?
It catches documentation problems even when no one is currently editing the page and makes the result specific enough to review.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions CLAUDE.md; installed under .agents/ (shared by several agents); mentions AGENTS.md.

Good fit Use it to check a README, documentation page, changelog, directory, or branch changes and report either findings or a clean result.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/grimoire-rs/grimoire/docs-review
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.

Any agent
npx skills add grimoire-rs/grimoire --skill docs-review
Clone the repo
git clone --depth 1 https://github.com/grimoire-rs/grimoire

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-review

README.md
[![agentmods](https://agentmods.dev/badge/skills/grimoire-rs/grimoire/docs-review/github.svg)](https://agentmods.dev/skills/grimoire-rs/grimoire/docs-review)
Your own site
<a href="https://agentmods.dev/skills/grimoire-rs/grimoire/docs-review"><img src="https://agentmods.dev/badge/skills/grimoire-rs/grimoire/docs-review/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for docs-review

Your own site · 80×15
<a href="https://agentmods.dev/skills/grimoire-rs/grimoire/docs-review"><img src="https://agentmods.dev/badge/skills/grimoire-rs/grimoire/docs-review.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 120 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 952 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found 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.1 $0.00120 $0.00952
Opus 5.5 $0.00048 $0.00381
Sonnet 5.5 $0.00024 $0.00190
Haiku 4.5 $0.00012 $0.00095

Measured 21d ago against content hash 2b33ea89c9cf, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs-review 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 21d 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.

.agents/skills/docs-review/SKILL.md · 77 lines

How it starts

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

docs-review

The docs-quality rule loads when an agent edits a page. This skill is the explicit trigger: grade pages nobody is editing, pages in unusual places, and pages in a format the scripts only partly read.

Stop condition

Stop when every target page has a verdict: each finding as path:line: DOC-XXX-nn: message, or clean. Mark any finding no script produced unverified: reading heuristic. Report; never fix unless asked.

1. Pick the targets

  • Named paths or directories: use them as given, whatever their location.
  • Nothing named: the branch diff, git diff --name-only --diff-filter=d "$(git merge-base HEAD origin/HEAD)" -- '*.md' '*.mdx' '*.rst' '*.adoc' '*.asciidoc'.
  • Drop agent config (CLAUDE.md, AGENTS.md, SKILL.md, .claude/, .agents/), vendored copies and build output. The rule excludes them too.

2. Load the rule

Read the installed docs-quality rule index, then only the depth files its routing table names for the target page types. Find it with find . -path '*docs-quality*' -name 'docs-quality.md' -not -path '*/node_modules/*'. Its checks/ directory sits beside it. No hit means the rule is not installed: say grim add ghcr.io/ocx-sh/lore/docs-quality and stop.

3. Run the checks by format

CHECKS below is that checks/ directory. Every script takes explicit paths, so pass the targets rather than --root.

Format Scripted Read by hand
.md, .mdx the whole gate, in the rule's order rows the scripts mark heuristic
.rst, MyST, .adoc doc_declaration.py everything else, or convert first

Markdown and MDX:

python3 "$CHECKS/doc_declaration.py" PAGE...
python3 "$CHECKS/prose.py"           PAGE...
python3 "$CHECKS/page_type.py"       PAGE...
python3 "$CHECKS/landing_check.py"   PAGE...

Add doc_examples.py, nav_depth.py and links_raw.py when the review covers a whole docs tree rather than single pages. Their inputs are a tree.

reStructuredText and AsciiDoc: run doc_declaration.py on the source. The prose and page-type scripts parse Markdown only. When pandoc is on the PATH, convert each page into a scratch directory and run them on the copy:

Read the full file on GitHub · 77 lines

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. 21d ago First seen · 77 lines · 120 tokens per session scan A 2b33ea89c9cf

Subscribe to this mod's changes

docs-review is a skill published in the GitHub repository grimoire-rs/grimoire (14 stars, last pushed today), licensed Apache-2.0. It adds 120 tokens to every session and 952 once invoked, about $0.0005 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-26.