docs-review

Detect documentation drift in Rust project files and repository metadata.

13|3|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/jamie8johnson/cqs --skill docs-review-jamie8johnson
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/jamie8johnson/cqs/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/jamie8johnson/cqs --skill docs-review-jamie8johnson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the codebase, making it harder to understand current behavior, setup, and policies. This skill identifies stale docs across key files (src/lib.rs doc comments, Cargo.toml description, README, CONTRIBUTING.md, SECURITY.md, PRIVACY.md) and the repo metadata, surfacing fixes to keep the project accurate and maintainable.

Core Features & Use Cases

  • Drift detection across core docs (src/lib.rs, Cargo.toml, README.md, CONTRIBUTING.md, SECURITY.md, PRIVACY.md) and GitHub repo metadata.
  • Automated recommendations and suggested edits to restore alignment with current code and practices.
  • Validation of documentation against code structure and recent changes to prevent release drift.

Quick Start

Run the docs-review skill to scan the repository and generate a drift report summarizing stale docs and suggested fixes.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I detect documentation drift in a Rust project?

Documentation drift in a Rust project is detected by comparing src/lib.rs doc comments, Cargo.toml descriptions, README, CONTRIBUTING, SECURITY, and PRIVACY files against the current codebase to generate a report with actionable fixes.

What is the best way to keep project docs current with code changes?

Keeping project docs current involves scanning repository metadata and core documentation files to identify stale content, then applying automated recommendations and suggested edits to restore alignment with recent code changes.

Does this documentation review tool check GitHub repo metadata?

Yes, this documentation review process applies drift checks to GitHub repo metadata alongside core project files like README.md and Cargo.toml to ensure comprehensive accuracy and maintainability across the repository.

How do I fix stale README and CONTRIBUTING files before a release?

Fixing stale README and CONTRIBUTING files requires validating documentation against recent code structure changes, identifying misaligned content, and applying suggested edits to restore accuracy and prevent release drift.

Can I automate documentation maintenance for Rust libraries?

Automating documentation maintenance for Rust libraries is possible by scanning src/lib.rs doc comments and Cargo.toml descriptions to validate consistency, then generating a precise drift report with suggested fixes.

What documentation files are checked during a docs review?

A docs review checks src/lib.rs, Cargo.toml, README.md, CONTRIBUTING.md, SECURITY.md, PRIVACY.md, and repository metadata to identify documentation drift and surface fixes for keeping the project accurate.