update-docs

Analyze the codebase and update README.md, docs/, and CHANGELOG.md files.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/vinicius91carvalho/.claude --skill update-docs-vinicius91carvalho
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/vinicius91carvalho/.claude/tree/main/skills/update-docs
Command: npx skills add https://github.com/vinicius91carvalho/.claude --skill update-docs-vinicius91carvalho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze the codebase and update project documentation (README.md, docs/) to reflect the current state of the codebase. Use this skill when the user says "update docs", "update readme", "sync docs", "docs are stale", "refresh documentation", or when workflow files changed and docs need updating. Also auto-invoke when check-docs-updated.sh blocks a push, or when the user wants to document a project for the first time. Works on any project — not just the workflow repo.

Core Features & Use Cases

  • Identify documentation targets across the repository (README.md, docs/, CHANGELOG.md, and API docs)
  • Update documentation to reflect current code structure and components
  • Apply auto-invocation on triggers such as check-docs-updated.sh and initial project documentation

Quick Start

Run the update-docs skill on the repository to refresh all documentation.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update project documentation to reflect current codebase changes?

To update project documentation, analyze the codebase to identify targets like README.md and docs/ directories, then generate concise, accurate updates that validate against existing files and project structure.

Why does check-docs-updated.sh block my git push and how do I fix it?

The check-docs-updated.sh script blocks pushes when repository documentation is stale. Auto-invoke documentation generation to sync README.md and docs/ files with current code structure and resolve the block.

What is the best way to document a project for the first time?

Documenting a project for the first time involves scanning the repository to identify documentation targets across README.md, docs/ directories, and CHANGELOG.md, then generating accurate references reflecting the current codebase.

Can I sync stale docs automatically when workflow files change?

Yes, you can sync stale docs automatically by triggering updates when workflow files change. The process identifies affected documentation targets and refreshes README.md and docs/ directories to match the current codebase.

Does the documentation update process work on any repository or just specific ones?

The documentation update process works on any repository, not just specific workflow repos. It identifies documentation targets across the project and generates updates reflecting the current code structure and components.

What documentation files are included when refreshing repository docs?

Refreshing repository docs includes README.md, docs/ directories, CHANGELOG.md, and related MD references. The process validates these targets against existing files and the current project structure to ensure accuracy.