Welcome to the Pipecat documentation repository! This project contains the official documentation] for the Pipecat open-source project.
This repository is deployed on docs.pipecat.ai.
pipecat is a framework for building voice (and multimodal) conversational agents. Things like personal coaches, meeting assistants, storytelling toys for kids, customer support bots, intake flows, and snarky social companions.
This repository is dedicated to maintaining up-to-date, high-quality documentation to support users and contributors. Here you’ll find:
- User Guides: Step-by-step instructions to get started with Pipecat.
- API Documentation: Detailed API references.
- Tutorials: Hands-on tutorials to help you automate your workflows.
We welcome contributions of all kinds! Whether you're fixing a typo, adding a new section, or improving the readability of the existing content, your help is appreciated. Follow these steps to get involved:
-
Fork this repository: Start by forking the Pipecat Documentation repository to your GitHub account.
-
Clone the repository: Clone your forked repository to your local machine.
git clone https://github.com/your-username/docs
-
Create a branch: For your contribution, create a new branch.
git checkout -b your-branch-name
-
Make your changes: Edit or add files as necessary.
-
Test your changes: Ensure that your changes look correct and follow the style guide. Refer to Development section to test portal locally.
-
Commit your changes: Once you're satisfied with your changes, commit them with a meaningful message.
git commit -m "Description of your changes"- Push your changes: Push your branch to your forked repository.
git push origin your-branch-name- Submit a Pull Request (PR): Open a PR from your forked repository to the main branch of this repo. Describe the changes you've made clearly.
Our maintainers will review your PR, and once everything is good, your contributions will be merged!
The documentation is using Mintlify to render beautifuly. Mintlify comes with a set of components to help you write better more interactive documentation.
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i -g mintlify
Run the following command at the root of your documentation (where mint.json is)
mintlify dev
Open https://localhost:3000 in your browser and check your changes.
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json