update-docs

Synchronize source-level docs and docs-site pages with code changes.

16|3|Updated May 5, 2026

Search Tags:#documentation #codebase #readme #quality #diff #docs

Ready to run

npx skills add https://github.com/Kevin-Liu-01/Agent-Machines --skill update-docs-kevin-liu-01

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/Kevin-Liu-01/Agent-Machines/tree/main/knowledge/skills/update-docs
Command: npx skills add https://github.com/Kevin-Liu-01/Agent-Machines --skill update-docs-kevin-liu-01

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often goes out of date when code changes, leading to confusion and reduced trust. This skill coordinates updates to both source-level docs and the docs site to ensure accuracy and clarity.

Core Features & Use Cases

Phase 1: Identify what changed by running diffs and noting new/renamed/deleted symbols that affect docs.
Phase 2: Update source-level docs (module docs, docstrings, inline comments, README files) to reflect changes.
Phase 3: Align docs site content under docs/src, ensuring architecture pages and references stay consistent with code and module docs.
Phase 4: Verify consistency across code, module docs, and docs site with cross-references and updated READMEs.

Quick Start

Start by running a diff of the changed files, then update the affected module docs and docs site accordingly.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I keep documentation in sync with code changes?▼

To keep documentation in sync with code changes, run a diff of changed files to identify new, renamed, or deleted symbols, then update module docs, docstrings, and READMEs to reflect those changes.

What is the best way to update a docs site after modifying source code?▼

Updating a docs site after modifying source code requires aligning architecture pages and references under docs/src, ensuring all site content stays consistent with the updated code and module-level documentation.

How do I identify which documentation needs updating after a codebase change?▼

Identify documentation needing updates by running diffs across the codebase to track new, renamed, or deleted symbols that affect docs, providing a structured list of affected files to update.

Can I verify consistency across code, module docs, and the docs site?▼

Yes, you can verify consistency across code, module docs, and the docs site by checking cross-references and updating READMEs to ensure accuracy and clarity throughout the software project.

When do I need to update inline comments and docstrings in my project?▼

Update inline comments and docstrings whenever source-level code changes occur, ensuring that internal documentation accurately reflects the modified symbols and maintains trust in the codebase.