Stats
Actions
Tags
From ekline-docs-skills
Detect stale documentation by comparing recent code changes against docs. Runs a helper script that extracts changed symbols from git diffs and cross-references them against documentation files. Flags docs that reference modified or removed code. Use after merging changes or before a release.
How this skill is triggered — by the user, by Claude, or both
Slash command
/ekline-docs-skills:docs-freshnessThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
Run the helper script to find docs that reference changed code, then present results and offer to draft updates.
Run the helper script to find docs that reference changed code, then present results and offer to draft updates.
$ARGUMENTS — optional commit range (e.g., main..HEAD, v1.2.0..v1.3.0, HEAD~20..HEAD) and optional --docs-dir DIRpython scripts/extract_changes.py $ARGUMENTS
Pass --docs-dir DIR if the user specifies a docs directory. Capture the JSON output.
The script handles:
Max 50 changed code files analyzed per run. Symbols under 6 characters are filtered out to reduce false positives.
If the JSON contains an error field:
not_a_git_repo — tell user to run from inside a git repositoryIf stale_docs is empty:
Stop here if error or no stale docs.
Show a summary:
Then list stale docs grouped by status:
Stale (action required) — docs with status: "stale":
Likely stale (review recommended) — docs with status: "likely_stale":
For each stale doc, list the specific symbols from the findings array that triggered the staleness flag:
symbol — the name that was found in the doctype — what happened: removed_symbol, modified_symbol, removed_endpoint, env_var_changedsource_file — the code file where the change occurreddoc_line — the line in the doc that references the symbolcontext — whether the reference is in a code_block or inline_codeThis helps the user understand exactly what needs updating and where.
For each stale doc, offer to:
When drafting updates:
After applying updates, summarize:
npx claudepluginhub ekline-io/ekline-docs-skills --plugin ekline-docs-skillsDetects documentation-vs-code drift from git diffs, applies safe version/CHANGELOG corrections, and reports all stale-reference issues with file:line evidence.
Detects documentation that has drifted from code by scanning for renamed APIs, undocumented code, stale comments, and mismatched architecture constraints. Useful after feature work, during code review, or as periodic hygiene.
Audits repository documentation for drift, stale statements, broken references, and README mismatches before corrective PRs.