Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
144 lines (96 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

144 lines (96 loc) · 4.32 KB
Raw

Contributing to Pipecat Documentation

Welcome! This is the documentation repository for Pipecat, hosted at docs.pipecat.ai. Whether you're fixing a typo, adding a new section, or improving readability, your help is appreciated.

Code of Conduct

This project follows the Contributor Covenant v2.1. Please treat everyone with respect. Unacceptable behavior can be reported to pipecat-ai@daily.co.

Getting Started

Prerequisites

Setup

  1. Fork this repository and clone your fork:

    git clone https://github.com/your-username/docs
cd docs

  2. Start the local dev server:

    mint dev

  3. Open https://localhost:3000 in your browser to preview changes.

Troubleshooting

  • Mintlify dev isn't running — Run mint update to get the latest version.
  • Page loads as a 404 — Make sure you are running in a folder with docs.json.

Making a Contribution

  1. Create a branch for your changes:

    git checkout -b your-branch-name

  2. Make your edits. See the Content Guidelines below.

  3. Format with Prettier to match the repo style:

    npx prettier --write .

  4. Check for broken links:

    mint broken-links

  5. Commit your changes with a meaningful message:

    git commit -m "Description of your changes"

  6. Push your branch and open a Pull Request against main:

    git push origin your-branch-name

Our maintainers will review your PR, and once everything looks good, your contributions will be merged!

Content Guidelines

MDX Frontmatter

Every page needs a title (required) and description (recommended):

---
title: "Page Title"
description: "Short description for SEO and navigation."
---

Adding Pages to Navigation

All pages must be registered in docs.json under navigation.tabs[].groups[].pages. The path is relative to the repo root without the .mdx extension:

"guides/learn/overview"

Project Structure

docs.json          # Site config: navigation, tabs, theme, metadata
getting-started/   # Intro, quickstart, ecosystem overview
guides/            # Learning guides, feature how-tos
server/            # Server-side framework reference (pipelines, services, utilities)
client/            # Client SDK docs (JS, React, React Native, etc.)
cli/               # Pipecat CLI reference
deployment/        # Pipecat Cloud deployment docs
snippets/          # Reusable MDX snippets (shared across pages)
images/            # Static images

Mintlify Components

Use Mintlify's built-in components for structured content:

Component Purpose
<Tip>, <Note>, <Warning>, <Info> Callout blocks
<Steps>, <Step> Numbered step sequences
<Tabs>, <Tab> Tabbed content (e.g., Python/JS)
<Card>, <CardGroup> Linked card grids
<Accordion>, <AccordionGroup> Collapsible sections
<Frame> Image wrapper with caption support
<CodeGroup> Multi-language code block switcher

Formatting

Prettier is configured via .prettierrc:

  • 2-space indentation (spaces, not tabs)
  • Double quotes
  • Semicolons enabled

Run npx prettier --write . before committing to ensure consistent formatting.

Continuous Integration

A GitHub Actions workflow runs mint broken-links on every PR and push to main. If broken links are detected, the workflow will fail and post a comment on your PR. You can run the same check locally:

mint broken-links

Getting Help