Welcome to the Botpress documentation repository. This project powers the docs site of Botpress, the complete AI Agent platform.

To get started with contributions, please review the entire README.

To contribute, install the following software if you haven't already:

• VS Code, Cursor, or another text editor
• Node.js (v18 or higher)
• pnpm package manager
• Vale for writing style checks (optional but recommended)
• Mintlify CLI for the local development server

1. Clone the repository:

   git clone https://github.com/botpress/docs.git
   cd docs

2. Install dependencies:

   pnpm install

3. Start the development server:

   mint dev

   This will start a local Mintlify server at http://localhost:3000.

The Botpress documentation is built with Mintlify. Here's how the project is organized:

docs/
├── docs.json              # Mintlify configuration & navigation
├── home.mdx               # Homepage content
├── studio/                # Documentation for Botpress Studio
├── integrations/          # Integration documentation
├── webchat/              # Webchat-specific docs
├── adk/                   # Documentation for the Botpress Agent Development Kit (ADK)
├── api-reference/        # API documentation
├── snippets/             # Reusable content snippets
├── changelog.mdx         # Product changelog
├── *-openapi.json        # OpenAPI specifications
└── assets/               # Images and other static files

All documentation is written in MDX (Markdown with JSX components). You can find full list of supported components in the Mintlify documentation.

• Mintlify supports responsive light/dark images. If you're using UI screenshots, make sure you include both a light and dark version.
• Wrap all images in Mintlify's Frame component.
• Include appropriate alt text for all images

If you're using VS Code or Cursor, you can use the snippet at /.vscode/mdx.code-snippets for any images.

The docs.json file at the root of the repository determines the navigation structure of the documentation. If you're adding new pages, make sure you update docs.json to include them.

Botpress uses Vale to enforce consistent style and branding throughout the documentation. Vale executes on all pull requests in this repository.

You can also run Vale locally using the Vale CLI:

1. Install Vale if you haven't already
2. Download the required packages:

vale sync

3. Run a writing check against files you've modified:

make check-writing

All integration documentation can be found in /integrations/integration-guides. While configuration steps are hand-written, reference documentation for Cards and Triggers is automatically generated and updated on a weekly schedule.

If you're working on documentation for an integration:

1. Make sure its file name is the same as the integration's name.

2. Define a .env file at the project's root with your Botpress Personal Access Token (PAT) as BOTPRESS_TOKEN and Botpress workspace ID as BOTPRESS_WORKSPACE_ID:

3. Before pushing your changes, run:

   pnpm run update-integrations

   This will fetch the most up-to-date information for any integrations modified on the current branch.

pnpm run update-integrations <integration-name>

pnpm run update-integrations --bulk

To check for broken links, run:

mint broken-links

This check also runs on every pull request in the repository.

1. Fork the repository
2. Create a feature branch: git checkout -b name/feature/your-improvement
3. Make your changes following our style guidelines
4. Test your changes locally with mint dev
5. Validate writing style with make check-writing (if Vale is installed)
6. Check for broken links using mint broken-links
7. Submit a pull request with a clear description of your changes

Use this repository for specific documentation-related issues only. Report any product bugs (or general documentation feedback) via Discord.

Join the conversation on our Discord server for any other questions related to Botpress—we'd love to hear from you.

Thank you for helping us improve the Botpress documentation!