What happens if a new source file doesn't have a documentation page yet?

The skill identifies these gaps and offers to create a new .mdx page using a standardized template. It will also automatically add the new page to the site's navigation and supported services lists.

Does this skill overwrite my custom documentation content?

No, the skill is designed to be conservative. It only updates specific sections like Configuration, InputParams, and Event Handlers based on source code changes while preserving your existing prose and formatting.

How does it handle navigation and sidebar updates?

It automatically updates docs.json, inserting new pages into the correct category group (STT, TTS, LLM, etc.) in alphabetical order to maintain organization.

Does it support updating code examples in guides?

Yes. After updating reference pages, the skill searches the guides directory for references to changed classes or parameters and updates the code snippets to match the new API.

Pipecat Documentation Sync

Name: Pipecat Documentation Sync
Author: pipecat-ai

bypipecat-ai

•

10,844

•

学习与文档

Synchronizes Pipecat documentation pages with source code changes to ensure API references and guides stay accurate.

This skill automates the complex task of keeping documentation in sync with the Pipecat framework by analyzing Git diffs between the current branch and main. It intelligently maps changed source files to their corresponding MDX documentation pages and performs targeted edits to constructor parameters, runtime settings, event handlers, and usage examples. Beyond simple reference updates, the skill also identifies and fixes broken references in conceptual guides, generates new service pages from templates, and maintains navigation structures in docs.json and supported-services lists, ensuring a seamless developer experience.

主要功能

01Scans and updates conceptual guides and tutorials referencing modified APIs

0210,844 GitHub stars

03Maps source code changes to specific MDX documentation pages using a tiered lookup system

04Automates the management of docs.json and supported-services.mdx summary tables

05Performs targeted edits on constructor parameters, InputParams tables, and event handlers

06Generates new service documentation pages with proper frontmatter and navigation entries

使用场景

01Automating the boilerplate setup for documentation when contributing a new AI service provider

02Updating reference documentation after adding new parameters or event handlers to a Pipecat service

03Synchronizing conceptual guides when class names or import paths are refactored

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add pipecat-ai/pipecat update-docs

For use in Claude.ai and ChatGPT

Download Skill