Skills

Update Docs

Update documentation pages to match source code changes on the current branch

Install

npx skills add pipecat-ai/pipecat --skill update-docs -g -a claude-code -y
Repository
pipecat-ai/pipecat17k
Category
Writing
Updated
3d ago
License
BSD-2-Clause
Context cost
Mediumabout 3,000 tokens
Runs scripts
No, instructions only

What it does

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.

This skill is repo-agnostic and shared. It is published by the pipecat-dev-skills marketplace and used by every repository whose changes feed pipecat-ai/docs, so it must stay free of anything specific to one of them.

Everything repo-specific, what is in scope, how files map to pages, what a new page looks like, where it gets registered, comes from that repo's profile, .claude/skills/update-docs/SOURCE_DOC_MAPPING.md, which lives in the repo being documented. The skill never hardcodes a source path, a page template, or a navigation group. See PROFILE_CONTRACT.md for what a profile must provide.

How pages read, what to document, what to leave out, page templates, prose, comes from the docs repo's style guide, DOCS_PATH/STYLE.md. This skill covers the process: finding what changed, deciding what the docs need, and checking the result.

REVIEW.md is a second pass over a finished update, run in a fresh session that did not write it. The automation runs it after this skill; run it by hand the same way after a local update.

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, profile, and style guide

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 docs.json.

Read the whole SKILL.md on GitHub

More in Writing