update-docs

Check and update repository documentation before pull requests are created.

2|Updated Feb 16, 2026

Search Tags:#automation #git #documentation #mermaid #readme #api docs

Ready to run

npx skills add https://github.com/dmzoneill/skills --skill update-docs-dmzoneill

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/dmzoneill/skills/tree/main/update-docs
Command: npx skills add https://github.com/dmzoneill/skills --skill update-docs-dmzoneill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation is accurate and current, preventing outdated information from causing confusion or errors, especially before merging changes.

Core Features & Use Cases

Automated Documentation Checks: Scans for outdated documentation, broken links, and outdated diagrams.
Configurable Scope: Works for repositories with docs.enabled=true in config.json.
Use Case: Before creating a pull request for a new feature, run this skill to automatically verify that the README, API documentation, and any mermaid diagrams accurately reflect the changes.

Quick Start

Use the update-docs skill to check and update the documentation for the current repository.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I automatically update repository documentation before creating a pull request?▼

To automatically update repository documentation before a pull request, run a skill that checks and updates READMEs, API docs, and mermaid diagrams. It scans for outdated information and broken links, ensuring your documentation accurately reflects recent changes.

Can I automatically update mermaid diagrams and README files when code changes?▼

Yes, you can automatically update mermaid diagrams and README files when code changes. The skill integrates with git to identify repository modifications and resolves the specifics to refresh outdated diagrams and documentation content before merging.

How does automated documentation checking work with git repositories?▼

Automated documentation checking works with git repositories by integrating with knowledge tools to resolve repository specifics and identify changes. It scans enabled repositories for outdated documentation, broken links, and outdated diagrams, supporting automated commits for updates.

Do I need a specific configuration to enable automated documentation checks?▼

Yes, you need a specific configuration to enable automated documentation checks. The skill is designed exclusively for repositories with documentation enabled via configuration, specifically requiring `docs.enabled=true` in your `config.json` file to function properly.

What is the best way to keep API docs and READMEs current before merging code?▼

The best way to keep API docs and READMEs current before merging code is to run an automated documentation check. This process verifies that your API documentation and READMEs accurately reflect the new feature changes, preventing outdated information from causing errors.

What types of documentation issues can an automated repository scanner detect?▼

An automated repository scanner detects outdated documentation, broken links, and outdated diagrams. By scanning READMEs, API docs, and mermaid diagrams, it identifies discrepancies between the codebase and the documentation before a pull request is created.