update-docs

Updates README.md and CHANGELOG.md from git commits.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/regression-io/coder-config --skill update-docs-regression-io
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/regression-io/coder-config/tree/main/plugin/skills/update-docs
Command: npx skills add https://github.com/regression-io/coder-config --skill update-docs-regression-io

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Ensures that the README.md and CHANGELOG.md files are up-to-date with the latest changes in the codebase, improving the quality and accuracy of the project's documentation.

Core Features & Use Cases

  • Documentation Synchronization: Updates README.md and CHANGELOG.md with the current state of the system.
  • Version Control Integration: Utilizes git commits to determine changes and updates.
  • Use Case: Before committing significant changes or when creating a pull request, this skill helps ensure that documentation is accurate and reflects the latest changes.

Quick Start

Run the update-docs skill to synchronize your documentation.

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 README and CHANGELOG from git commits?▼

To update README and CHANGELOG from git commits, you need a tool that reviews your repository history and reflects those changes in your documentation. This skill automates that synchronization by analyzing commit logs to keep your project files accurate.

What is the best way to keep documentation in sync with a codebase before a pull request?▼

Keeping documentation in sync before a pull request requires reviewing recent codebase changes and applying them to your docs. Running this skill ensures your README and CHANGELOG accurately reflect the current system state before merging.

Do I need git repository access to synchronize project documentation?▼

Yes, you need git repository access to synchronize project documentation. The process relies on reviewing git commits to determine codebase changes, requiring direct access to the repository to update README and CHANGELOG files accurately.

How does document synchronization work with version control history?▼

Document synchronization with version control works by parsing git commit history to identify recent changes. It then applies these changes to your README and CHANGELOG files, ensuring your documentation reflects the latest codebase updates.

Can I use this to generate a CHANGELOG from recent codebase changes?▼

Yes, you can use this to generate a CHANGELOG from recent codebase changes. By reviewing git commits, the tool identifies what has been modified and updates your CHANGELOG.md to reflect the latest project state.