docs-refresh

Update CLAUDE.md and README.md files to match current codebase state.

Updated May 28, 2026
One-click install
npx skills add https://github.com/carlosap6576/talos-skills --skill docs-refresh-carlosap6576
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-refresh
Source: https://github.com/carlosap6576/talos-skills/tree/main/docs-refresh
Command: npx skills add https://github.com/carlosap6576/talos-skills --skill docs-refresh-carlosap6576

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Maintaining project documentation (CLAUDE.md and README.md) in sync with evolving codebases is tedious, error-prone, and often neglected until the docs are completely outdated and useless. This Skill automates the entire documentation refresh workflow to eliminate that manual overhead and ensure docs always reflect the current state of the code.

Core Features & Use Cases

  • Orchestrated 4-Pass Workflow: Uses real gstack expert subagents to discover deltas between docs and code, draft prioritized edits, apply surgical changes, and run parallel verification checks for consistency and secret leaks.
  • Partial Refresh Modes: Automatically adapts to projects that only have CLAUDE.md, only have README.md, or both, with a friendly exit if no docs exist to refresh.
  • Fast Re-Runs with Caching: Stores intermediate work in a local cache to short-circuit runs when no code changes have occurred since the last successful refresh.
  • Use Case: After shipping a new feature set, run this skill to automatically identify gaps between your docs and code, update the docs while preserving their original voice and structure, and verify the changes for accuracy and security.

Quick Start

Invoke the docs-refresh skill in your Claude Code session to automatically refresh your existing project documentation to match the current state of your codebase.

Frequently Asked Questions about docs-refresh

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

FAQPage Schema
How do I automatically update stale README.md and CLAUDE.md files to match my codebase?

To update stale documentation to match your codebase, this skill orchestrates specialized subagents to compute change deltas, apply surgical edits to existing docs while preserving their original voice, and verify cross-doc consistency. It supports projects with either or both file types.

What is the best way to sync project documentation with recent code changes without manual rewriting?

Syncing project documentation with recent code changes is handled by a 4-pass workflow that discovers deltas between docs and code, drafts prioritized edits, applies surgical modifications, and runs parallel verification checks for consistency and secret leaks.

Can I refresh project docs if my repository only has a README.md and no CLAUDE.md file?

Yes, you can refresh project docs with partial refresh modes that automatically adapt to repositories maintaining only a CLAUDE.md, only a README.md, or both. The skill exits cleanly if no target documentation exists to update.

How do I avoid redundant documentation refresh runs when no code has changed since the last update?

To avoid redundant documentation refresh runs, the skill stores intermediate work in a local cache to short-circuit execution when no code changes have occurred since the last successful update, enabling fast no-change re-runs.

Does the documentation refresh process check for accidentally leaked secrets in the updated files?

Yes, the documentation refresh process runs parallel verification checks specifically designed to detect secret leaks alongside cross-doc consistency validation after applying surgical edits to your CLAUDE.md and README.md files.

Will updating my documentation alter the original structure and formatting of my existing files?

Updating your documentation will not alter the original structure because the skill applies surgical modifications specifically designed to preserve the original document voice and structure while aligning the content with the current codebase state.