This directory contains comprehensive documentation for the BB project, organized into the following categories:
User-facing documentation and guides for BB users.
- Understanding BB - Guide to working effectively with BB
- How BB Works - Technical operation details
- Managing Conversations - Conversation management guide
- Planning Templates - Project planning templates and examples
- Installation guides
- Usage instructions
- Configuration guides
- Security documentation:
Documentation for BB developers and contributors.
- Examples
- Tool Creation Example - Complete example of BB creating a tool
- Reference documentation
- Tool Library Reference - Technical details of the BB Tool Library
- Tools Reference - Built-in tools documentation
- Design documents
- Implementation guides
- Publishing Tools - Guide to publishing tools in the BB Tool Library
- Creating New Tools - Guide to creating custom tools
- Model Capabilities System - Documentation for the model capabilities management system
- LLM instructions
Historical documentation and planning documents that provide context for past decisions and implementation plans.
The following core documents are maintained at the project root level for easy access:
- API.md - REST API reference
- BUI.md - Browser User Interface documentation
- CLI.md - Command Line Interface guide
- DUI.md - Desktop User Interface documentation
- CODE_OF_CONDUCT.md - Project conduct guidelines
- CONTRIBUTING.md - Contribution guidelines
- SECURITY.md - Security policies
Each subdirectory contains its own README.md with detailed information about the documents in that section. Use these README files to navigate to specific documentation:
- User Documentation - Guides and documentation for BB users
- Understanding BB and operation guides
- Conversation management
- Planning templates and examples
- Installation and configuration guides
- Custom Tools Guide - Using custom tools from the BB Tool Library
- Development Documentation - Technical documentation for developers
- Archive - Historical documentation