Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.38 KB

File metadata and controls

34 lines (27 loc) · 1.38 KB

Documentation

The repository landing page explains what the platform is and who it is for. The documents here cover the operational detail needed to run and evaluate it.

Manuals

  • docs.cbk.ai - the platform's technical manuals, generated from this source: API, SDKs, integrations and every configurable surface
  • chatbotkit.com/docs - the user manuals for the hosted ChatBotKit product built on the platform

Start here

  • Getting started - run the complete local stack, sign in and configure a model
  • Deployment - Compose profiles, current production status and operator responsibilities
  • Module defaults - what each public module does with nothing set, and what the distribution flavors change
  • SDKs - point the Node.js, Python, Go and Terraform clients at your own deployment

Project guides

  • Architecture - application structure, module boundaries and contribution branches
  • Configuration - operator-owned configuration seams and database credential encryption
  • Contributing - development workflow, quality checks and pull requests
  • Security - private vulnerability reporting
  • Support - community and hosted-product support boundaries