sync-docs

Synchronize project documentation files using recent commits and PRs.

45|7|Updated Jul 4, 2026
One-click install
npx skills add https://github.com/richkuo/rk-skills --skill sync-docs-richkuo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/richkuo/rk-skills/tree/main/skills/sync-docs
Command: npx skills add https://github.com/richkuo/rk-skills --skill sync-docs-richkuo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of documentation drift, where project files like CLAUDE.md or README.md become outdated as code evolves, ensuring your documentation always reflects the current state of the repository.

Core Features & Use Cases

  • Automated Synchronization: Automatically updates key project files including CLAUDE.md, AGENTS.md, SKILL.md, and README.md.
  • Context-Aware Updates: Uses recent commit history and PR context to generate accurate, relevant documentation updates.
  • Use Case: After completing a series of feature PRs, use this skill to ensure all project documentation is updated to reflect the new functionality and architectural changes without manual editing.

Quick Start

Ask the assistant to sync the project documentation to reflect the changes made in the recent pull requests.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I keep project documentation in sync with code changes automatically?

You can keep project documentation in sync by triggering an automated subagent that analyzes recent commits and PRs to update CLAUDE.md, AGENTS.md, SKILL.md, and README.md based on repository context.

How does automated documentation synchronization analyze recent pull requests?

Automated documentation synchronization works by deploying a specialized subagent to review recent commit history and PR context, then updating project documentation files to accurately reflect the current repository state.

What's the best way to update README.md after merging multiple feature PRs?

The best way to update README.md after merging feature PRs is to use a documentation synchronization tool that automatically analyzes commit history and PR context to generate relevant documentation updates without manual editing.

Do I need a specific subagent configuration to synchronize project documentation?

Yes, you need the sync-docs-runner subagent available in your local agent configuration to execute documentation synchronization within the repository environment and update project files.

Can I use documentation sync tools to update CLAUDE.md and AGENTS.md simultaneously?

Yes, documentation synchronization can update CLAUDE.md and AGENTS.md simultaneously, alongside SKILL.md and README.md, by analyzing repository context and recent commits to ensure all files reflect current functionality.

Why does project documentation drift occur and how can I prevent it?

Documentation drift occurs when project files become outdated as code evolves without corresponding manual updates. You can prevent it by using automated synchronization to ensure documentation always reflects the current repository state.