sync-docs-release

Automate documentation synchronization and software release workflows with git and GitHub CLI.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates the manual overhead of coordinating documentation updates with software releases, ensuring that your project's documentation is always in sync with the latest code changes before a release is published.

Core Features & Use Cases

  • Automated Sync: Triggers a subagent to sync documentation to recent commits.
  • Safe Landing: Handles complex git operations, including branch creation, patch application, and pull request management, to ensure doc changes are landed safely without polluting the default branch.
  • Release Orchestration: Sequences the documentation update, PR merge, and release creation to ensure the final release artifact contains the most up-to-date documentation.

Quick Start

Ask the agent to sync docs and cut a release to update the project documentation and publish the latest version in one automated sequence.

Frequently Asked Questions about sync-docs-release

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

FAQPage Schema
How do I automate syncing documentation with a software release?

To automate syncing documentation with a software release, use a workflow that manages git worktrees and pull request lifecycles to apply doc patches safely. This sequences documentation updates before cutting the final release.

Why does my documentation get out of sync when publishing a release?

Documentation gets out of sync during a release because manual updates often lag behind code changes. Automating the end-to-end workflow ensures a subagent syncs docs to recent commits before the release is published, eliminating manual overhead.

Do I need GitHub CLI to automate pull request management for documentation updates?

Yes, you need GitHub CLI to automate pull request management for documentation updates. The workflow requires git and GitHub CLI to perform branch management, apply patches, and manage PR lifecycles safely without polluting the default branch.

How does git worktree help with landing documentation changes safely?

Git worktree helps land documentation changes safely by isolating branch creation and patch application from the default branch. This ensures documentation updates are applied and reviewed via pull requests without polluting the main codebase.

Can I use subagents to handle release tasks and documentation synchronization?

Yes, you can use subagents to handle release tasks and documentation synchronization. The workflow triggers a configured subagent runner to sync documentation to recent commits and execute subagent-driven release tasks for consistency.

What's the best way to coordinate documentation updates with code changes before a release?

The best way to coordinate documentation updates with code changes is orchestrating an end-to-end sequence that triggers doc synchronization, manages PR merges, and then cuts the release artifact to ensure it contains updated documentation.