docs-check

Cross-check documentation references against the current codebase and report outdated ones.

1.2k|259|Updated Apr 17, 2025
One-click install
npx skills add https://github.com/symfony/ai --skill docs-check-symfony
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/symfony/ai/tree/main/.claude/skills/docs-check
Command: npx skills add https://github.com/symfony/ai --skill docs-check-symfony

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scans project documentation to identify references to non-existent or outdated code, ensuring docs stay in sync with the current codebase across RST, Markdown, and README files.

Core Features & Use Cases

  • Scans documentation files across docs/, README.md, and component READMEs for outdated class, method, package, and configuration references.
  • Verifies references against the codebase (src/) and reports findings grouped by file with actionable details and suggested fixes.
  • Generates a structured report to guide documentation corrections and maintain consistency during releases.

Quick Start

Run the Explore agent to gather all RST and MD files, then review the generated report of outdated references.

Frequently Asked Questions about docs-check

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

FAQPage Schema
How do I find outdated code references in project documentation?

To find outdated code references in documentation, scan RST and Markdown files to cross-check class, method, and configuration references against the current codebase. This identifies non-existent or outdated entries to keep docs synchronized with src/ during releases.

What is the best way to verify documentation references against a codebase?

The best way to verify documentation references against a codebase is applying static analysis to cross-check docs/ and README files. This generates a grouped findings report detailing file paths, exact references, issue types, and suggested corrections.

Can I scan both RST and Markdown README files for outdated code references?

Yes, you can scan both RST and Markdown README files for outdated code references. The process targets docs/, README.md, and component READMEs, verifying class and method references against the src/ directory to report inconsistencies.

How do I generate a report of outdated documentation references for a release?

Generate a report of outdated documentation references by running an analysis agent across your documentation files. It produces a structured, grouped report containing file paths, outdated references, issue types, and suggested fixes to guide corrections.

Does static analysis for documentation quality suggest fixes for outdated references?

Yes, static analysis for documentation quality suggests fixes for outdated references. After cross-checking documentation against the codebase, the resulting report includes actionable details with suggested corrections to resolve non-existent or outdated code references.