Detect documentation drift from Rust, Python, and protocol changes.
npx skills add https://github.com/jmduea/emotiv-cortex-rs --skill docs-freshness
Please help me install this Agent Skill. Skill: docs-freshness Source: https://github.com/jmduea/emotiv-cortex-rs/tree/main/.github/skills/docs-freshness Command: npx skills add https://github.com/jmduea/emotiv-cortex-rs --skill docs-freshness
This Skill detects when source code, protocols, or configuration changes are out of sync with accompanying documentation, preventing outdated READMEs, specifications, and changelogs.
Run the docs-freshness skill to get a list of documentation updates needed after recent code changes.
High-intent search queries and answers about installing and using this skill.
Documentation drift is detected by correlating code and protocol modifications with existing documentation files. This analysis identifies missing or outdated sections in READMEs, specs, and changelogs, ensuring public behavior changes are accurately reflected before merging.
Keeping your README and changelog in sync requires mapping source code changes to required documentation updates. This flags missing sections and blocks merges until critical documentation gaps are resolved and the changelog accurately reflects the new endpoint.
Yes, you can block pull requests when protocol changes are not reflected in the spec. By enforcing documentation freshness checks, merges are blocked if critical gaps exist between modified code and the accompanying specification or changelog.
The best way to automate required doc updates is to run a change mapping process that correlates protocol modifications with documentation files. This generates a gap report of missing or outdated sections, enforcing updates before a merge can occur.
Yes, documentation drift detection works with both Rust and Python files. It analyzes changes across these languages to determine the required updates needed for README, spec, and changelog files to maintain documentation freshness.
You should run a documentation freshness check after modifying source code, protocols, or configuration files. This identifies outdated READMEs, specifications, or changelogs and ensures they are updated before the changes are merged.
aio-libsAnalyze aiobotocore PR diffs for drift against botocore source code.
icartshGenerate READMEs, changelogs, and API references from Git history.
arbazkhan971Integrate security scanning into CI/CD pipelines with blocking gates.
abhinavEnforce comment formatting rules for Go and general programming projects.
