Botpress Documentation

This repository contains comprehensive documentation for the Botpress ecosystem, including the CLI, integrations, bots, plugins, and SDK. Find guides, technical specifications, procedures, and best practices for all Botpress components.

📋 Quick Navigation

• CLI Documentation - Features, guides, performance, and technical design
• Integrations Documentation - Procedures and migration guides
• Bots Documentation - Building and managing bots
• Plugins Documentation - Creating and using plugins
• SDK Documentation - Botpress SDK reference

📚 Documentation Structure

CLI Documentation

Features

• BP Doctor - Diagnostic command for environment and configuration validation

How-To Guides

• Complete How-To Guides - Step-by-step guides covering:
  • Creating your first bot from scratch
  • Building custom integrations
  • Developing with hot reload
  • Managing multiple environments
  • Debugging and troubleshooting

Performance

• Performance Optimization Guide - Comprehensive analysis of CLI performance optimizations, metrics, and improvement opportunities

Technical Design

• Technical Design Document - Complete architecture documentation covering:
  • System overview and architecture
  • Command system design
  • Build and deployment pipeline
  • Development mode
  • Code generation system
  • Security considerations

Integrations Documentation

Procedures

• Remove BP Lint - Procedure for removing /* bplint-disable */ annotations and migrating to the new ZUI transformer

Bots Documentation

Coming soon - Documentation for building and managing bots

Plugins Documentation

Coming soon - Documentation for creating and using plugins

SDK Documentation

Coming soon - Documentation for the Botpress SDK

---