update-docs
Update documentation pages to match source code changes on the current branch
Best for Feature branches with servi…Works with GitHubLow risk
⌘source
- author
@pipecat-ai- language
- Python
★11kstars
2kforks
Apr 21, 2026
✦overview.md
Key Features
- ·Updates documentation to match source code changes
- ·Analyzes git diff against main branch
- ·Maps changed source files to corresponding doc pages
- ·Creates a matching branch in the docs repository
- ·Targets edits to service, transport, and serializer files
Use Cases
- →Keeping API documentation in sync after a service implementation change
- →Ensuring transport layer docs reflect new protocol support
- →Updating serialization format documentation when schemas change
- →Automating doc updates as part of a feature branch workflow
Best for
- ✓Feature branches with service/transport/serializer changes
- ✓Teams maintaining separate code and documentation repos
Not ideal for
- !Documentation unrelated to service/transport/serializer code
- !One-off documentation fixes without corresponding code changes
FAQs
name
update-docs
description
Update documentation pages to match source code changes on the current branch
Update documentation pages to reflect source code changes on the current branch. Analyzes the diff against main, maps changed source files to their corresponding doc pages, and makes targeted edits.
Arguments
/update-docs [DOCS_PATH]
DOCS_PATH(optional): Path to the docs repository root. If not provided, ask the user.
Examples:
/update-docs /Users/me/src/docs/update-docs
Instructions
Step 1: Resolve docs path
If DOCS_PATH was provided as an argument, use it. Otherwise, ask the user for the path to their docs repository.
Verify the path exists and contains server/services/ subdirectory.
Step 2: Create docs branch
Get the current pipecat branch name:
git rev-parse --abbrev-ref HEAD
In the docs repo, create a new branch off main with a matching name:
cd DOCS_PATH && git checkout main && git pull && git checkout -b {branch-name}-docs
For example, if the pipecat branch is feat/new-service, the docs branch becomes feat/new-service-docs.
All doc edits in subsequent steps are made on this branch.
Step 3: Detect changed source files
Run:
git diff main..HEAD --name-only
$install
1-click copynpx skills add pipecat-ai/pipecat --skill update-docsSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.