Validates Rust CLI READMEs and source code for documentation drift.
npx skills add https://github.com/shutootaki/gwm --skill docs-sync-shutootaki
Please help me install this Agent Skill. Skill: docs-sync Source: https://github.com/shutootaki/gwm/tree/main/.claude/skills/docs-sync Command: npx skills add https://github.com/shutootaki/gwm --skill docs-sync-shutootaki
This Skill ensures that your project's documentation stays perfectly synchronized with its source code, preventing outdated information and user confusion.
Run the docs-sync skill to check for documentation drift in the project.
High-intent search queries and answers about installing and using this skill.
Documentation drift occurs when source code definitions change but README files do not. You detect this drift by parsing Rust source files and Markdown documents to identify discrepancies in commands, options, and configuration fields.
Detect documentation drift in a Rust CLI project by validating that CLI arguments, configuration types, and environment variables match their documented representations in English and Japanese READMEs before a release.
Yes, you can verify cross-language consistency by checking that English and Japanese READMEs maintain structural parity, ensuring that CLI arguments and configuration types are identically documented across both languages.
Yes, the documentation sync tool includes an environment variable check that parses Rust source files to ensure all relevant environment variables are properly documented in the README files.
The best way to automate CLI argument validation is to run a script that parses Rust source files and Markdown documents to report discrepancies between the actual command line options and their help text documentation.
A limitation is that the sync process specifically requires parsing Rust source files and Markdown documents, meaning it is tailored for Rust CLI projects and may not support other programming languages or documentation formats.
dmlguq456Synchronize agent skill definitions with generated documentation and manifests.
aws-samplesSynchronize Japanese README translations with English source files.
KentoShimizuEnforce Rust style, ownership discipline, and API design during PR reviews and CI checks.
thktGenerate Markdown API specs and OpenAPI/Swagger files from codebase analysis.
