Update README and docs markdown files after code changes using git diff.
npx skills add https://github.com/ryonakae/dotfiles --skill update-docs-ryonakae
Please help me install this Agent Skill. Skill: update-docs Source: https://github.com/ryonakae/dotfiles/tree/main/config/.agents/skills/update-docs Command: npx skills add https://github.com/ryonakae/dotfiles --skill update-docs-ryonakae
Document consistency across a codebase can quickly degrade after changes; this skill automatically detects relevant docs such as README.md, CLAUDE.md/AGENTS.md/GEMINI.md, and docs/*.md, and updates them to reflect the latest implementation.
変更を検知した後、ドキュメントを自動更新するワークフローを実行してください。
High-intent search queries and answers about installing and using this skill.
Automatically updating project documentation after code changes involves detecting diffs via git status, identifying affected markdown files like README.md, and applying minimal edits to sync the text with the latest implementation without altering source code.
Keeping README and docs in sync with API changes involves running git diff to detect modified code, locating affected markdown files under docs/, and applying minimal text updates to reflect the new API behavior while preserving the original document tone.
Yes, you can use git diff to detect which markdown files need updating by analyzing code changes, identifying impacted documentation like CLAUDE.md or AGENTS.md, and generating a targeted list of files requiring synchronization with the latest implementation.
No, this documentation synchronization approach does not modify source code or commit changes. It strictly reads git logs and updates markdown content in README and docs/ files, leaving the actual source code and git history untouched during the process.
You need to run a documentation consistency check before committing when you have completed a new feature implementation, altered an API, or made significant code diffs that could desynchronize your top-level READMEs or docs/ markdown files from the current codebase.
Supported markdown files for automated documentation updates include top-level READMEs, CLAUDE.md, AGENTS.md, GEMINI.md, and any markdown files located under the docs/ directory across software projects, ensuring comprehensive coverage of project guides.
wineastGenerate markdown reports of local Git changes for code review.
ather-techieGenerate standardized git commit messages from staged changes and repository history.
oozoofrogVerify AGENTS.md and linked docs against the current repository.
zzafergokConvert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.
