Rodrigo Rodriguez (Pragmatismo) d1301c9cd8 Add balanced documentation structure

Documentation organized with equilibrium:
- Small (50-100 lines): Index files
- Medium (250-400 lines): Guides
- Large (450-600 lines): Complete references

Structure:
- docs/api/ - REST endpoints, WebSocket
- docs/guides/ - Getting started, deployment, templates
- docs/reference/ - BASIC language, configuration, architecture

Updated README.md to point to new docs location.

2025-12-04 12:44:18 -03:00

1.8 KiB

Raw Blame History

General Bots Documentation

Welcome to the General Bots documentation. This guide covers everything you need to build, deploy, and manage AI-powered bots.

Section	Description
Getting Started	Installation and first bot
API Reference	REST endpoints and WebSocket
BASIC Language	Dialog scripting reference
Configuration	Environment and settings

Documentation Structure

docs/
├── api/                    # API documentation
│   ├── README.md           # API overview
│   ├── rest-endpoints.md   # HTTP endpoints
│   └── websocket.md        # Real-time communication
├── guides/                 # How-to guides
│   ├── getting-started.md  # Quick start
│   ├── deployment.md       # Production setup
│   └── templates.md        # Using templates
└── reference/              # Technical reference
    ├── basic-language.md   # BASIC keywords
    ├── configuration.md    # Config options
    └── architecture.md     # System design

Core Concepts

Knowledge Bases (KB)

Store documents, FAQs, and data that the AI can search and reference:

USE KB "company-docs"

Tools

Functions the AI can call to perform actions:

USE TOOL "send-email"
USE TOOL "create-ticket"

Dialogs

BASIC scripts that define conversation flows and automation:

TALK "Hello! How can I help?"
answer = HEAR

Quick Links

Version

This documentation covers General Bots v6.x.

1.8 KiB Raw Blame History