Audit Rust project documentation against source code for consistency.
npx skills add https://github.com/wutongshenqiu/prism --skill doc-audit-wutongshenqiu
Please help me install this Agent Skill. Skill: doc-audit Source: https://github.com/wutongshenqiu/prism/tree/main/.agents/skills/doc-audit Command: npx skills add https://github.com/wutongshenqiu/prism --skill doc-audit-wutongshenqiu
This Skill streamlines the process of ensuring that documentation stays in sync with source code, saving time and reducing errors in development.
--fix option.AGENTS.md, specs/completed/ files, and reference/ to ensure that the documentation accurately reflects the source code.Perform a quick documentation consistency check with the doc-audit skill using the command: 'doc-audit quick'.
High-intent search queries and answers about installing and using this skill.
To check documentation consistency against Rust source code, run an automated audit using the doc-audit command. It scans documentation files like AGENTS.md and reference directories to identify discrepancies with the actual codebase.
You can automatically fix documentation discrepancies by running the audit command with the --fix flag. This option auto-corrects inconsistencies discovered during the scan of your API endpoint tables and specs.
The best way to audit specific scopes like API endpoints and specs is to use targeted audit commands. This approach scans only the selected reference files or AGENTS.md instead of running a full project audit.
Perform a quick documentation consistency check by executing the doc-audit quick command. This rapidly verifies that your reference types and completed spec files accurately reflect the source code.
Yes, the documentation audit works with AGENTS.md files by explicitly checking them against the source code. It ensures that the agent instructions and references remain synchronized with the actual Rust implementation.
jayteealaoSynchronize version numbers across project files and documentation references.
code-review-benchmarkDetect and correct Markdown formatting issues in repository files with markdownlint-cli2.
nikomatsakisDocument rust-analyzer's public API crates for building Rust analysis tools.
mikopbxExtract and analyze OpenAPI 3.1.0 specifications to validate endpoints and generate tests.