diff --git a/REORGANIZATION_PLAN.md b/REORGANIZATION_PLAN.md new file mode 100644 index 00000000..1da32977 --- /dev/null +++ b/REORGANIZATION_PLAN.md @@ -0,0 +1,71 @@ +# BotBook Reorganization - COMPLETED + +## Status: ✅ DONE + +### Execution Summary: + +1. ✅ Created 12 new chapter directories +2. ✅ Moved all 422 markdown files to new structure +3. ✅ Updated SUMMARY.md with new 12-chapter TOC +4. ✅ Fixed all internal links (228+ replacements) +5. ✅ Renamed asset folders to match new chapters +6. ✅ Updated asset references in markdown files +7. ✅ Updated all chapter README titles + +--- + +## Final Structure (12 Chapters): + +| # | Chapter | Files | +|---|---------|-------| +| 01 | Getting Started | 8 | +| 02 | Architecture & Packages | 43 | +| 03 | Knowledge & AI | 33 | +| 04 | BASIC Scripting | 124 | +| 05 | Multi-Agent Orchestration | 9 | +| 06 | Channels & Connectivity | 18 | +| 07 | User Interface | 13 + apps | +| 08 | REST API & Tools | 36 | +| 09 | Security | 24 | +| 10 | Configuration & Deployment | 14 | +| 11 | Hardware & Scaling | 9 | +| 12 | Ecosystem & Reference | 43 | + +**TOTAL: 422 markdown files** + +--- + +## What was done: + +### Directory Reorganization: +- `01-introduction` → `01-getting-started` +- `02-templates` + `07-gbapp` → `02-architecture-packages` +- `03-knowledge-base` + `11-features` → `03-knowledge-ai` +- `06-gbdialog` → `04-basic-scripting` +- `17-autonomous-tasks` → `05-multi-agent` +- `18-appendix-external-services` → `06-channels` +- `04-gbui` + `05-gbtheme` → `07-user-interface` +- `09-tools` + `10-rest` → `08-rest-api-tools` +- `12-auth` + `23-security` → `09-security` +- `08-config` → `10-configuration-deployment` +- `13-hardware-devices` + `20-embedding` + `21-scale` → `11-hardware-scaling` +- `13-community` + `14-migration` + `15-appendix` + `17-testing` + `19-maintenance` + `22-white-label` → `12-ecosystem-reference` + +### Link Fixes: +- 228+ old chapter references replaced +- Asset folder references updated + +### Assets: +- All SVG assets preserved in `/assets` +- Chapter-specific assets moved to new folder names + +--- + +## To Build the Book: + +```bash +cd /home/rodriguez/src/gb/botbook +mdbook build +``` + +This will regenerate the HTML with the new 12-chapter structure. diff --git a/src/01-introduction/README.md b/src/01-getting-started/README.md similarity index 100% rename from src/01-introduction/README.md rename to src/01-getting-started/README.md diff --git a/src/01-introduction/assets/bootstrap-process.svg.backup b/src/01-getting-started/assets/bootstrap-process.svg.backup similarity index 100% rename from src/01-introduction/assets/bootstrap-process.svg.backup rename to src/01-getting-started/assets/bootstrap-process.svg.backup diff --git a/src/01-introduction/assets/quick-start-bootstrap.svg.backup b/src/01-getting-started/assets/quick-start-bootstrap.svg.backup similarity index 100% rename from src/01-introduction/assets/quick-start-bootstrap.svg.backup rename to src/01-getting-started/assets/quick-start-bootstrap.svg.backup diff --git a/src/01-introduction/assets/session-manager.svg.backup b/src/01-getting-started/assets/session-manager.svg.backup similarity index 100% rename from src/01-introduction/assets/session-manager.svg.backup rename to src/01-getting-started/assets/session-manager.svg.backup diff --git a/src/01-introduction/assets/session-states.svg.backup b/src/01-getting-started/assets/session-states.svg.backup similarity index 100% rename from src/01-introduction/assets/session-states.svg.backup rename to src/01-getting-started/assets/session-states.svg.backup diff --git a/src/01-introduction/assets/tool-execution-flow.svg.backup b/src/01-getting-started/assets/tool-execution-flow.svg.backup similarity index 100% rename from src/01-introduction/assets/tool-execution-flow.svg.backup rename to src/01-getting-started/assets/tool-execution-flow.svg.backup diff --git a/src/01-introduction/first-conversation.md b/src/01-getting-started/first-conversation.md similarity index 100% rename from src/01-introduction/first-conversation.md rename to src/01-getting-started/first-conversation.md diff --git a/src/01-introduction/installation.md b/src/01-getting-started/installation.md similarity index 96% rename from src/01-introduction/installation.md rename to src/01-getting-started/installation.md index a66bab88..7eaf40ad 100644 --- a/src/01-introduction/installation.md +++ b/src/01-getting-started/installation.md @@ -175,8 +175,8 @@ Requires CUDA installed and 12GB+ VRAM. | Method | Use Case | Guide | |--------|----------|-------| | **Local** | Development, single instance | This page | -| **Docker** | Production, microservices | [Docker Deployment](../chapter-07-gbapp/docker-deployment.md) | -| **LXC** | Isolated components, Linux | [Container Deployment](../chapter-07-gbapp/containers.md) | +| **Docker** | Production, microservices | [Docker Deployment](../02-architecture-packages/docker-deployment.md) | +| **LXC** | Isolated components, Linux | [Container Deployment](../02-architecture-packages/containers.md) | | **Brother Mode** | Container managing host containers | See below | ### Container-on-Host (Brother Mode) @@ -227,4 +227,4 @@ lxc list | grep mycompany - [Quick Start Guide](./quick-start.md) - Create your first bot - [First Conversation](./first-conversation.md) - Test your bot -- [Configuration Reference](../chapter-08-config/README.md) - All settings \ No newline at end of file +- [Configuration Reference](../10-configuration-deployment/README.md) - All settings \ No newline at end of file diff --git a/src/01-introduction/local-domains.md b/src/01-getting-started/local-domains.md similarity index 100% rename from src/01-introduction/local-domains.md rename to src/01-getting-started/local-domains.md diff --git a/src/01-introduction/overview.md b/src/01-getting-started/overview.md similarity index 100% rename from src/01-introduction/overview.md rename to src/01-getting-started/overview.md diff --git a/src/01-introduction/quick-start.md b/src/01-getting-started/quick-start.md similarity index 89% rename from src/01-introduction/quick-start.md rename to src/01-getting-started/quick-start.md index 159e7753..d46fea08 100644 --- a/src/01-introduction/quick-start.md +++ b/src/01-getting-started/quick-start.md @@ -45,7 +45,7 @@ Start chatting with your bot! ### Bootstrap Flow -Bootstrap Flow +Bootstrap Flow The **automatic bootstrap** process: @@ -78,7 +78,7 @@ drive-secret,my-secret-key ### How Tools Work -Tool Execution Flow +Tool Execution Flow Tools are just `.bas` files. Create `enrollment.bas`: @@ -277,11 +277,11 @@ rm .env ## Documentation -- **[Full Installation Guide](docs/src/chapter-01/installation.md)** - Detailed bootstrap explanation -- **[Tool Definition](docs/src/chapter-08/tool-definition.md)** - Creating tools -- **[BASIC Keywords](docs/src/chapter-05/keywords.md)** - Language reference -- **[Package System](docs/src/chapter-02/README.md)** - Creating bots -- **[Architecture](docs/src/chapter-06/architecture.md)** - How it works +- **[Full Installation Guide](docs/src/01-getting-started/installation.md)** - Detailed bootstrap explanation +- **[Tool Definition](docs/src/08-rest-api-tools/tool-definition.md)** - Creating tools +- **[BASIC Keywords](docs/src/07-user-interface/keywords.md)** - Language reference +- **[Package System](docs/src/02-architecture-packages/README.md)** - Creating bots +- **[Architecture](docs/src/04-basic-scripting/architecture.md)** - How it works --- diff --git a/src/01-introduction/sessions.md b/src/01-getting-started/sessions.md similarity index 96% rename from src/01-introduction/sessions.md rename to src/01-getting-started/sessions.md index d5efb5f2..418c6d8a 100644 --- a/src/01-introduction/sessions.md +++ b/src/01-getting-started/sessions.md @@ -2,7 +2,7 @@ Every conversation has memory. Sessions are the beating heart of botserver because they remember who you are, what you have said, and where you left off. Even if you close your browser and come back tomorrow, your conversation continues right where it paused. -Session Manager +Session Manager ## What Is a Session? @@ -37,7 +37,7 @@ Sessions come in two flavors depending on user identity. Anonymous sessions are ## Session Lifecycle -Session States +Session States Sessions move through several states during their existence. Active sessions have no timeout while the user is actively chatting. Idle sessions timeout after 30 minutes by default, though this is configurable. Expired sessions are removed after 7 days for anonymous users, while authenticated sessions never expire automatically. diff --git a/src/07-gbapp/README.md b/src/02-architecture-packages/README.md similarity index 91% rename from src/07-gbapp/README.md rename to src/02-architecture-packages/README.md index 64f17cc6..0e99bcaa 100644 --- a/src/07-gbapp/README.md +++ b/src/02-architecture-packages/README.md @@ -1,4 +1,4 @@ -# Chapter 07: Extending General Bots +# Chapter 2: Architecture & Packages Architecture and deployment reference for developers. @@ -25,7 +25,7 @@ botserver is built in Rust with a modular architecture. Extend it by creating cu | Method | Use Case | Guide | |--------|----------|-------| -| **Local** | Development | [Installation](../chapter-01/installation.md) | +| **Local** | Development | [Installation](../01-getting-started/installation.md) | | **Docker** | Production | [Docker Deployment](./docker-deployment.md) | | **LXC** | Isolated components | [Container Deployment](./containers.md) | @@ -82,5 +82,5 @@ See [Autonomous Task AI](./autonomous-tasks.md) for complete documentation. ## See Also -- [Installation](../chapter-01/installation.md) - Getting started -- [BASIC Reference](../chapter-06-gbdialog/README.md) - Scripting language \ No newline at end of file +- [Installation](../01-getting-started/installation.md) - Getting started +- [BASIC Reference](../04-basic-scripting/README.md) - Scripting language \ No newline at end of file diff --git a/src/07-gbapp/architecture.md b/src/02-architecture-packages/architecture.md similarity index 96% rename from src/07-gbapp/architecture.md rename to src/02-architecture-packages/architecture.md index 2d030af7..a966d3c7 100644 --- a/src/07-gbapp/architecture.md +++ b/src/02-architecture-packages/architecture.md @@ -9,16 +9,16 @@ The architecture diagrams below illustrate the major components and their relati ### Data Flow Architecture -botserver Data Flow Architecture +botserver Data Flow Architecture ### System Architecture -botserver System Architecture +botserver System Architecture ## Module Dependency Graph -Module Dependency Graph +Module Dependency Graph ## Module Organization @@ -27,7 +27,7 @@ The codebase is organized into modules that group related functionality together ### Data Flow Through Modules -Data Flow Through Modules +Data Flow Through Modules ### Core Modules diff --git a/src/02-templates/assets/package-structure.svg.backup b/src/02-architecture-packages/assets/package-structure.svg.backup similarity index 100% rename from src/02-templates/assets/package-structure.svg.backup rename to src/02-architecture-packages/assets/package-structure.svg.backup diff --git a/src/02-templates/assets/template-deployment-flow.svg.backup b/src/02-architecture-packages/assets/template-deployment-flow.svg.backup similarity index 100% rename from src/02-templates/assets/template-deployment-flow.svg.backup rename to src/02-architecture-packages/assets/template-deployment-flow.svg.backup diff --git a/src/07-gbapp/autonomous-tasks.md b/src/02-architecture-packages/autonomous-tasks.md similarity index 98% rename from src/07-gbapp/autonomous-tasks.md rename to src/02-architecture-packages/autonomous-tasks.md index 1a4f87fb..5521f785 100644 --- a/src/07-gbapp/autonomous-tasks.md +++ b/src/02-architecture-packages/autonomous-tasks.md @@ -311,5 +311,5 @@ The dev chat uses the same `user_data` system for history storage. - [Autonomous Tasks Chapter](../17-autonomous-tasks/README.md) - Complete guide - [CREATE SITE](../06-gbdialog/keyword-create-site.md) - The keyword behind it -- [REST API](../10-rest/README.md) - API reference -- [HTMX Architecture](../04-gbui/htmx-architecture.md) - Frontend patterns \ No newline at end of file +- [REST API](../08-rest-api-tools/README.md) - API reference +- [HTMX Architecture](../07-user-interface/htmx-architecture.md) - Frontend patterns \ No newline at end of file diff --git a/src/07-gbapp/building.md b/src/02-architecture-packages/building.md similarity index 99% rename from src/07-gbapp/building.md rename to src/02-architecture-packages/building.md index addccc46..a4bdd199 100644 --- a/src/07-gbapp/building.md +++ b/src/02-architecture-packages/building.md @@ -928,4 +928,4 @@ After building: 3. Start botserver and access web interface 4. Create your first bot from templates -See [Chapter 01: Run and Talk](../chapter-01/README.md) for next steps. \ No newline at end of file +See [Chapter 01: Run and Talk](../01-getting-started/README.md) for next steps. \ No newline at end of file diff --git a/src/07-gbapp/cargo-tools.md b/src/02-architecture-packages/cargo-tools.md similarity index 100% rename from src/07-gbapp/cargo-tools.md rename to src/02-architecture-packages/cargo-tools.md diff --git a/src/07-gbapp/containers.md b/src/02-architecture-packages/containers.md similarity index 97% rename from src/07-gbapp/containers.md rename to src/02-architecture-packages/containers.md index 572232e2..4d69f6c5 100644 --- a/src/07-gbapp/containers.md +++ b/src/02-architecture-packages/containers.md @@ -186,6 +186,6 @@ lxc profile device add default lxd-sock proxy \ ## See Also -- [Installation](../chapter-01/installation.md) - Local setup +- [Installation](../01-getting-started/installation.md) - Local setup - [Docker Deployment](./docker-deployment.md) - Docker alternative - [Architecture](./architecture.md) - System design \ No newline at end of file diff --git a/src/07-gbapp/crates.md b/src/02-architecture-packages/crates.md similarity index 100% rename from src/07-gbapp/crates.md rename to src/02-architecture-packages/crates.md diff --git a/src/07-gbapp/custom-keywords.md b/src/02-architecture-packages/custom-keywords.md similarity index 100% rename from src/07-gbapp/custom-keywords.md rename to src/02-architecture-packages/custom-keywords.md diff --git a/src/07-gbapp/dependencies.md b/src/02-architecture-packages/dependencies.md similarity index 100% rename from src/07-gbapp/dependencies.md rename to src/02-architecture-packages/dependencies.md diff --git a/src/07-gbapp/docker-deployment.md b/src/02-architecture-packages/docker-deployment.md similarity index 97% rename from src/07-gbapp/docker-deployment.md rename to src/02-architecture-packages/docker-deployment.md index 12b7ccca..a088cf01 100644 --- a/src/07-gbapp/docker-deployment.md +++ b/src/02-architecture-packages/docker-deployment.md @@ -210,6 +210,6 @@ docker exec gb-minio mc cp --recursive /backup minio/drive/ ## See Also -- [Installation](../chapter-01/installation.md) - Local installation +- [Installation](../01-getting-started/installation.md) - Local installation - [Container Deployment (LXC)](./containers.md) - Linux containers - [Scaling](./scaling.md) - Load balancing and scaling \ No newline at end of file diff --git a/src/07-gbapp/example-gbapp.md b/src/02-architecture-packages/example-gbapp.md similarity index 100% rename from src/07-gbapp/example-gbapp.md rename to src/02-architecture-packages/example-gbapp.md diff --git a/src/02-templates/gbai.md b/src/02-architecture-packages/gbai.md similarity index 95% rename from src/02-templates/gbai.md rename to src/02-architecture-packages/gbai.md index 403de837..dab28a7d 100644 --- a/src/02-templates/gbai.md +++ b/src/02-architecture-packages/gbai.md @@ -17,7 +17,7 @@ That's it. No manifests, no build files, no dependencies. Copy the folder to dep ### Visual Architecture ### Architecture -Package Structure +Package Structure ## How Bootstrap Finds Bots @@ -211,7 +211,7 @@ Each bot: When botserver starts: -Template Deployment Flow +Template Deployment Flow Takes about 5-10 seconds per bot. diff --git a/src/02-templates/gbdialog.md b/src/02-architecture-packages/gbdialog.md similarity index 83% rename from src/02-templates/gbdialog.md rename to src/02-architecture-packages/gbdialog.md index 019d0b88..14757675 100644 --- a/src/02-templates/gbdialog.md +++ b/src/02-architecture-packages/gbdialog.md @@ -1,6 +1,6 @@ # .gbdialog Dialogs -The [`.gbdialog`](../chapter-02/gbdialog.md) package contains BASIC scripts that define conversation flows, tool integrations, and bot behavior. +The [`.gbdialog`](../02-architecture-packages/gbdialog.md) package contains BASIC scripts that define conversation flows, tool integrations, and bot behavior. ## ⚠️ System Limits & Safety @@ -21,7 +21,7 @@ All `.gbdialog` scripts run in a **sandboxed environment** with enforced limits - Excessive API calls return HTTP 429 (Too Many Requests) - File operations are restricted to the bot's `.gbdrive` scope -See [System Limits](../12-auth/system-limits.md) for complete documentation. +See [System Limits](../09-security/system-limits.md) for complete documentation. ## What is .gbdialog? @@ -79,7 +79,7 @@ TALK "Registration complete!" ``` ### 3. Knowledge Base Usage -See [Knowledge Base documentation](../chapter-03/knowledge-base.md) for details. +See [Knowledge Base documentation](../03-knowledge-ai/knowledge-base.md) for details. ```basic ' Activate knowledge base collections USE KB "products" @@ -95,7 +95,7 @@ TALK "What product information can I help you with?" ## Script Structure ### Entry Point: start.bas (Optional) -The `start.bas` file in the [`.gbdialog`](../chapter-02/gbdialog.md) folder is **optional**, but required if you want to activate tools or knowledge bases: +The `start.bas` file in the [`.gbdialog`](../02-architecture-packages/gbdialog.md) folder is **optional**, but required if you want to activate tools or knowledge bases: ```basic ' Optional start script - needed only to activate tools/KB @@ -116,7 +116,7 @@ TALK "Welcome! How can I assist you today?" - For basic Q&A without document search ### Tool Definitions -Create separate `.bas` files for each tool. See [KB and Tools](../chapter-03/kb-and-tools.md) for more information: +Create separate `.bas` files for each tool. See [KB and Tools](../03-knowledge-ai/kb-and-tools.md) for more information: ```basic ' enrollment.bas - The LLM knows when to use this @@ -218,7 +218,7 @@ TALK "What would you like to know about our products?" ## Advanced Features ### Memory Management -See [Storage documentation](../chapter-09/storage.md) for persistent data options. +See [Storage documentation](../08-rest-api-tools.md) for persistent data options. ```basic SET BOT MEMORY "company_policy", policy_text ' Available across all sessions @@ -227,7 +227,7 @@ retrieved = GET BOT MEMORY "company_policy" ``` ### External APIs -See [External APIs chapter](../chapter-08/external-apis.md) for integration patterns. +See [External APIs chapter](../08-rest-api-tools/external-apis.md) for integration patterns. ```basic result = GET "https://api.example.com/data" ' For background processing only @@ -236,7 +236,7 @@ SET BOT MEMORY "api_summary", summary ``` ### Suggestions -See [UI Interface](../chapter-04/ui-interface.md) for UI integration. +See [UI Interface](../07-user-interface/ui-interface.md) for UI integration. ```basic ADD SUGGESTION "Schedule Meeting" AS "schedule" ADD SUGGESTION "View Products" AS "products" @@ -291,13 +291,13 @@ The key is to **trust the system AI** and write less code for more intelligent b ## Important Distinction -- **[LLM Command](../chapter-09/ai-llm.md)**: For background/batch processing, generates content ONCE, stored in BOT MEMORY for all users -- **[Interactive Conversations](../chapter-09/conversation.md)**: Use HEAR/TALK/SET CONTEXT, system AI handles the natural conversation flow +- **[LLM Command](../03-knowledge-ai/ai-llm.md)**: For background/batch processing, generates content ONCE, stored in BOT MEMORY for all users +- **[Interactive Conversations](../03-knowledge-ai/conversation.md)**: Use HEAR/TALK/SET CONTEXT, system AI handles the natural conversation flow ## See Also -- [Chapter 1: Quick Start](../chapter-01/quick-start.md) - Getting started with your first bot -- [Chapter 2: Bot Architecture](../chapter-02/README.md) - Understanding all components -- [Chapter 3: Knowledge Base](../chapter-03/knowledge-base.md) - Working with KB collections -- [Chapter 5: Keywords Reference](../chapter-05/README.md) - Complete BASIC command reference -- [Chapter 9: Conversation Flow](../chapter-09/conversation.md) - Advanced dialog patterns \ No newline at end of file +- [Chapter 1: Quick Start](../01-getting-started/quick-start.md) - Getting started with your first bot +- [Chapter 2: Bot Architecture](../02-architecture-packages/README.md) - Understanding all components +- [Chapter 3: Knowledge Base](../03-knowledge-ai/knowledge-base.md) - Working with KB collections +- [Chapter 5: Keywords Reference](../07-user-interface/README.md) - Complete BASIC command reference +- [Chapter 9: Conversation Flow](../03-knowledge-ai/conversation.md) - Advanced dialog patterns \ No newline at end of file diff --git a/src/02-templates/gbdrive.md b/src/02-architecture-packages/gbdrive.md similarity index 100% rename from src/02-templates/gbdrive.md rename to src/02-architecture-packages/gbdrive.md diff --git a/src/02-templates/gbkb.md b/src/02-architecture-packages/gbkb.md similarity index 85% rename from src/02-templates/gbkb.md rename to src/02-architecture-packages/gbkb.md index df0f882e..24ce756a 100644 --- a/src/02-templates/gbkb.md +++ b/src/02-architecture-packages/gbkb.md @@ -62,6 +62,6 @@ CLEAR KB "policies" ## Learn More -- [Chapter 03: Knowledge Base System](../chapter-03/README.md) - Technical deep-dive on indexing, vectors, and search -- [USE KB Keyword](../chapter-06-gbdialog/keyword-use-kb.md) - Complete keyword reference -- [CLEAR KB Keyword](../chapter-06-gbdialog/keyword-clear-kb.md) - Managing active collections \ No newline at end of file +- [Chapter 03: Knowledge Base System](../03-knowledge-ai/README.md) - Technical deep-dive on indexing, vectors, and search +- [USE KB Keyword](../04-basic-scripting/keyword-use-kb.md) - Complete keyword reference +- [CLEAR KB Keyword](../04-basic-scripting/keyword-clear-kb.md) - Managing active collections \ No newline at end of file diff --git a/src/02-templates/gbot.md b/src/02-architecture-packages/gbot.md similarity index 100% rename from src/02-templates/gbot.md rename to src/02-architecture-packages/gbot.md diff --git a/src/02-templates/gbtheme.md b/src/02-architecture-packages/gbtheme.md similarity index 100% rename from src/02-templates/gbtheme.md rename to src/02-architecture-packages/gbtheme.md diff --git a/src/07-gbapp/infrastructure.md b/src/02-architecture-packages/infrastructure.md similarity index 100% rename from src/07-gbapp/infrastructure.md rename to src/02-architecture-packages/infrastructure.md diff --git a/src/07-gbapp/keyword-refactoring.md b/src/02-architecture-packages/keyword-refactoring.md similarity index 100% rename from src/07-gbapp/keyword-refactoring.md rename to src/02-architecture-packages/keyword-refactoring.md diff --git a/src/02-architecture-packages/kubernetes-deployment.md b/src/02-architecture-packages/kubernetes-deployment.md new file mode 100644 index 00000000..657efb47 --- /dev/null +++ b/src/02-architecture-packages/kubernetes-deployment.md @@ -0,0 +1 @@ +# Kubernetes Deployment diff --git a/src/02-architecture-packages/monitoring-setup.md b/src/02-architecture-packages/monitoring-setup.md new file mode 100644 index 00000000..fdb4605b --- /dev/null +++ b/src/02-architecture-packages/monitoring-setup.md @@ -0,0 +1 @@ +# Monitoring Setup diff --git a/src/07-gbapp/observability.md b/src/02-architecture-packages/observability.md similarity index 100% rename from src/07-gbapp/observability.md rename to src/02-architecture-packages/observability.md diff --git a/src/07-gbapp/philosophy.md b/src/02-architecture-packages/philosophy.md similarity index 100% rename from src/07-gbapp/philosophy.md rename to src/02-architecture-packages/philosophy.md diff --git a/src/07-gbapp/scaling.md b/src/02-architecture-packages/scaling.md similarity index 99% rename from src/07-gbapp/scaling.md rename to src/02-architecture-packages/scaling.md index b1204581..385b51d3 100644 --- a/src/07-gbapp/scaling.md +++ b/src/02-architecture-packages/scaling.md @@ -669,4 +669,4 @@ groups: - [Container Deployment](./containers.md) - LXC container basics - [Architecture Overview](./architecture.md) - System design -- [Monitoring Dashboard](../chapter-04-gbui/monitoring.md) - Observe your cluster \ No newline at end of file +- [Monitoring Dashboard](../07-user-interface/monitoring.md) - Observe your cluster \ No newline at end of file diff --git a/src/07-gbapp/services.md b/src/02-architecture-packages/services.md similarity index 100% rename from src/07-gbapp/services.md rename to src/02-architecture-packages/services.md diff --git a/src/02-templates/summary.md b/src/02-architecture-packages/summary.md similarity index 100% rename from src/02-templates/summary.md rename to src/02-architecture-packages/summary.md diff --git a/src/02-templates/template-analytics.md b/src/02-architecture-packages/template-analytics.md similarity index 99% rename from src/02-templates/template-analytics.md rename to src/02-architecture-packages/template-analytics.md index 147fb747..0c441bb8 100644 --- a/src/02-templates/template-analytics.md +++ b/src/02-architecture-packages/template-analytics.md @@ -428,4 +428,4 @@ POST "https://bi-tool.example.com/webhook", data - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-api-client.md b/src/02-architecture-packages/template-api-client.md similarity index 99% rename from src/02-templates/template-api-client.md rename to src/02-architecture-packages/template-api-client.md index a13ec9e1..8f19597a 100644 --- a/src/02-templates/template-api-client.md +++ b/src/02-architecture-packages/template-api-client.md @@ -463,4 +463,4 @@ api_key = GET ENV "MY_API_KEY" - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-attendance-crm.md b/src/02-architecture-packages/template-attendance-crm.md similarity index 98% rename from src/02-templates/template-attendance-crm.md rename to src/02-architecture-packages/template-attendance-crm.md index 26556dce..bf4b3a33 100644 --- a/src/02-templates/template-attendance-crm.md +++ b/src/02-architecture-packages/template-attendance-crm.md @@ -408,7 +408,7 @@ Set up alerts for: ## See Also -- [Transfer to Human](../chapter-11-features/transfer-to-human.md) - Handoff details -- [LLM-Assisted Attendant](../chapter-11-features/attendant-llm-assist.md) - AI copilot features +- [Transfer to Human](../03-knowledge-ai/transfer-to-human.md) - Handoff details +- [LLM-Assisted Attendant](../03-knowledge-ai/attendant-llm-assist.md) - AI copilot features - [Sales CRM Template](./template-crm.md) - Full CRM without attendance - [Attendance Queue Module](../appendix-external-services/attendance-queue.md) - Queue configuration diff --git a/src/02-templates/template-bi.md b/src/02-architecture-packages/template-bi.md similarity index 98% rename from src/02-templates/template-bi.md rename to src/02-architecture-packages/template-bi.md index 164c6c88..476f4912 100644 --- a/src/02-templates/template-bi.md +++ b/src/02-architecture-packages/template-bi.md @@ -269,4 +269,4 @@ SEND FILE img, "Low Stock Alert" - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-crawler.md b/src/02-architecture-packages/template-crawler.md similarity index 99% rename from src/02-templates/template-crawler.md rename to src/02-architecture-packages/template-crawler.md index e4c5145e..02461dbf 100644 --- a/src/02-templates/template-crawler.md +++ b/src/02-architecture-packages/template-crawler.md @@ -327,4 +327,4 @@ END IF - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbkb Reference](../chapter-03/README.md) - Knowledge base guide \ No newline at end of file +- [gbkb Reference](../03-knowledge-ai/README.md) - Knowledge base guide \ No newline at end of file diff --git a/src/02-templates/template-crm-contacts.md b/src/02-architecture-packages/template-crm-contacts.md similarity index 100% rename from src/02-templates/template-crm-contacts.md rename to src/02-architecture-packages/template-crm-contacts.md diff --git a/src/02-templates/template-crm.md b/src/02-architecture-packages/template-crm.md similarity index 99% rename from src/02-templates/template-crm.md rename to src/02-architecture-packages/template-crm.md index 1daf4935..e7f7eba3 100644 --- a/src/02-templates/template-crm.md +++ b/src/02-architecture-packages/template-crm.md @@ -478,4 +478,4 @@ END IF - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-embedded.md b/src/02-architecture-packages/template-embedded.md similarity index 100% rename from src/02-templates/template-embedded.md rename to src/02-architecture-packages/template-embedded.md diff --git a/src/02-templates/template-law.md b/src/02-architecture-packages/template-law.md similarity index 99% rename from src/02-templates/template-law.md rename to src/02-architecture-packages/template-law.md index 2af66174..bf1cbb1a 100644 --- a/src/02-templates/template-law.md +++ b/src/02-architecture-packages/template-law.md @@ -349,4 +349,4 @@ This template provides AI-assisted document analysis tools. It does not constitu - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbkb Reference](../chapter-03/README.md) - Knowledge base guide \ No newline at end of file +- [gbkb Reference](../03-knowledge-ai/README.md) - Knowledge base guide \ No newline at end of file diff --git a/src/02-templates/template-llm-server.md b/src/02-architecture-packages/template-llm-server.md similarity index 99% rename from src/02-templates/template-llm-server.md rename to src/02-architecture-packages/template-llm-server.md index 9f88a3fd..80a66b9a 100644 --- a/src/02-templates/template-llm-server.md +++ b/src/02-architecture-packages/template-llm-server.md @@ -420,4 +420,4 @@ CMD ["npm", "start"] - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-llm-tools.md b/src/02-architecture-packages/template-llm-tools.md similarity index 99% rename from src/02-templates/template-llm-tools.md rename to src/02-architecture-packages/template-llm-tools.md index 7f62302a..5d1305c1 100644 --- a/src/02-templates/template-llm-tools.md +++ b/src/02-architecture-packages/template-llm-tools.md @@ -447,4 +447,4 @@ Test various phrasings to ensure tool invocation: - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-marketing.md b/src/02-architecture-packages/template-marketing.md similarity index 99% rename from src/02-templates/template-marketing.md rename to src/02-architecture-packages/template-marketing.md index 731d779a..4b236921 100644 --- a/src/02-templates/template-marketing.md +++ b/src/02-architecture-packages/template-marketing.md @@ -443,4 +443,4 @@ TALK "Post scheduled for " + schedule_time + " on " + platform - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-office.md b/src/02-architecture-packages/template-office.md similarity index 99% rename from src/02-templates/template-office.md rename to src/02-architecture-packages/template-office.md index ebec2bcd..f1ff757d 100644 --- a/src/02-templates/template-office.md +++ b/src/02-architecture-packages/template-office.md @@ -391,4 +391,4 @@ END IF - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-reminder.md b/src/02-architecture-packages/template-reminder.md similarity index 99% rename from src/02-templates/template-reminder.md rename to src/02-architecture-packages/template-reminder.md index 60f54457..89d3a850 100644 --- a/src/02-templates/template-reminder.md +++ b/src/02-architecture-packages/template-reminder.md @@ -414,4 +414,4 @@ The LLM understands various date formats: - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/template-samples.md b/src/02-architecture-packages/template-samples.md similarity index 98% rename from src/02-templates/template-samples.md rename to src/02-architecture-packages/template-samples.md index d3ea10ef..86cef297 100644 --- a/src/02-templates/template-samples.md +++ b/src/02-architecture-packages/template-samples.md @@ -695,6 +695,6 @@ If these templates don't fit your needs: ## See Also - [Templates Reference](./templates.md) - Full template list -- [How To: Create Your First Bot](../chapter-04-gbui/how-to/create-first-bot.md) -- [Sources App](../chapter-04-gbui/apps/sources.md) - Managing templates -- [Write Your First Dialog](../chapter-04-gbui/how-to/write-first-dialog.md) \ No newline at end of file +- [How To: Create Your First Bot](../07-user-interface/how-to/create-first-bot.md) +- [Sources App](../07-user-interface/apps/sources.md) - Managing templates +- [Write Your First Dialog](../07-user-interface/how-to/write-first-dialog.md) \ No newline at end of file diff --git a/src/02-templates/template-template.md b/src/02-architecture-packages/template-template.md similarity index 97% rename from src/02-templates/template-template.md rename to src/02-architecture-packages/template-template.md index 01ede8a8..ba4bdfaf 100644 --- a/src/02-templates/template-template.md +++ b/src/02-architecture-packages/template-template.md @@ -330,8 +330,8 @@ Bot: To add a tool, create a .bas file in your .gbdialog folder: - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide -- [Bot Configuration](../chapter-08-config/README.md) - Configuration options +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide +- [Bot Configuration](../10-configuration-deployment/README.md) - Configuration options --- @@ -349,4 +349,4 @@ Bot: To add a tool, create a .bas file in your .gbdialog folder: - [Templates Reference](./templates.md) - Full template list - [Template Samples](./template-samples.md) - Example conversations -- [gbdialog Reference](../chapter-06-gbdialog/README.md) - BASIC scripting guide \ No newline at end of file +- [gbdialog Reference](../04-basic-scripting/README.md) - BASIC scripting guide \ No newline at end of file diff --git a/src/02-templates/templates.md b/src/02-architecture-packages/templates.md similarity index 100% rename from src/02-templates/templates.md rename to src/02-architecture-packages/templates.md diff --git a/src/07-gbapp/testing-safety.md b/src/02-architecture-packages/testing-safety.md similarity index 97% rename from src/07-gbapp/testing-safety.md rename to src/02-architecture-packages/testing-safety.md index 432bb67d..9a64cd73 100644 --- a/src/07-gbapp/testing-safety.md +++ b/src/02-architecture-packages/testing-safety.md @@ -346,6 +346,6 @@ jobs: ## See Also -- [System Limits](../12-auth/system-limits.md) - Rate limiting and resource constraints -- [Security Features](../12-auth/security-features.md) - Security architecture +- [System Limits](../09-security/system-limits.md) - Rate limiting and resource constraints +- [Security Features](../09-security/security-features.md) - Security architecture - [Building from Source](./building.md) - Compilation guide \ No newline at end of file diff --git a/src/02-templates/README.md b/src/02-templates/README.md deleted file mode 100644 index c8758ea6..00000000 --- a/src/02-templates/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# Chapter 02: About Packages - -How bots are organized in General Bots. - -## What You'll Learn - -- Package structure (`.gbai` folders) -- Dialog scripts in BASIC -- Knowledge bases -- Configuration basics -- How packages load - -## Package Structure - -A bot is just a folder ending in `.gbai`: - -``` -my-bot.gbai/ -├── my-bot.gbdialog/ # BASIC scripts -├── my-bot.gbkb/ # Documents -├── my-bot.gbot/ # Configuration -├── my-bot.gbtheme/ # Optional styling -└── my-bot.gbdrive/ # Optional storage -``` - -Drop the folder in `templates/`, it loads automatically. - -## Key Concepts - -### Dialogs (.gbdialog) -- BASIC scripts that control conversation -- `start.bas` is optional (but needed to activate tools/KB with USE TOOL/USE KB) -- Simple commands like TALK and HEAR - -### Knowledge Base (.gbkb) -- Put PDFs and documents in folders -- Automatically becomes searchable -- Bot can answer questions from documents - -### Configuration (.gbot) -- Single `config.csv` file -- Simple name,value pairs -- Missing values use defaults - -### Themes (.gbtheme) -- Optional CSS styling -- Most bots don't need this - -### Storage (.gbdrive) -- Links to S3-compatible storage -- For large files and uploads - -## How It Works - -1. **Discovery**: Finds `.gbai` folders -2. **Loading**: Reads all components -3. **Indexing**: Processes documents -4. **Activation**: Bot is ready - -No build process. No compilation. Just folders and files. - -The web UI uses **HTMX with server-side rendering** - minimal JavaScript, no build process, just HTML templates powered by Rust. - -## Topics Covered - -- [.gbai Architecture](./gbai.md) - Package details -- [.gbdialog Dialogs](./gbdialog.md) - BASIC scripting -- [.gbkb Knowledge Base](./gbkb.md) - Document management -- [.gbot Configuration](./gbot.md) - Settings -- [.gbtheme UI Theming](./gbtheme.md) - Styling -- [.gbdrive File Storage](./gbdrive.md) - Storage integration -- [Bot Templates](./templates.md) - Example bots - ---- - -
- General Bots -
\ No newline at end of file diff --git a/src/11-features/README.md b/src/03-knowledge-ai/README.md similarity index 84% rename from src/11-features/README.md rename to src/03-knowledge-ai/README.md index 4f712007..b62d25c2 100644 --- a/src/11-features/README.md +++ b/src/03-knowledge-ai/README.md @@ -1,6 +1,6 @@ -# Chapter 11: Feature Reference +# Chapter 3: Knowledge & AI -Quick reference for all General Bots capabilities. +Quick reference for all General Bots knowledge and AI capabilities. ## Feature Categories @@ -39,5 +39,5 @@ Quick reference for all General Bots capabilities. ## See Also -- [BASIC Reference](../chapter-06-gbdialog/README.md) - Scripting -- [Configuration](../chapter-08-config/README.md) - Settings \ No newline at end of file +- [BASIC Reference](../04-basic-scripting/README.md) - Scripting +- [Configuration](../10-configuration-deployment/README.md) - Settings \ No newline at end of file diff --git a/src/11-features/ai-llm.md b/src/03-knowledge-ai/ai-llm.md similarity index 100% rename from src/11-features/ai-llm.md rename to src/03-knowledge-ai/ai-llm.md diff --git a/src/03-knowledge-base/assets/caching-architecture.svg.backup b/src/03-knowledge-ai/assets/caching-architecture.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/caching-architecture.svg.backup rename to src/03-knowledge-ai/assets/caching-architecture.svg.backup diff --git a/src/03-knowledge-base/assets/context-window.svg.backup b/src/03-knowledge-ai/assets/context-window.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/context-window.svg.backup rename to src/03-knowledge-ai/assets/context-window.svg.backup diff --git a/src/03-knowledge-base/assets/kb-architecture-pipeline.svg.backup b/src/03-knowledge-ai/assets/kb-architecture-pipeline.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/kb-architecture-pipeline.svg.backup rename to src/03-knowledge-ai/assets/kb-architecture-pipeline.svg.backup diff --git a/src/03-knowledge-base/assets/search-pipeline.svg.backup b/src/03-knowledge-ai/assets/search-pipeline.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/search-pipeline.svg.backup rename to src/03-knowledge-ai/assets/search-pipeline.svg.backup diff --git a/src/03-knowledge-base/assets/storage-breakdown.svg.backup b/src/03-knowledge-ai/assets/storage-breakdown.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/storage-breakdown.svg.backup rename to src/03-knowledge-ai/assets/storage-breakdown.svg.backup diff --git a/src/03-knowledge-base/assets/storage-multiplication.svg.backup b/src/03-knowledge-ai/assets/storage-multiplication.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/storage-multiplication.svg.backup rename to src/03-knowledge-ai/assets/storage-multiplication.svg.backup diff --git a/src/03-knowledge-base/assets/technical-specs.svg.backup b/src/03-knowledge-ai/assets/technical-specs.svg.backup similarity index 100% rename from src/03-knowledge-base/assets/technical-specs.svg.backup rename to src/03-knowledge-ai/assets/technical-specs.svg.backup diff --git a/src/11-features/attendant-llm-assist.md b/src/03-knowledge-ai/attendant-llm-assist.md similarity index 98% rename from src/11-features/attendant-llm-assist.md rename to src/03-knowledge-ai/attendant-llm-assist.md index ef8d094a..649c7a24 100644 --- a/src/11-features/attendant-llm-assist.md +++ b/src/03-knowledge-ai/attendant-llm-assist.md @@ -493,5 +493,5 @@ If suggestions seem generic: - [Transfer to Human](./transfer-to-human.md) - Bot-to-human handoff - [Attendance Queue](../appendix-external-services/attendance-queue.md) - Queue configuration -- [LLM Configuration](../chapter-08-config/llm-config.md) - LLM setup -- [config.csv Format](../chapter-08-config/config-csv.md) - Configuration reference \ No newline at end of file +- [LLM Configuration](../10-configuration-deployment/llm-config.md) - LLM setup +- [config.csv Format](../10-configuration-deployment/config-csv.md) - Configuration reference \ No newline at end of file diff --git a/src/11-features/automation.md b/src/03-knowledge-ai/automation.md similarity index 100% rename from src/11-features/automation.md rename to src/03-knowledge-ai/automation.md diff --git a/src/03-knowledge-base/caching.md b/src/03-knowledge-ai/caching.md similarity index 97% rename from src/03-knowledge-base/caching.md rename to src/03-knowledge-ai/caching.md index 4b48adec..25c74240 100644 --- a/src/03-knowledge-base/caching.md +++ b/src/03-knowledge-ai/caching.md @@ -2,7 +2,7 @@ botserver includes automatic caching to improve response times and reduce redundant processing, including semantic caching for LLM responses using an in-memory cache component. -Caching Architecture +Caching Architecture ## Features diff --git a/src/11-features/channel-setup.md b/src/03-knowledge-ai/channel-setup.md similarity index 99% rename from src/11-features/channel-setup.md rename to src/03-knowledge-ai/channel-setup.md index 26654667..54720bd1 100644 --- a/src/11-features/channel-setup.md +++ b/src/03-knowledge-ai/channel-setup.md @@ -665,4 +665,4 @@ CHANNEL_LOG_LEVEL=debug - [POST TO Keyword](../06-gbdialog/keyword-post-to.md) - Posting from BASIC - [Social Media Keywords](../06-gbdialog/keywords-social-media.md) - Full social media reference - [Multi-Channel Architecture](./channels.md) - System design -- [Accounts Settings](../08-config/accounts.md) - UI configuration \ No newline at end of file +- [Accounts Settings](../10-configuration-deployment/accounts.md) - UI configuration \ No newline at end of file diff --git a/src/11-features/channels.md b/src/03-knowledge-ai/channels.md similarity index 100% rename from src/11-features/channels.md rename to src/03-knowledge-ai/channels.md diff --git a/src/11-features/conversation.md b/src/03-knowledge-ai/conversation.md similarity index 100% rename from src/11-features/conversation.md rename to src/03-knowledge-ai/conversation.md diff --git a/src/11-features/core-features.md b/src/03-knowledge-ai/core-features.md similarity index 100% rename from src/11-features/core-features.md rename to src/03-knowledge-ai/core-features.md diff --git a/src/11-features/drive-monitor.md b/src/03-knowledge-ai/drive-monitor.md similarity index 100% rename from src/11-features/drive-monitor.md rename to src/03-knowledge-ai/drive-monitor.md diff --git a/src/11-features/editions.md b/src/03-knowledge-ai/editions.md similarity index 96% rename from src/11-features/editions.md rename to src/03-knowledge-ai/editions.md index 3f2185e2..6c0155e3 100644 --- a/src/11-features/editions.md +++ b/src/03-knowledge-ai/editions.md @@ -369,7 +369,7 @@ cargo build --release --features full ## See Also -- [Cargo.toml Feature Definitions](../chapter-07-gbapp/dependencies.md) -- [Installation Guide](../chapter-01/installation.md) -- [Architecture Overview](../chapter-07-gbapp/architecture.md) -- [Compliance Requirements](../chapter-12-auth/compliance-requirements.md) \ No newline at end of file +- [Cargo.toml Feature Definitions](../02-architecture-packages/dependencies.md) +- [Installation Guide](../01-getting-started/installation.md) +- [Architecture Overview](../02-architecture-packages/architecture.md) +- [Compliance Requirements](../09-security/compliance-requirements.md) \ No newline at end of file diff --git a/src/11-features/email.md b/src/03-knowledge-ai/email.md similarity index 100% rename from src/11-features/email.md rename to src/03-knowledge-ai/email.md diff --git a/src/03-knowledge-base/episodic-memory.md b/src/03-knowledge-ai/episodic-memory.md similarity index 97% rename from src/03-knowledge-base/episodic-memory.md rename to src/03-knowledge-ai/episodic-memory.md index f27d7f93..ac35ee5a 100644 --- a/src/03-knowledge-base/episodic-memory.md +++ b/src/03-knowledge-ai/episodic-memory.md @@ -183,5 +183,5 @@ Both features reduce costs and improve performance independently. ## See Also - [Semantic Caching](./caching.md) - Response caching system -- [Configuration Parameters](../chapter-08-config/parameters.md) - Full parameter reference -- [LLM Configuration](../chapter-08-config/llm-config.md) - Model settings \ No newline at end of file +- [Configuration Parameters](../10-configuration-deployment/parameters.md) - Full parameter reference +- [LLM Configuration](../10-configuration-deployment/llm-config.md) - Model settings \ No newline at end of file diff --git a/src/11-features/feature-map.md b/src/03-knowledge-ai/feature-map.md similarity index 99% rename from src/11-features/feature-map.md rename to src/03-knowledge-ai/feature-map.md index 165e4027..2eb89b23 100644 --- a/src/11-features/feature-map.md +++ b/src/03-knowledge-ai/feature-map.md @@ -340,4 +340,4 @@ if COMPILED_FEATURES.contains(&"mail") { - [Building from Source](../07-gbapp/building.md) - [Cargo Tools Reference](../07-gbapp/cargo-tools.md) -- [White Label Configuration](../22-white-label/README.md) +- [White Label Configuration](../12-ecosystem-reference/README.md) diff --git a/src/11-features/hybrid-search.md b/src/03-knowledge-ai/hybrid-search.md similarity index 92% rename from src/11-features/hybrid-search.md rename to src/03-knowledge-ai/hybrid-search.md index 08a5a2cd..0364ea33 100644 --- a/src/11-features/hybrid-search.md +++ b/src/03-knowledge-ai/hybrid-search.md @@ -115,6 +115,6 @@ rag-cache-max-size,10000 ## See Also -- [Semantic Search](../chapter-03/semantic-search.md) - Dense search details -- [Document Indexing](../chapter-03/indexing.md) - How documents are processed +- [Semantic Search](../03-knowledge-ai/semantic-search.md) - Dense search details +- [Document Indexing](../03-knowledge-ai/indexing.md) - How documents are processed - [Knowledge Base](./knowledge-base.md) - KB overview \ No newline at end of file diff --git a/src/03-knowledge-base/indexing.md b/src/03-knowledge-ai/indexing.md similarity index 100% rename from src/03-knowledge-base/indexing.md rename to src/03-knowledge-ai/indexing.md diff --git a/src/03-knowledge-base/kb-and-tools.md b/src/03-knowledge-ai/kb-and-tools.md similarity index 100% rename from src/03-knowledge-base/kb-and-tools.md rename to src/03-knowledge-ai/kb-and-tools.md diff --git a/src/11-features/knowledge-base.md b/src/03-knowledge-ai/knowledge-base.md similarity index 80% rename from src/11-features/knowledge-base.md rename to src/03-knowledge-ai/knowledge-base.md index c327c6e8..88e6990c 100644 --- a/src/11-features/knowledge-base.md +++ b/src/03-knowledge-ai/knowledge-base.md @@ -59,9 +59,9 @@ rag-top-k,10 ## Learn More -- **[KB System Architecture](../chapter-03/README.md)** - Technical deep dive -- **[Semantic Search](../chapter-03/semantic-search.md)** - How search works -- **[Document Indexing](../chapter-03/indexing.md)** - Processing pipeline +- **[KB System Architecture](../03-knowledge-ai/README.md)** - Technical deep dive +- **[Semantic Search](../03-knowledge-ai/semantic-search.md)** - How search works +- **[Document Indexing](../03-knowledge-ai/indexing.md)** - Processing pipeline - **[Hybrid Search](./hybrid-search.md)** - RAG 2.0 configuration -- **[USE KB Keyword](../chapter-06-gbdialog/keyword-use-kb.md)** - Complete reference -- **[.gbkb Package](../chapter-02/gbkb.md)** - Folder structure \ No newline at end of file +- **[USE KB Keyword](../04-basic-scripting/keyword-use-kb.md)** - Complete reference +- **[.gbkb Package](../02-architecture-packages/gbkb.md)** - Folder structure \ No newline at end of file diff --git a/src/11-features/m365-comparison.md b/src/03-knowledge-ai/m365-comparison.md similarity index 97% rename from src/11-features/m365-comparison.md rename to src/03-knowledge-ai/m365-comparison.md index efecea17..629ac296 100644 --- a/src/11-features/m365-comparison.md +++ b/src/03-knowledge-ai/m365-comparison.md @@ -288,7 +288,7 @@ The choice between cloud and self-hosted depends on organizational priorities. F ## See Also -- [Quick Start](../chapter-01/quick-start.md) - Deploy in minutes -- [Keywords Reference](../chapter-06-gbdialog/keywords.md) - Full BASIC reference -- [REST API Reference](../chapter-10-rest/README.md) - Complete API documentation -- [Migration Guide](../chapter-14-migration/README.md) - Detailed migration steps \ No newline at end of file +- [Quick Start](../01-getting-started/quick-start.md) - Deploy in minutes +- [Keywords Reference](../04-basic-scripting/keywords.md) - Full BASIC reference +- [REST API Reference](../08-rest-api-tools/README.md) - Complete API documentation +- [Migration Guide](../12-ecosystem-reference/README.md) - Detailed migration steps \ No newline at end of file diff --git a/src/11-features/memory-management.md b/src/03-knowledge-ai/memory-management.md similarity index 96% rename from src/11-features/memory-management.md rename to src/03-knowledge-ai/memory-management.md index efe9b83d..d10207a2 100644 --- a/src/11-features/memory-management.md +++ b/src/03-knowledge-ai/memory-management.md @@ -450,8 +450,8 @@ END IF ## See Also -- [SET USER MEMORY](../chapter-06-gbdialog/keyword-set-user-memory.md) - Store user memory -- [GET USER MEMORY](../chapter-06-gbdialog/keyword-get-user-memory.md) - Retrieve user memory -- [SET BOT MEMORY](../chapter-06-gbdialog/keyword-set-bot-memory.md) - Store bot memory -- [GET BOT MEMORY](../chapter-06-gbdialog/keyword-get-bot-memory.md) - Retrieve bot memory +- [SET USER MEMORY](../04-basic-scripting/keyword-set-user-memory.md) - Store user memory +- [GET USER MEMORY](../04-basic-scripting/keyword-get-user-memory.md) - Retrieve user memory +- [SET BOT MEMORY](../04-basic-scripting/keyword-set-bot-memory.md) - Store bot memory +- [GET BOT MEMORY](../04-basic-scripting/keyword-get-bot-memory.md) - Retrieve bot memory - [Multi-Agent Orchestration](./multi-agent-orchestration.md) - Cross-bot data sharing \ No newline at end of file diff --git a/src/11-features/multi-agent-design.md b/src/03-knowledge-ai/multi-agent-design.md similarity index 100% rename from src/11-features/multi-agent-design.md rename to src/03-knowledge-ai/multi-agent-design.md diff --git a/src/11-features/multi-agent-orchestration.md b/src/03-knowledge-ai/multi-agent-orchestration.md similarity index 98% rename from src/11-features/multi-agent-orchestration.md rename to src/03-knowledge-ai/multi-agent-orchestration.md index d9764e9c..6c0523a6 100644 --- a/src/11-features/multi-agent-orchestration.md +++ b/src/03-knowledge-ai/multi-agent-orchestration.md @@ -553,9 +553,9 @@ END IF ## See Also -- [ADD BOT Keyword](../chapter-06-gbdialog/keyword-add-bot.md) -- [DELEGATE TO BOT Keyword](../chapter-06-gbdialog/keyword-delegate-to-bot.md) +- [ADD BOT Keyword](../04-basic-scripting/keyword-add-bot.md) +- [DELEGATE TO BOT Keyword](../04-basic-scripting/keyword-delegate-to-bot.md) - [Memory Management](./memory-management.md) -- [Model Routing](../chapter-08-config/llm-config.md) -- [Code Sandbox](../chapter-07-gbapp/containers.md) +- [Model Routing](../10-configuration-deployment/llm-config.md) +- [Code Sandbox](../02-architecture-packages/containers.md) - [SSE Streaming](./streaming.md) \ No newline at end of file diff --git a/src/11-features/platform-comparison.md b/src/03-knowledge-ai/platform-comparison.md similarity index 95% rename from src/11-features/platform-comparison.md rename to src/03-knowledge-ai/platform-comparison.md index ebc30ede..b9c3999e 100644 --- a/src/11-features/platform-comparison.md +++ b/src/03-knowledge-ai/platform-comparison.md @@ -169,7 +169,7 @@ For organizations that need more than a simple chatbot—those requiring custom ## See Also -- [Quick Start](../chapter-01/quick-start.md) - Get running in minutes -- [Keywords Reference](../chapter-06-gbdialog/keywords.md) - Full BASIC reference -- [REST API](../chapter-10-rest/README.md) - API documentation +- [Quick Start](../01-getting-started/quick-start.md) - Get running in minutes +- [Keywords Reference](../04-basic-scripting/keywords.md) - Full BASIC reference +- [REST API](../08-rest-api-tools/README.md) - API documentation - [Projects](./projects.md) - Team collaboration features \ No newline at end of file diff --git a/src/11-features/project-app.md b/src/03-knowledge-ai/project-app.md similarity index 100% rename from src/11-features/project-app.md rename to src/03-knowledge-ai/project-app.md diff --git a/src/11-features/projects.md b/src/03-knowledge-ai/projects.md similarity index 96% rename from src/11-features/projects.md rename to src/03-knowledge-ai/projects.md index 7770b6e5..d78bde83 100644 --- a/src/11-features/projects.md +++ b/src/03-knowledge-ai/projects.md @@ -342,7 +342,7 @@ CREATE TASK "Design review" IN PROJECT project_id ## See Also -- [Tasks API](../chapter-10-rest/tasks-api.md) - Task management endpoints -- [Conversations API](../chapter-10-rest/conversations-api.md) - Chat history -- [Groups API](../chapter-10-rest/groups-api.md) - User group management -- [SET CONTEXT](../chapter-06-gbdialog/keyword-set-context.md) - AI context configuration \ No newline at end of file +- [Tasks API](../08-rest-api-tools/tasks-api.md) - Task management endpoints +- [Conversations API](../08-rest-api-tools/conversations-api.md) - Chat history +- [Groups API](../08-rest-api-tools/groups-api.md) - User group management +- [SET CONTEXT](../04-basic-scripting/keyword-set-context.md) - AI context configuration \ No newline at end of file diff --git a/src/03-knowledge-base/semantic-search.md b/src/03-knowledge-ai/semantic-search.md similarity index 90% rename from src/03-knowledge-base/semantic-search.md rename to src/03-knowledge-ai/semantic-search.md index 5844ea1f..cfebf83e 100644 --- a/src/03-knowledge-base/semantic-search.md +++ b/src/03-knowledge-ai/semantic-search.md @@ -2,7 +2,7 @@ Semantic search finds relevant content by meaning, not just keywords. When a user asks "How many days off do I get?", the system matches documents about "vacation policy" or "PTO allowance" even though the words differ. -Search Pipeline +Search Pipeline ## How It Works @@ -93,7 +93,7 @@ episodic-memory-threshold,4 # When to compress older context ## See Also -- [Hybrid Search](../chapter-11-features/hybrid-search.md) - Combining semantic + keyword search +- [Hybrid Search](../03-knowledge-ai/hybrid-search.md) - Combining semantic + keyword search - [Document Indexing](./indexing.md) - How documents are processed - [Vector Collections](./vector-collections.md) - Technical vector DB details -- [USE KB](../chapter-06-gbdialog/keyword-use-kb.md) - Keyword reference \ No newline at end of file +- [USE KB](../04-basic-scripting/keyword-use-kb.md) - Keyword reference \ No newline at end of file diff --git a/src/11-features/storage.md b/src/03-knowledge-ai/storage.md similarity index 100% rename from src/11-features/storage.md rename to src/03-knowledge-ai/storage.md diff --git a/src/03-knowledge-base/summary.md b/src/03-knowledge-ai/summary.md similarity index 91% rename from src/03-knowledge-base/summary.md rename to src/03-knowledge-ai/summary.md index ace1b852..2f630a72 100644 --- a/src/03-knowledge-base/summary.md +++ b/src/03-knowledge-ai/summary.md @@ -52,6 +52,6 @@ This chapter explains how botserver manages knowledge base collections, indexing ## See Also -- [.gbkb Package](../chapter-02/gbkb.md) - Folder structure for knowledge bases -- [LLM Configuration](../chapter-08-config/llm-config.md) - Model and provider settings -- [Hybrid Search](../chapter-11-features/hybrid-search.md) - Advanced RAG techniques \ No newline at end of file +- [.gbkb Package](../02-architecture-packages/gbkb.md) - Folder structure for knowledge bases +- [LLM Configuration](../10-configuration-deployment/llm-config.md) - Model and provider settings +- [Hybrid Search](../03-knowledge-ai/hybrid-search.md) - Advanced RAG techniques \ No newline at end of file diff --git a/src/11-features/transfer-to-human.md b/src/03-knowledge-ai/transfer-to-human.md similarity index 98% rename from src/11-features/transfer-to-human.md rename to src/03-knowledge-ai/transfer-to-human.md index 1b542a72..28498b6f 100644 --- a/src/11-features/transfer-to-human.md +++ b/src/03-knowledge-ai/transfer-to-human.md @@ -629,6 +629,6 @@ POST /api/attendance/resolve/{session_id} - [LLM-Assisted Attendant](./attendant-llm-assist.md) - AI copilot features - [Attendance Queue Module](../appendix-external-services/attendance-queue.md) - Full queue configuration -- [Human Approval](../chapter-06-gbdialog/keyword-human-approval.md) - Approval workflows +- [Human Approval](../04-basic-scripting/keyword-human-approval.md) - Approval workflows - [CRM Automations](../appendix-external-services/attendance-queue.md#crm-automations) - Sales, collections, scheduling -- [WhatsApp Setup](../chapter-04-gbui/how-to/connect-whatsapp.md) - Channel configuration \ No newline at end of file +- [WhatsApp Setup](../07-user-interface/how-to/connect-whatsapp.md) - Channel configuration \ No newline at end of file diff --git a/src/03-knowledge-base/vector-collections.md b/src/03-knowledge-ai/vector-collections.md similarity index 98% rename from src/03-knowledge-base/vector-collections.md rename to src/03-knowledge-ai/vector-collections.md index 19873b9d..dad7fc06 100644 --- a/src/03-knowledge-base/vector-collections.md +++ b/src/03-knowledge-ai/vector-collections.md @@ -2,7 +2,7 @@ This chapter explains how botserver organizes knowledge into vector collections, the searchable units that power semantic retrieval. Understanding how collections work helps you structure documents effectively and optimize the knowledge your bots can access. -Storage Breakdown +Storage Breakdown ## From Folders to Collections diff --git a/src/11-features/whats-new.md b/src/03-knowledge-ai/whats-new.md similarity index 92% rename from src/11-features/whats-new.md rename to src/03-knowledge-ai/whats-new.md index 4c675150..95762f68 100644 --- a/src/11-features/whats-new.md +++ b/src/03-knowledge-ai/whats-new.md @@ -21,4 +21,4 @@ Please see: **[Multi-Agent Orchestration](./multi-agent-orchestration.md)** - [Multi-Agent Orchestration](./multi-agent-orchestration.md) - Complete guide to multi-agent systems - [Memory Management](./memory-management.md) - User and bot memory systems - [Hybrid RAG Search](./hybrid-search.md) - Search configuration and tuning -- [Keywords Reference](../chapter-06-gbdialog/keywords.md) - All BASIC keywords \ No newline at end of file +- [Keywords Reference](../04-basic-scripting/keywords.md) - All BASIC keywords \ No newline at end of file diff --git a/src/11-features/whiteboard.md b/src/03-knowledge-ai/whiteboard.md similarity index 100% rename from src/11-features/whiteboard.md rename to src/03-knowledge-ai/whiteboard.md diff --git a/src/03-knowledge-base/README.md b/src/03-knowledge-base/README.md deleted file mode 100644 index 07560401..00000000 --- a/src/03-knowledge-base/README.md +++ /dev/null @@ -1,80 +0,0 @@ -# Chapter 03: Knowledge Base System - -Vector search and semantic retrieval for intelligent document querying. - -## Overview - -The Knowledge Base (gbkb) transforms documents into searchable semantic representations, enabling natural language queries against your organization's content. - -## Architecture - -KB Architecture Pipeline - -The pipeline processes documents through extraction, chunking, embedding, and storage to enable semantic search. - -## Supported Formats - -| Format | Features | -|--------|----------| -| PDF | Text, OCR, tables | -| DOCX | Formatted text, styles | -| HTML | DOM parsing | -| Markdown | GFM, tables, code | -| CSV/JSON | Structured data | -| TXT | Plain text | - -## Quick Start - -```basic -' Activate knowledge base -USE KB "company-docs" - -' Bot now answers from your documents -TALK "How can I help you?" -``` - -## Key Concepts - -### Document Processing -1. **Extract** - Pull text from files -2. **Chunk** - Split into ~500 token segments -3. **Embed** - Generate vectors (BGE model) -4. **Store** - Save to Qdrant - -### Semantic Search -- Query converted to vector embedding -- Cosine similarity finds relevant chunks -- Top results injected into LLM context -- No explicit search code needed - -### Storage Requirements - -Vector databases need ~3.5x original document size: -- Embeddings: ~2x -- Indexes: ~1x -- Metadata: ~0.5x - -## Configuration - -```csv -name,value -embedding-url,http://localhost:8082 -embedding-model,bge-small-en-v1.5 -rag-hybrid-enabled,true -rag-top-k,10 -``` - -## Chapter Contents - -- [KB and Tools System](./kb-and-tools.md) - Integration patterns -- [Vector Collections](./vector-collections.md) - Collection management -- [Document Indexing](./indexing.md) - Processing pipeline -- [Semantic Search](./semantic-search.md) - Search mechanics -- [Episodic Memory](./episodic-memory.md) - Conversation history and context management -- [Semantic Caching](./caching.md) - Performance optimization - -## See Also - -- [.gbkb Package](../chapter-02/gbkb.md) - Folder structure -- [USE KB Keyword](../chapter-06-gbdialog/keyword-use-kb.md) - Keyword reference -- [Hybrid Search](../chapter-11-features/hybrid-search.md) - RAG 2.0 \ No newline at end of file diff --git a/src/06-gbdialog/README.md b/src/04-basic-scripting/README.md similarity index 97% rename from src/06-gbdialog/README.md rename to src/04-basic-scripting/README.md index 001375ba..9ff51a31 100644 --- a/src/06-gbdialog/README.md +++ b/src/04-basic-scripting/README.md @@ -1,4 +1,4 @@ -# Chapter 06: BASIC + LLM - The Perfect Match +# Chapter 4: BASIC Scripting ## Why BASIC? diff --git a/src/06-gbdialog/api-possibilities.md b/src/04-basic-scripting/api-possibilities.md similarity index 98% rename from src/06-gbdialog/api-possibilities.md rename to src/04-basic-scripting/api-possibilities.md index 229fa338..9eec2747 100644 --- a/src/06-gbdialog/api-possibilities.md +++ b/src/04-basic-scripting/api-possibilities.md @@ -253,4 +253,4 @@ Your bot's LLM automatically learns when to use each tool based on what users as - [Keywords Reference](./keywords.md) - BASIC commands for API calls - [HTTP Operations](./keywords-http.md) - GET, POST, PUT, PATCH, DELETE -- [Tools and Integration](../09-tools/README.md) - Building custom tools \ No newline at end of file +- [Tools and Integration](../08-rest-api-tools/README.md) - Building custom tools \ No newline at end of file diff --git a/src/06-gbdialog/assets/basic-execution-flow.svg.backup b/src/04-basic-scripting/assets/basic-execution-flow.svg.backup similarity index 100% rename from src/06-gbdialog/assets/basic-execution-flow.svg.backup rename to src/04-basic-scripting/assets/basic-execution-flow.svg.backup diff --git a/src/06-gbdialog/basic-vs-automation-tools.md b/src/04-basic-scripting/basic-vs-automation-tools.md similarity index 100% rename from src/06-gbdialog/basic-vs-automation-tools.md rename to src/04-basic-scripting/basic-vs-automation-tools.md diff --git a/src/06-gbdialog/basics.md b/src/04-basic-scripting/basics.md similarity index 100% rename from src/06-gbdialog/basics.md rename to src/04-basic-scripting/basics.md diff --git a/src/06-gbdialog/examples-consolidated.md b/src/04-basic-scripting/examples-consolidated.md similarity index 97% rename from src/06-gbdialog/examples-consolidated.md rename to src/04-basic-scripting/examples-consolidated.md index 58976103..e4fd72be 100644 --- a/src/06-gbdialog/examples-consolidated.md +++ b/src/04-basic-scripting/examples-consolidated.md @@ -8,7 +8,7 @@ This document provides complete, production-ready examples demonstrating webhook Complete order processing with inventory, payments, and notifications via webhook. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L1-80 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L1-80 ' order-system.bas ' E-commerce order management webhook @@ -95,7 +95,7 @@ result_payment_id = payment_result.id Complete employee onboarding workflow triggered by webhook. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L82-150 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L82-150 ' onboarding.bas ' HR onboarding automation webhook @@ -161,7 +161,7 @@ result_tasks_created = 9 Automated daily report job with AI-generated insights. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L152-230 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L152-230 ' daily-report.bas ' Automated daily business intelligence report @@ -221,7 +221,7 @@ PRINT "Daily report generated and distributed for " + today Automated document intake, processing, and classification via webhook. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L232-330 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L232-330 ' document-pipeline.bas ' Automated document processing and classification @@ -292,7 +292,7 @@ result_category = category Bidirectional sync between systems via webhook. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L332-420 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L332-420 ' data-sync.bas ' Real-time data synchronization between CRM and ERP @@ -369,7 +369,7 @@ result_erp_status = erp_result.status Automated lead follow-up and nurturing campaign. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L422-490 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L422-490 ' lead-nurturing.bas ' Scheduled lead nurturing campaign @@ -423,7 +423,7 @@ PRINT "Lead nurturing completed: " + UBOUND(cold_leads_3_days) + " at stage 1, " Automated payment reminders and collection workflow. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L492-560 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L492-560 ' payment-collection.bas ' Scheduled payment collection reminders @@ -488,7 +488,7 @@ PRINT "Payment reminders sent: " + UBOUND(due_today) + " due today, " + UBOUND(o Handle appointment bookings from external calendar systems. -```botbook/src/chapter-06-gbdialog/examples-consolidated.bas#L562-620 +```botbook/src/04-basic-scripting/examples-consolidated.bas#L562-620 ' appointment-webhook.bas ' Handle appointment scheduling from external systems diff --git a/src/06-gbdialog/keyword-add-bot.md b/src/04-basic-scripting/keyword-add-bot.md similarity index 100% rename from src/06-gbdialog/keyword-add-bot.md rename to src/04-basic-scripting/keyword-add-bot.md diff --git a/src/06-gbdialog/keyword-add-member.md b/src/04-basic-scripting/keyword-add-member.md similarity index 95% rename from src/06-gbdialog/keyword-add-member.md rename to src/04-basic-scripting/keyword-add-member.md index 197a903d..43536938 100644 --- a/src/06-gbdialog/keyword-add-member.md +++ b/src/04-basic-scripting/keyword-add-member.md @@ -65,4 +65,4 @@ NEXT ## See Also - [ADD BOT](./keyword-add-bot.md) -- [User Session Handling](../chapter-10-features/user-sessions.md) \ No newline at end of file +- [User Session Handling](../03-knowledge-ai/user-sessions.md) \ No newline at end of file diff --git a/src/06-gbdialog/keyword-add-suggestion.md b/src/04-basic-scripting/keyword-add-suggestion.md similarity index 100% rename from src/06-gbdialog/keyword-add-suggestion.md rename to src/04-basic-scripting/keyword-add-suggestion.md diff --git a/src/06-gbdialog/keyword-aggregate.md b/src/04-basic-scripting/keyword-aggregate.md similarity index 100% rename from src/06-gbdialog/keyword-aggregate.md rename to src/04-basic-scripting/keyword-aggregate.md diff --git a/src/06-gbdialog/keyword-book.md b/src/04-basic-scripting/keyword-book.md similarity index 100% rename from src/06-gbdialog/keyword-book.md rename to src/04-basic-scripting/keyword-book.md diff --git a/src/06-gbdialog/keyword-bot-reflection.md b/src/04-basic-scripting/keyword-bot-reflection.md similarity index 96% rename from src/06-gbdialog/keyword-bot-reflection.md rename to src/04-basic-scripting/keyword-bot-reflection.md index e3b1be95..284deff0 100644 --- a/src/06-gbdialog/keyword-bot-reflection.md +++ b/src/04-basic-scripting/keyword-bot-reflection.md @@ -235,6 +235,6 @@ reflection-store-insights,true ## See Also -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Multi-agent systems -- [Observability](../chapter-11-features/observability.md) - Monitoring and metrics -- [LLM Configuration](../chapter-08-config/llm-config.md) - Model setup \ No newline at end of file +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Multi-agent systems +- [Observability](../03-knowledge-ai/observability.md) - Monitoring and metrics +- [LLM Configuration](../10-configuration-deployment/llm-config.md) - Model setup \ No newline at end of file diff --git a/src/06-gbdialog/keyword-card.md b/src/04-basic-scripting/keyword-card.md similarity index 100% rename from src/06-gbdialog/keyword-card.md rename to src/04-basic-scripting/keyword-card.md diff --git a/src/06-gbdialog/keyword-clear-kb.md b/src/04-basic-scripting/keyword-clear-kb.md similarity index 95% rename from src/06-gbdialog/keyword-clear-kb.md rename to src/04-basic-scripting/keyword-clear-kb.md index 10d98af3..d9143282 100644 --- a/src/06-gbdialog/keyword-clear-kb.md +++ b/src/04-basic-scripting/keyword-clear-kb.md @@ -80,4 +80,4 @@ Returns `true` if cleared successfully, `false` if KB wasn't loaded. ## See Also - [USE KB](./keyword-use-kb.md) - Load knowledge bases -- [Knowledge Base System](../chapter-03/README.md) - Technical details \ No newline at end of file +- [Knowledge Base System](../03-knowledge-ai/README.md) - Technical details \ No newline at end of file diff --git a/src/06-gbdialog/keyword-clear-tools.md b/src/04-basic-scripting/keyword-clear-tools.md similarity index 100% rename from src/06-gbdialog/keyword-clear-tools.md rename to src/04-basic-scripting/keyword-clear-tools.md diff --git a/src/06-gbdialog/keyword-compress.md b/src/04-basic-scripting/keyword-compress.md similarity index 100% rename from src/06-gbdialog/keyword-compress.md rename to src/04-basic-scripting/keyword-compress.md diff --git a/src/06-gbdialog/keyword-copy.md b/src/04-basic-scripting/keyword-copy.md similarity index 100% rename from src/06-gbdialog/keyword-copy.md rename to src/04-basic-scripting/keyword-copy.md diff --git a/src/06-gbdialog/keyword-create-draft.md b/src/04-basic-scripting/keyword-create-draft.md similarity index 100% rename from src/06-gbdialog/keyword-create-draft.md rename to src/04-basic-scripting/keyword-create-draft.md diff --git a/src/06-gbdialog/keyword-create-site.md b/src/04-basic-scripting/keyword-create-site.md similarity index 98% rename from src/06-gbdialog/keyword-create-site.md rename to src/04-basic-scripting/keyword-create-site.md index 372768c3..66dd9231 100644 --- a/src/06-gbdialog/keyword-create-site.md +++ b/src/04-basic-scripting/keyword-create-site.md @@ -428,6 +428,6 @@ CREATE SITE "test-crm", "bottemplates/apps/crud", "..." ## See Also - [Autonomous Task AI](../07-gbapp/autonomous-tasks.md) - How the machine does the work -- [HTMX Architecture](../04-gbui/htmx-architecture.md) - UI patterns +- [HTMX Architecture](../07-user-interface/htmx-architecture.md) - UI patterns - [.gbdrive Storage](../02-templates/gbdrive.md) - File management -- [API Reference](../10-rest/README.md) - botserver endpoints \ No newline at end of file +- [API Reference](../08-rest-api-tools/README.md) - botserver endpoints \ No newline at end of file diff --git a/src/06-gbdialog/keyword-create-task.md b/src/04-basic-scripting/keyword-create-task.md similarity index 100% rename from src/06-gbdialog/keyword-create-task.md rename to src/04-basic-scripting/keyword-create-task.md diff --git a/src/06-gbdialog/keyword-delegate-to-bot.md b/src/04-basic-scripting/keyword-delegate-to-bot.md similarity index 95% rename from src/06-gbdialog/keyword-delegate-to-bot.md rename to src/04-basic-scripting/keyword-delegate-to-bot.md index b33a2bd4..7b389cde 100644 --- a/src/06-gbdialog/keyword-delegate-to-bot.md +++ b/src/04-basic-scripting/keyword-delegate-to-bot.md @@ -214,6 +214,6 @@ a2a-retry-count,3 ## See Also -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Complete multi-agent guide -- [A2A Protocol](../chapter-11-features/a2a-protocol.md) - Technical protocol details -- [Bot Configuration](../chapter-08-config/parameters.md) - Bot setup \ No newline at end of file +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Complete multi-agent guide +- [A2A Protocol](../03-knowledge-ai/a2a-protocol.md) - Technical protocol details +- [Bot Configuration](../10-configuration-deployment/parameters.md) - Bot setup \ No newline at end of file diff --git a/src/06-gbdialog/keyword-delete-file.md b/src/04-basic-scripting/keyword-delete-file.md similarity index 100% rename from src/06-gbdialog/keyword-delete-file.md rename to src/04-basic-scripting/keyword-delete-file.md diff --git a/src/06-gbdialog/keyword-delete-http.md b/src/04-basic-scripting/keyword-delete-http.md similarity index 100% rename from src/06-gbdialog/keyword-delete-http.md rename to src/04-basic-scripting/keyword-delete-http.md diff --git a/src/06-gbdialog/keyword-delete.md b/src/04-basic-scripting/keyword-delete.md similarity index 100% rename from src/06-gbdialog/keyword-delete.md rename to src/04-basic-scripting/keyword-delete.md diff --git a/src/06-gbdialog/keyword-download.md b/src/04-basic-scripting/keyword-download.md similarity index 100% rename from src/06-gbdialog/keyword-download.md rename to src/04-basic-scripting/keyword-download.md diff --git a/src/06-gbdialog/keyword-exit-for.md b/src/04-basic-scripting/keyword-exit-for.md similarity index 100% rename from src/06-gbdialog/keyword-exit-for.md rename to src/04-basic-scripting/keyword-exit-for.md diff --git a/src/06-gbdialog/keyword-extract.md b/src/04-basic-scripting/keyword-extract.md similarity index 100% rename from src/06-gbdialog/keyword-extract.md rename to src/04-basic-scripting/keyword-extract.md diff --git a/src/06-gbdialog/keyword-face-api.md b/src/04-basic-scripting/keyword-face-api.md similarity index 100% rename from src/06-gbdialog/keyword-face-api.md rename to src/04-basic-scripting/keyword-face-api.md diff --git a/src/06-gbdialog/keyword-fill.md b/src/04-basic-scripting/keyword-fill.md similarity index 100% rename from src/06-gbdialog/keyword-fill.md rename to src/04-basic-scripting/keyword-fill.md diff --git a/src/06-gbdialog/keyword-filter.md b/src/04-basic-scripting/keyword-filter.md similarity index 100% rename from src/06-gbdialog/keyword-filter.md rename to src/04-basic-scripting/keyword-filter.md diff --git a/src/06-gbdialog/keyword-find.md b/src/04-basic-scripting/keyword-find.md similarity index 100% rename from src/06-gbdialog/keyword-find.md rename to src/04-basic-scripting/keyword-find.md diff --git a/src/06-gbdialog/keyword-first.md b/src/04-basic-scripting/keyword-first.md similarity index 100% rename from src/06-gbdialog/keyword-first.md rename to src/04-basic-scripting/keyword-first.md diff --git a/src/06-gbdialog/keyword-for-each.md b/src/04-basic-scripting/keyword-for-each.md similarity index 100% rename from src/06-gbdialog/keyword-for-each.md rename to src/04-basic-scripting/keyword-for-each.md diff --git a/src/06-gbdialog/keyword-format.md b/src/04-basic-scripting/keyword-format.md similarity index 100% rename from src/06-gbdialog/keyword-format.md rename to src/04-basic-scripting/keyword-format.md diff --git a/src/06-gbdialog/keyword-generate-pdf.md b/src/04-basic-scripting/keyword-generate-pdf.md similarity index 100% rename from src/06-gbdialog/keyword-generate-pdf.md rename to src/04-basic-scripting/keyword-generate-pdf.md diff --git a/src/06-gbdialog/keyword-get-bot-memory.md b/src/04-basic-scripting/keyword-get-bot-memory.md similarity index 100% rename from src/06-gbdialog/keyword-get-bot-memory.md rename to src/04-basic-scripting/keyword-get-bot-memory.md diff --git a/src/06-gbdialog/keyword-get-user-memory.md b/src/04-basic-scripting/keyword-get-user-memory.md similarity index 94% rename from src/06-gbdialog/keyword-get-user-memory.md rename to src/04-basic-scripting/keyword-get-user-memory.md index 34c76eac..d6defa5c 100644 --- a/src/06-gbdialog/keyword-get-user-memory.md +++ b/src/04-basic-scripting/keyword-get-user-memory.md @@ -186,6 +186,6 @@ END IF ## See Also -- [Memory Management](../chapter-11-features/memory-management.md) - Complete memory architecture -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Cross-bot data sharing -- [User Context](../chapter-12-auth/user-system-context.md) - User vs system context \ No newline at end of file +- [Memory Management](../03-knowledge-ai/memory-management.md) - Complete memory architecture +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Cross-bot data sharing +- [User Context](../09-security/user-system-context.md) - User vs system context \ No newline at end of file diff --git a/src/06-gbdialog/keyword-get.md b/src/04-basic-scripting/keyword-get.md similarity index 100% rename from src/06-gbdialog/keyword-get.md rename to src/04-basic-scripting/keyword-get.md diff --git a/src/06-gbdialog/keyword-goto.md b/src/04-basic-scripting/keyword-goto.md similarity index 100% rename from src/06-gbdialog/keyword-goto.md rename to src/04-basic-scripting/keyword-goto.md diff --git a/src/06-gbdialog/keyword-graphql.md b/src/04-basic-scripting/keyword-graphql.md similarity index 100% rename from src/06-gbdialog/keyword-graphql.md rename to src/04-basic-scripting/keyword-graphql.md diff --git a/src/06-gbdialog/keyword-group-by.md b/src/04-basic-scripting/keyword-group-by.md similarity index 100% rename from src/06-gbdialog/keyword-group-by.md rename to src/04-basic-scripting/keyword-group-by.md diff --git a/src/06-gbdialog/keyword-hear.md b/src/04-basic-scripting/keyword-hear.md similarity index 100% rename from src/06-gbdialog/keyword-hear.md rename to src/04-basic-scripting/keyword-hear.md diff --git a/src/06-gbdialog/keyword-insert.md b/src/04-basic-scripting/keyword-insert.md similarity index 100% rename from src/06-gbdialog/keyword-insert.md rename to src/04-basic-scripting/keyword-insert.md diff --git a/src/06-gbdialog/keyword-instr.md b/src/04-basic-scripting/keyword-instr.md similarity index 100% rename from src/06-gbdialog/keyword-instr.md rename to src/04-basic-scripting/keyword-instr.md diff --git a/src/06-gbdialog/keyword-is-numeric.md b/src/04-basic-scripting/keyword-is-numeric.md similarity index 100% rename from src/06-gbdialog/keyword-is-numeric.md rename to src/04-basic-scripting/keyword-is-numeric.md diff --git a/src/06-gbdialog/keyword-join.md b/src/04-basic-scripting/keyword-join.md similarity index 100% rename from src/06-gbdialog/keyword-join.md rename to src/04-basic-scripting/keyword-join.md diff --git a/src/06-gbdialog/keyword-kb-collection-stats.md b/src/04-basic-scripting/keyword-kb-collection-stats.md similarity index 100% rename from src/06-gbdialog/keyword-kb-collection-stats.md rename to src/04-basic-scripting/keyword-kb-collection-stats.md diff --git a/src/06-gbdialog/keyword-kb-documents-added-since.md b/src/04-basic-scripting/keyword-kb-documents-added-since.md similarity index 100% rename from src/06-gbdialog/keyword-kb-documents-added-since.md rename to src/04-basic-scripting/keyword-kb-documents-added-since.md diff --git a/src/06-gbdialog/keyword-kb-documents-count.md b/src/04-basic-scripting/keyword-kb-documents-count.md similarity index 100% rename from src/06-gbdialog/keyword-kb-documents-count.md rename to src/04-basic-scripting/keyword-kb-documents-count.md diff --git a/src/06-gbdialog/keyword-kb-list-collections.md b/src/04-basic-scripting/keyword-kb-list-collections.md similarity index 100% rename from src/06-gbdialog/keyword-kb-list-collections.md rename to src/04-basic-scripting/keyword-kb-list-collections.md diff --git a/src/06-gbdialog/keyword-kb-statistics.md b/src/04-basic-scripting/keyword-kb-statistics.md similarity index 100% rename from src/06-gbdialog/keyword-kb-statistics.md rename to src/04-basic-scripting/keyword-kb-statistics.md diff --git a/src/06-gbdialog/keyword-kb-storage-size.md b/src/04-basic-scripting/keyword-kb-storage-size.md similarity index 100% rename from src/06-gbdialog/keyword-kb-storage-size.md rename to src/04-basic-scripting/keyword-kb-storage-size.md diff --git a/src/06-gbdialog/keyword-last.md b/src/04-basic-scripting/keyword-last.md similarity index 100% rename from src/06-gbdialog/keyword-last.md rename to src/04-basic-scripting/keyword-last.md diff --git a/src/06-gbdialog/keyword-list.md b/src/04-basic-scripting/keyword-list.md similarity index 100% rename from src/06-gbdialog/keyword-list.md rename to src/04-basic-scripting/keyword-list.md diff --git a/src/06-gbdialog/keyword-map.md b/src/04-basic-scripting/keyword-map.md similarity index 100% rename from src/06-gbdialog/keyword-map.md rename to src/04-basic-scripting/keyword-map.md diff --git a/src/06-gbdialog/keyword-merge-pdf.md b/src/04-basic-scripting/keyword-merge-pdf.md similarity index 100% rename from src/06-gbdialog/keyword-merge-pdf.md rename to src/04-basic-scripting/keyword-merge-pdf.md diff --git a/src/06-gbdialog/keyword-merge.md b/src/04-basic-scripting/keyword-merge.md similarity index 100% rename from src/06-gbdialog/keyword-merge.md rename to src/04-basic-scripting/keyword-merge.md diff --git a/src/06-gbdialog/keyword-model-route.md b/src/04-basic-scripting/keyword-model-route.md similarity index 100% rename from src/06-gbdialog/keyword-model-route.md rename to src/04-basic-scripting/keyword-model-route.md diff --git a/src/06-gbdialog/keyword-move.md b/src/04-basic-scripting/keyword-move.md similarity index 100% rename from src/06-gbdialog/keyword-move.md rename to src/04-basic-scripting/keyword-move.md diff --git a/src/06-gbdialog/keyword-on-change.md b/src/04-basic-scripting/keyword-on-change.md similarity index 100% rename from src/06-gbdialog/keyword-on-change.md rename to src/04-basic-scripting/keyword-on-change.md diff --git a/src/06-gbdialog/keyword-on-email.md b/src/04-basic-scripting/keyword-on-email.md similarity index 100% rename from src/06-gbdialog/keyword-on-email.md rename to src/04-basic-scripting/keyword-on-email.md diff --git a/src/06-gbdialog/keyword-on-error.md b/src/04-basic-scripting/keyword-on-error.md similarity index 100% rename from src/06-gbdialog/keyword-on-error.md rename to src/04-basic-scripting/keyword-on-error.md diff --git a/src/06-gbdialog/keyword-on.md b/src/04-basic-scripting/keyword-on.md similarity index 100% rename from src/06-gbdialog/keyword-on.md rename to src/04-basic-scripting/keyword-on.md diff --git a/src/06-gbdialog/keyword-patch.md b/src/04-basic-scripting/keyword-patch.md similarity index 100% rename from src/06-gbdialog/keyword-patch.md rename to src/04-basic-scripting/keyword-patch.md diff --git a/src/06-gbdialog/keyword-pivot.md b/src/04-basic-scripting/keyword-pivot.md similarity index 100% rename from src/06-gbdialog/keyword-pivot.md rename to src/04-basic-scripting/keyword-pivot.md diff --git a/src/06-gbdialog/keyword-play.md b/src/04-basic-scripting/keyword-play.md similarity index 100% rename from src/06-gbdialog/keyword-play.md rename to src/04-basic-scripting/keyword-play.md diff --git a/src/06-gbdialog/keyword-post-to.md b/src/04-basic-scripting/keyword-post-to.md similarity index 100% rename from src/06-gbdialog/keyword-post-to.md rename to src/04-basic-scripting/keyword-post-to.md diff --git a/src/06-gbdialog/keyword-post.md b/src/04-basic-scripting/keyword-post.md similarity index 100% rename from src/06-gbdialog/keyword-post.md rename to src/04-basic-scripting/keyword-post.md diff --git a/src/06-gbdialog/keyword-print.md b/src/04-basic-scripting/keyword-print.md similarity index 100% rename from src/06-gbdialog/keyword-print.md rename to src/04-basic-scripting/keyword-print.md diff --git a/src/06-gbdialog/keyword-put.md b/src/04-basic-scripting/keyword-put.md similarity index 100% rename from src/06-gbdialog/keyword-put.md rename to src/04-basic-scripting/keyword-put.md diff --git a/src/06-gbdialog/keyword-qrcode.md b/src/04-basic-scripting/keyword-qrcode.md similarity index 100% rename from src/06-gbdialog/keyword-qrcode.md rename to src/04-basic-scripting/keyword-qrcode.md diff --git a/src/06-gbdialog/keyword-read.md b/src/04-basic-scripting/keyword-read.md similarity index 100% rename from src/06-gbdialog/keyword-read.md rename to src/04-basic-scripting/keyword-read.md diff --git a/src/06-gbdialog/keyword-reference-complete.md b/src/04-basic-scripting/keyword-reference-complete.md similarity index 100% rename from src/06-gbdialog/keyword-reference-complete.md rename to src/04-basic-scripting/keyword-reference-complete.md diff --git a/src/06-gbdialog/keyword-remember.md b/src/04-basic-scripting/keyword-remember.md similarity index 97% rename from src/06-gbdialog/keyword-remember.md rename to src/04-basic-scripting/keyword-remember.md index fafe1d69..6ce35fd6 100644 --- a/src/06-gbdialog/keyword-remember.md +++ b/src/04-basic-scripting/keyword-remember.md @@ -206,5 +206,5 @@ value = RECALL "nonexistent_key" ## See Also -- [Memory Management](../chapter-10-features/memory-management.md) -- [User Session Handling](../chapter-10-features/user-sessions.md) \ No newline at end of file +- [Memory Management](../03-knowledge-ai/memory-management.md) +- [User Session Handling](../03-knowledge-ai/user-sessions.md) \ No newline at end of file diff --git a/src/06-gbdialog/keyword-run-code.md b/src/04-basic-scripting/keyword-run-code.md similarity index 97% rename from src/06-gbdialog/keyword-run-code.md rename to src/04-basic-scripting/keyword-run-code.md index db9449f5..43b2a373 100644 --- a/src/06-gbdialog/keyword-run-code.md +++ b/src/04-basic-scripting/keyword-run-code.md @@ -335,6 +335,6 @@ END IF ## See Also -- [Code Sandbox Architecture](../chapter-07-gbapp/containers.md) - Technical details -- [Security Features](../chapter-12-auth/security-features.md) - Sandbox security model +- [Code Sandbox Architecture](../02-architecture-packages/containers.md) - Technical details +- [Security Features](../09-security/security-features.md) - Sandbox security model - [Data Operations](./keywords-data.md) - Alternative data processing keywords \ No newline at end of file diff --git a/src/06-gbdialog/keyword-save.md b/src/04-basic-scripting/keyword-save.md similarity index 100% rename from src/06-gbdialog/keyword-save.md rename to src/04-basic-scripting/keyword-save.md diff --git a/src/06-gbdialog/keyword-send-mail.md b/src/04-basic-scripting/keyword-send-mail.md similarity index 100% rename from src/06-gbdialog/keyword-send-mail.md rename to src/04-basic-scripting/keyword-send-mail.md diff --git a/src/06-gbdialog/keyword-send-template.md b/src/04-basic-scripting/keyword-send-template.md similarity index 100% rename from src/06-gbdialog/keyword-send-template.md rename to src/04-basic-scripting/keyword-send-template.md diff --git a/src/06-gbdialog/keyword-set-bot-memory.md b/src/04-basic-scripting/keyword-set-bot-memory.md similarity index 100% rename from src/06-gbdialog/keyword-set-bot-memory.md rename to src/04-basic-scripting/keyword-set-bot-memory.md diff --git a/src/06-gbdialog/keyword-set-context.md b/src/04-basic-scripting/keyword-set-context.md similarity index 100% rename from src/06-gbdialog/keyword-set-context.md rename to src/04-basic-scripting/keyword-set-context.md diff --git a/src/06-gbdialog/keyword-set-header.md b/src/04-basic-scripting/keyword-set-header.md similarity index 100% rename from src/06-gbdialog/keyword-set-header.md rename to src/04-basic-scripting/keyword-set-header.md diff --git a/src/06-gbdialog/keyword-set-schedule.md b/src/04-basic-scripting/keyword-set-schedule.md similarity index 100% rename from src/06-gbdialog/keyword-set-schedule.md rename to src/04-basic-scripting/keyword-set-schedule.md diff --git a/src/06-gbdialog/keyword-set-user-memory.md b/src/04-basic-scripting/keyword-set-user-memory.md similarity index 93% rename from src/06-gbdialog/keyword-set-user-memory.md rename to src/04-basic-scripting/keyword-set-user-memory.md index bffe6bae..77dbda68 100644 --- a/src/06-gbdialog/keyword-set-user-memory.md +++ b/src/04-basic-scripting/keyword-set-user-memory.md @@ -145,6 +145,6 @@ user-memory-default-ttl,0 ## See Also -- [Memory Management](../chapter-11-features/memory-management.md) - Complete memory architecture -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Cross-bot data sharing -- [User Context](../chapter-12-auth/user-system-context.md) - User vs system context \ No newline at end of file +- [Memory Management](../03-knowledge-ai/memory-management.md) - Complete memory architecture +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Cross-bot data sharing +- [User Context](../09-security/user-system-context.md) - User vs system context \ No newline at end of file diff --git a/src/06-gbdialog/keyword-set-user.md b/src/04-basic-scripting/keyword-set-user.md similarity index 100% rename from src/06-gbdialog/keyword-set-user.md rename to src/04-basic-scripting/keyword-set-user.md diff --git a/src/06-gbdialog/keyword-set.md b/src/04-basic-scripting/keyword-set.md similarity index 100% rename from src/06-gbdialog/keyword-set.md rename to src/04-basic-scripting/keyword-set.md diff --git a/src/06-gbdialog/keyword-sms.md b/src/04-basic-scripting/keyword-sms.md similarity index 98% rename from src/06-gbdialog/keyword-sms.md rename to src/04-basic-scripting/keyword-sms.md index e6256e6d..d03a621c 100644 --- a/src/06-gbdialog/keyword-sms.md +++ b/src/04-basic-scripting/keyword-sms.md @@ -411,7 +411,7 @@ END IF - [SEND MAIL](./keyword-send-mail.md) - Email messaging - [SEND TEMPLATE](./keyword-send-template.md) - Template messages - [Universal Messaging](./universal-messaging.md) - Multi-channel messaging -- [SMS Provider Configuration](../08-config/sms-providers.md) - Provider setup guide +- [SMS Provider Configuration](../10-configuration-deployment/sms-providers.md) - Provider setup guide ## Implementation diff --git a/src/06-gbdialog/keyword-soap.md b/src/04-basic-scripting/keyword-soap.md similarity index 100% rename from src/06-gbdialog/keyword-soap.md rename to src/04-basic-scripting/keyword-soap.md diff --git a/src/06-gbdialog/keyword-start-meet.md b/src/04-basic-scripting/keyword-start-meet.md similarity index 98% rename from src/06-gbdialog/keyword-start-meet.md rename to src/04-basic-scripting/keyword-start-meet.md index e5f92378..212d875e 100644 --- a/src/06-gbdialog/keyword-start-meet.md +++ b/src/04-basic-scripting/keyword-start-meet.md @@ -375,7 +375,7 @@ When a bot joins a meeting, it can: ## See Also -- [Meet App](../chapter-04-gbui/apps/meet.md) - User interface for Meet +- [Meet App](../07-user-interface/apps/meet.md) - User interface for Meet - [BOOK_MEETING](./keyword-book.md) - Schedule meetings with calendar integration -- [Calls API](../chapter-10-rest/calls-api.md) - API reference for video calls +- [Calls API](../08-rest-api-tools/calls-api.md) - API reference for video calls - [Multi-Agent Keywords](./keywords-multi-agent.md) - Bot collaboration features \ No newline at end of file diff --git a/src/06-gbdialog/keyword-switch.md b/src/04-basic-scripting/keyword-switch.md similarity index 100% rename from src/06-gbdialog/keyword-switch.md rename to src/04-basic-scripting/keyword-switch.md diff --git a/src/06-gbdialog/keyword-synchronize.md b/src/04-basic-scripting/keyword-synchronize.md similarity index 100% rename from src/06-gbdialog/keyword-synchronize.md rename to src/04-basic-scripting/keyword-synchronize.md diff --git a/src/06-gbdialog/keyword-table.md b/src/04-basic-scripting/keyword-table.md similarity index 98% rename from src/06-gbdialog/keyword-table.md rename to src/04-basic-scripting/keyword-table.md index 13693415..30d54ca2 100644 --- a/src/06-gbdialog/keyword-table.md +++ b/src/04-basic-scripting/keyword-table.md @@ -220,4 +220,4 @@ DELETE "Contatos", "Id=123" - [INSERT](./keyword-insert.md) - Insert new records - [UPDATE](./keyword-update.md) - Update existing records - [DELETE](./keyword-delete.md) - Delete records -- [config.csv](../chapter-08-config/config-csv.md) - Connection configuration \ No newline at end of file +- [config.csv](../10-configuration-deployment/config-csv.md) - Connection configuration \ No newline at end of file diff --git a/src/06-gbdialog/keyword-talk.md b/src/04-basic-scripting/keyword-talk.md similarity index 100% rename from src/06-gbdialog/keyword-talk.md rename to src/04-basic-scripting/keyword-talk.md diff --git a/src/06-gbdialog/keyword-update.md b/src/04-basic-scripting/keyword-update.md similarity index 100% rename from src/06-gbdialog/keyword-update.md rename to src/04-basic-scripting/keyword-update.md diff --git a/src/06-gbdialog/keyword-upload.md b/src/04-basic-scripting/keyword-upload.md similarity index 100% rename from src/06-gbdialog/keyword-upload.md rename to src/04-basic-scripting/keyword-upload.md diff --git a/src/06-gbdialog/keyword-use-account.md b/src/04-basic-scripting/keyword-use-account.md similarity index 96% rename from src/06-gbdialog/keyword-use-account.md rename to src/04-basic-scripting/keyword-use-account.md index 5f7b23e3..3ca026e4 100644 --- a/src/06-gbdialog/keyword-use-account.md +++ b/src/04-basic-scripting/keyword-use-account.md @@ -99,4 +99,4 @@ Configure accounts in Suite before use: - [USE KB](./keyword-use-kb.md) - [SEND MAIL](./keyword-send-mail.md) -- [Sources Sync Strategy](../08-config/sources-sync-strategy.md) \ No newline at end of file +- [Sources Sync Strategy](../10-configuration-deployment/sources-sync-strategy.md) \ No newline at end of file diff --git a/src/06-gbdialog/keyword-use-kb.md b/src/04-basic-scripting/keyword-use-kb.md similarity index 93% rename from src/06-gbdialog/keyword-use-kb.md rename to src/04-basic-scripting/keyword-use-kb.md index 0f70cbf3..4a9ca046 100644 --- a/src/06-gbdialog/keyword-use-kb.md +++ b/src/04-basic-scripting/keyword-use-kb.md @@ -126,5 +126,5 @@ END TRY ## See Also - [CLEAR KB](./keyword-clear-kb.md) - Deactivate collections -- [Knowledge Base System](../chapter-03/README.md) - Technical details -- [Semantic Search](../chapter-03/semantic-search.md) - How search works \ No newline at end of file +- [Knowledge Base System](../03-knowledge-ai/README.md) - Technical details +- [Semantic Search](../03-knowledge-ai/semantic-search.md) - How search works \ No newline at end of file diff --git a/src/06-gbdialog/keyword-use-mcp.md b/src/04-basic-scripting/keyword-use-mcp.md similarity index 97% rename from src/06-gbdialog/keyword-use-mcp.md rename to src/04-basic-scripting/keyword-use-mcp.md index 89b991e2..ae0bb230 100644 --- a/src/06-gbdialog/keyword-use-mcp.md +++ b/src/04-basic-scripting/keyword-use-mcp.md @@ -339,7 +339,7 @@ Error: Authentication failed for MCP server ## See Also -- [Sources](../04-gbui/apps/sources.md) - Managing MCP servers in the UI +- [Sources](../07-user-interface/apps/sources.md) - Managing MCP servers in the UI - [Autonomous Tasks](../07-gbapp/autonomous-tasks.md) - How Tasks use MCP tools -- [MCP Format](../09-tools/mcp-format.md) - MCP tool definition format -- [LLM Tools](../09-tools/README.md) - All available tool types \ No newline at end of file +- [MCP Format](../08-rest-api-tools/mcp-format.md) - MCP tool definition format +- [LLM Tools](../08-rest-api-tools/README.md) - All available tool types \ No newline at end of file diff --git a/src/06-gbdialog/keyword-use-model.md b/src/04-basic-scripting/keyword-use-model.md similarity index 94% rename from src/06-gbdialog/keyword-use-model.md rename to src/04-basic-scripting/keyword-use-model.md index 24472ce8..f99f4a43 100644 --- a/src/06-gbdialog/keyword-use-model.md +++ b/src/04-basic-scripting/keyword-use-model.md @@ -180,6 +180,6 @@ When `USE MODEL "auto"` is active, the system considers: ## See Also -- [LLM Configuration](../chapter-08-config/llm-config.md) - Model setup -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Model routing in multi-agent systems -- [Cost Tracking](../chapter-11-features/observability.md#cost-tracking) - Monitor model costs \ No newline at end of file +- [LLM Configuration](../10-configuration-deployment/llm-config.md) - Model setup +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Model routing in multi-agent systems +- [Cost Tracking](../03-knowledge-ai/observability.md#cost-tracking) - Monitor model costs \ No newline at end of file diff --git a/src/06-gbdialog/keyword-use-tool.md b/src/04-basic-scripting/keyword-use-tool.md similarity index 92% rename from src/06-gbdialog/keyword-use-tool.md rename to src/04-basic-scripting/keyword-use-tool.md index 1df330e3..19f15f22 100644 --- a/src/06-gbdialog/keyword-use-tool.md +++ b/src/04-basic-scripting/keyword-use-tool.md @@ -70,5 +70,5 @@ RETURN result ## Related - [CLEAR TOOLS](./keyword-clear-tools.md) -- [Tool Definition](../chapter-08/tool-definition.md) -- [PARAM Declaration](../chapter-08/param-declaration.md) +- [Tool Definition](../08-rest-api-tools/tool-definition.md) +- [PARAM Declaration](../08-rest-api-tools/param-declaration.md) diff --git a/src/06-gbdialog/keyword-use-website.md b/src/04-basic-scripting/keyword-use-website.md similarity index 100% rename from src/06-gbdialog/keyword-use-website.md rename to src/04-basic-scripting/keyword-use-website.md diff --git a/src/06-gbdialog/keyword-wait.md b/src/04-basic-scripting/keyword-wait.md similarity index 100% rename from src/06-gbdialog/keyword-wait.md rename to src/04-basic-scripting/keyword-wait.md diff --git a/src/06-gbdialog/keyword-weather.md b/src/04-basic-scripting/keyword-weather.md similarity index 100% rename from src/06-gbdialog/keyword-weather.md rename to src/04-basic-scripting/keyword-weather.md diff --git a/src/06-gbdialog/keyword-webhook.md b/src/04-basic-scripting/keyword-webhook.md similarity index 100% rename from src/06-gbdialog/keyword-webhook.md rename to src/04-basic-scripting/keyword-webhook.md diff --git a/src/06-gbdialog/keyword-write.md b/src/04-basic-scripting/keyword-write.md similarity index 100% rename from src/06-gbdialog/keyword-write.md rename to src/04-basic-scripting/keyword-write.md diff --git a/src/06-gbdialog/keywords-data.md b/src/04-basic-scripting/keywords-data.md similarity index 100% rename from src/06-gbdialog/keywords-data.md rename to src/04-basic-scripting/keywords-data.md diff --git a/src/06-gbdialog/keywords-file.md b/src/04-basic-scripting/keywords-file.md similarity index 100% rename from src/06-gbdialog/keywords-file.md rename to src/04-basic-scripting/keywords-file.md diff --git a/src/06-gbdialog/keywords-gpio.md b/src/04-basic-scripting/keywords-gpio.md similarity index 100% rename from src/06-gbdialog/keywords-gpio.md rename to src/04-basic-scripting/keywords-gpio.md diff --git a/src/06-gbdialog/keywords-http.md b/src/04-basic-scripting/keywords-http.md similarity index 100% rename from src/06-gbdialog/keywords-http.md rename to src/04-basic-scripting/keywords-http.md diff --git a/src/06-gbdialog/keywords-kb-statistics.md b/src/04-basic-scripting/keywords-kb-statistics.md similarity index 98% rename from src/06-gbdialog/keywords-kb-statistics.md rename to src/04-basic-scripting/keywords-kb-statistics.md index 0d371c66..11567bdb 100644 --- a/src/06-gbdialog/keywords-kb-statistics.md +++ b/src/04-basic-scripting/keywords-kb-statistics.md @@ -361,4 +361,4 @@ SEND MAIL "compliance@example.com", "Monthly KB Report", report - [USE KB](./keyword-use-kb.md) - Load knowledge base for queries - [CLEAR KB](./keyword-clear-kb.md) - Clear knowledge base -- [Vector Collections](../chapter-03/vector-collections.md) - Understanding collections \ No newline at end of file +- [Vector Collections](../03-knowledge-ai/vector-collections.md) - Understanding collections \ No newline at end of file diff --git a/src/06-gbdialog/keywords-lead-scoring.md b/src/04-basic-scripting/keywords-lead-scoring.md similarity index 100% rename from src/06-gbdialog/keywords-lead-scoring.md rename to src/04-basic-scripting/keywords-lead-scoring.md diff --git a/src/06-gbdialog/keywords-media.md b/src/04-basic-scripting/keywords-media.md similarity index 100% rename from src/06-gbdialog/keywords-media.md rename to src/04-basic-scripting/keywords-media.md diff --git a/src/06-gbdialog/keywords-multi-agent.md b/src/04-basic-scripting/keywords-multi-agent.md similarity index 97% rename from src/06-gbdialog/keywords-multi-agent.md rename to src/04-basic-scripting/keywords-multi-agent.md index ae361c10..c9f6662d 100644 --- a/src/06-gbdialog/keywords-multi-agent.md +++ b/src/04-basic-scripting/keywords-multi-agent.md @@ -272,5 +272,5 @@ reflection-min-messages,3 - [ADD BOT](./keyword-add-bot.md) - Detailed ADD BOT reference - [DELEGATE TO BOT](./keyword-delegate-to-bot.md) - Delegation details - [BOT REFLECTION](./keyword-bot-reflection.md) - Reflection details -- [Multi-Agent Orchestration](../chapter-11-features/multi-agent-orchestration.md) - Complete guide -- [A2A Protocol](../chapter-11-features/a2a-protocol.md) - Protocol details \ No newline at end of file +- [Multi-Agent Orchestration](../03-knowledge-ai/multi-agent-orchestration.md) - Complete guide +- [A2A Protocol](../03-knowledge-ai/a2a-protocol.md) - Protocol details \ No newline at end of file diff --git a/src/06-gbdialog/keywords-social-media.md b/src/04-basic-scripting/keywords-social-media.md similarity index 100% rename from src/06-gbdialog/keywords-social-media.md rename to src/04-basic-scripting/keywords-social-media.md diff --git a/src/06-gbdialog/keywords.md b/src/04-basic-scripting/keywords.md similarity index 100% rename from src/06-gbdialog/keywords.md rename to src/04-basic-scripting/keywords.md diff --git a/src/06-gbdialog/prompt-blocks.md b/src/04-basic-scripting/prompt-blocks.md similarity index 100% rename from src/06-gbdialog/prompt-blocks.md rename to src/04-basic-scripting/prompt-blocks.md diff --git a/src/06-gbdialog/script-execution-flow.md b/src/04-basic-scripting/script-execution-flow.md similarity index 100% rename from src/06-gbdialog/script-execution-flow.md rename to src/04-basic-scripting/script-execution-flow.md diff --git a/src/06-gbdialog/template-enrollment.md b/src/04-basic-scripting/template-enrollment.md similarity index 100% rename from src/06-gbdialog/template-enrollment.md rename to src/04-basic-scripting/template-enrollment.md diff --git a/src/06-gbdialog/template-start.md b/src/04-basic-scripting/template-start.md similarity index 100% rename from src/06-gbdialog/template-start.md rename to src/04-basic-scripting/template-start.md diff --git a/src/06-gbdialog/template-summary.md b/src/04-basic-scripting/template-summary.md similarity index 100% rename from src/06-gbdialog/template-summary.md rename to src/04-basic-scripting/template-summary.md diff --git a/src/06-gbdialog/template-variables.md b/src/04-basic-scripting/template-variables.md similarity index 100% rename from src/06-gbdialog/template-variables.md rename to src/04-basic-scripting/template-variables.md diff --git a/src/06-gbdialog/templates.md b/src/04-basic-scripting/templates.md similarity index 100% rename from src/06-gbdialog/templates.md rename to src/04-basic-scripting/templates.md diff --git a/src/06-gbdialog/templates/ai-search.md b/src/04-basic-scripting/templates/ai-search.md similarity index 100% rename from src/06-gbdialog/templates/ai-search.md rename to src/04-basic-scripting/templates/ai-search.md diff --git a/src/06-gbdialog/templates/analytics-dashboard.md b/src/04-basic-scripting/templates/analytics-dashboard.md similarity index 100% rename from src/06-gbdialog/templates/analytics-dashboard.md rename to src/04-basic-scripting/templates/analytics-dashboard.md diff --git a/src/06-gbdialog/templates/announcements.md b/src/04-basic-scripting/templates/announcements.md similarity index 100% rename from src/06-gbdialog/templates/announcements.md rename to src/04-basic-scripting/templates/announcements.md diff --git a/src/06-gbdialog/templates/auth.md b/src/04-basic-scripting/templates/auth.md similarity index 100% rename from src/06-gbdialog/templates/auth.md rename to src/04-basic-scripting/templates/auth.md diff --git a/src/06-gbdialog/templates/backup.md b/src/04-basic-scripting/templates/backup.md similarity index 100% rename from src/06-gbdialog/templates/backup.md rename to src/04-basic-scripting/templates/backup.md diff --git a/src/06-gbdialog/templates/bank.md b/src/04-basic-scripting/templates/bank.md similarity index 100% rename from src/06-gbdialog/templates/bank.md rename to src/04-basic-scripting/templates/bank.md diff --git a/src/06-gbdialog/templates/broadcast.md b/src/04-basic-scripting/templates/broadcast.md similarity index 100% rename from src/06-gbdialog/templates/broadcast.md rename to src/04-basic-scripting/templates/broadcast.md diff --git a/src/06-gbdialog/templates/default.md b/src/04-basic-scripting/templates/default.md similarity index 100% rename from src/06-gbdialog/templates/default.md rename to src/04-basic-scripting/templates/default.md diff --git a/src/06-gbdialog/templates/edu.md b/src/04-basic-scripting/templates/edu.md similarity index 100% rename from src/06-gbdialog/templates/edu.md rename to src/04-basic-scripting/templates/edu.md diff --git a/src/06-gbdialog/templates/employees.md b/src/04-basic-scripting/templates/employees.md similarity index 100% rename from src/06-gbdialog/templates/employees.md rename to src/04-basic-scripting/templates/employees.md diff --git a/src/06-gbdialog/templates/enrollment.md b/src/04-basic-scripting/templates/enrollment.md similarity index 100% rename from src/06-gbdialog/templates/enrollment.md rename to src/04-basic-scripting/templates/enrollment.md diff --git a/src/06-gbdialog/templates/erp.md b/src/04-basic-scripting/templates/erp.md similarity index 100% rename from src/06-gbdialog/templates/erp.md rename to src/04-basic-scripting/templates/erp.md diff --git a/src/06-gbdialog/templates/helpdesk.md b/src/04-basic-scripting/templates/helpdesk.md similarity index 100% rename from src/06-gbdialog/templates/helpdesk.md rename to src/04-basic-scripting/templates/helpdesk.md diff --git a/src/06-gbdialog/templates/privacy.md b/src/04-basic-scripting/templates/privacy.md similarity index 100% rename from src/06-gbdialog/templates/privacy.md rename to src/04-basic-scripting/templates/privacy.md diff --git a/src/06-gbdialog/templates/sales-pipeline.md b/src/04-basic-scripting/templates/sales-pipeline.md similarity index 100% rename from src/06-gbdialog/templates/sales-pipeline.md rename to src/04-basic-scripting/templates/sales-pipeline.md diff --git a/src/06-gbdialog/templates/start.md b/src/04-basic-scripting/templates/start.md similarity index 100% rename from src/06-gbdialog/templates/start.md rename to src/04-basic-scripting/templates/start.md diff --git a/src/06-gbdialog/templates/store.md b/src/04-basic-scripting/templates/store.md similarity index 100% rename from src/06-gbdialog/templates/store.md rename to src/04-basic-scripting/templates/store.md diff --git a/src/06-gbdialog/templates/talk-to-data.md b/src/04-basic-scripting/templates/talk-to-data.md similarity index 100% rename from src/06-gbdialog/templates/talk-to-data.md rename to src/04-basic-scripting/templates/talk-to-data.md diff --git a/src/06-gbdialog/templates/whatsapp.md b/src/04-basic-scripting/templates/whatsapp.md similarity index 100% rename from src/06-gbdialog/templates/whatsapp.md rename to src/04-basic-scripting/templates/whatsapp.md diff --git a/src/06-gbdialog/tools-data-sync.md b/src/04-basic-scripting/tools-data-sync.md similarity index 100% rename from src/06-gbdialog/tools-data-sync.md rename to src/04-basic-scripting/tools-data-sync.md diff --git a/src/06-gbdialog/universal-messaging.md b/src/04-basic-scripting/universal-messaging.md similarity index 100% rename from src/06-gbdialog/universal-messaging.md rename to src/04-basic-scripting/universal-messaging.md diff --git a/src/04-gbui/README.md b/src/04-gbui/README.md deleted file mode 100644 index 61ff9135..00000000 --- a/src/04-gbui/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# Chapter 04: User Interface - -General Bots UI system built with HTMX and server-side rendering. - -## UI Modes - -| Mode | Description | Use Case | -|------|-------------|----------| -| **default.gbui** | Full desktop suite | Complete productivity | -| **single.gbui** | Simple chat widget | Embedded chat | -| **console** | Terminal interface | Development/testing | - -## Architecture - -- **HTMX** - Dynamic updates without JavaScript frameworks -- **Server-Side Rendering** - Fast, SEO-friendly pages -- **Minimal JS** - No build process required - -## Quick Access - -``` -http://localhost:9000 → Main interface -http://localhost:9000/chat → Chat app -http://localhost:9000/drive → File manager -http://localhost:9000/console → Terminal mode -``` - -## Suite Applications - -| App | Purpose | -|-----|---------| -| Chat | AI assistant conversations | -| Drive | File management | -| Tasks | LLM-powered intelligent execution | -| Mail | Email client | -| Calendar | Scheduling | -| Meet | Video calls | -| Paper | AI writing | -| Research | AI search | - -## Chapter Contents - -- [Suite User Manual](./suite-manual.md) - End-user guide -- [UI Structure](./ui-structure.md) - Component layout -- [default.gbui](./default-gbui.md) - Full desktop mode -- [single.gbui](./single-gbui.md) - Chat widget mode -- [Console Mode](./console-mode.md) - Terminal interface -- [HTMX Architecture](./htmx-architecture.md) - Technical details -- [Suite Applications](./apps/README.md) - App documentation -- [How-To Tutorials](./how-to/README.md) - Step-by-step guides - -## See Also - -- [.gbtheme Package](../chapter-05-gbtheme/README.md) - Styling and themes -- [.gbui Structure](../chapter-02/gbui.md) - Package format \ No newline at end of file diff --git a/src/17-autonomous-tasks/README.md b/src/05-multi-agent/README.md similarity index 86% rename from src/17-autonomous-tasks/README.md rename to src/05-multi-agent/README.md index f24e135d..2ff6a7c9 100644 --- a/src/17-autonomous-tasks/README.md +++ b/src/05-multi-agent/README.md @@ -1,24 +1,10 @@ -# Autonomous Tasks +# Chapter 5: Multi-Agent Orchestration Build complete applications through natural conversation. Describe what you want, and the system creates it automatically. The AutoTask system uses an LLM-powered intent classifier to understand your request and route it to the appropriate handler. Whether you need a full web application, a simple reminder, or automated monitoring, you describe it in plain language. -![AutoTask Architecture](../assets/chapter-17/autotask-architecture.svg) - ---- - -## Vibe Mode - -For a complete AI-powered development environment, use **Vibe** - the visual interface with multi-agent orchestration. - -### Vibe Documentation -- [Vibe Guide](./vibe.md) - Main documentation -- [Vibe Terminal](./vibe-terminal.md) - Isolated container terminal -- [Vibe Editor](./vibe-editor.md) - Monaco editor -- [Vibe Database](./vibe-database.md) - PostgreSQL browser -- [Vibe Git](./vibe-git.md) - Git operations -- [Vibe MCP](./vibe-mcp.md) - MCP integrations +![AutoTask Architecture](../assets/05-multi-agent/autotask-architecture.svg) --- @@ -60,7 +46,7 @@ For a complete AI-powered development environment, use **Vibe** - the visual int ## Architecture Overview -![Bot Database Architecture](../assets/chapter-17/bot-database-architecture.svg) +![Bot Database Architecture](../assets/05-multi-agent/bot-database-architecture.svg) One bot equals one database. All applications within a bot share the same data tables, tools, and schedulers. diff --git a/src/17-autonomous-tasks/agent-workspaces.md b/src/05-multi-agent/agent-workspaces.md similarity index 100% rename from src/17-autonomous-tasks/agent-workspaces.md rename to src/05-multi-agent/agent-workspaces.md diff --git a/src/17-autonomous-tasks/api-reference.md b/src/05-multi-agent/api-reference.md similarity index 100% rename from src/17-autonomous-tasks/api-reference.md rename to src/05-multi-agent/api-reference.md diff --git a/src/17-autonomous-tasks/app-generation.md b/src/05-multi-agent/app-generation.md similarity index 97% rename from src/17-autonomous-tasks/app-generation.md rename to src/05-multi-agent/app-generation.md index f1a31643..485404fd 100644 --- a/src/17-autonomous-tasks/app-generation.md +++ b/src/05-multi-agent/app-generation.md @@ -2,7 +2,7 @@ From natural language to complete application, the generation process handles database design, UI creation, and automation setup. -![App Generation Flow](../assets/chapter-17/app-generation-flow.svg) +![App Generation Flow](../assets/05-multi-agent/app-generation-flow.svg) --- diff --git a/src/17-autonomous-tasks/data-model.md b/src/05-multi-agent/data-model.md similarity index 96% rename from src/17-autonomous-tasks/data-model.md rename to src/05-multi-agent/data-model.md index b7184328..bb6fc4cd 100644 --- a/src/17-autonomous-tasks/data-model.md +++ b/src/05-multi-agent/data-model.md @@ -2,7 +2,7 @@ Tables store your application data. When you describe what you need, the system creates table definitions automatically in `tables.bas`. -![Data Model Flow](../assets/chapter-17/data-model-flow.svg) +![Data Model Flow](../assets/05-multi-agent/data-model-flow.svg) --- diff --git a/src/17-autonomous-tasks/designer.md b/src/05-multi-agent/designer.md similarity index 98% rename from src/17-autonomous-tasks/designer.md rename to src/05-multi-agent/designer.md index 9d707c7e..a40d63e7 100644 --- a/src/17-autonomous-tasks/designer.md +++ b/src/05-multi-agent/designer.md @@ -2,7 +2,7 @@ Designer is an AI assistant that appears alongside your application. Use natural conversation to modify any aspect of your app without writing code. -![Designer Workflow](../assets/chapter-17/designer-workflow.svg) +![Designer Workflow](../assets/05-multi-agent/designer-workflow.svg) --- diff --git a/src/17-autonomous-tasks/devchat.md b/src/05-multi-agent/devchat.md similarity index 100% rename from src/17-autonomous-tasks/devchat.md rename to src/05-multi-agent/devchat.md diff --git a/src/17-autonomous-tasks/examples.md b/src/05-multi-agent/examples.md similarity index 100% rename from src/17-autonomous-tasks/examples.md rename to src/05-multi-agent/examples.md diff --git a/src/17-autonomous-tasks/workflow.md b/src/05-multi-agent/workflow.md similarity index 96% rename from src/17-autonomous-tasks/workflow.md rename to src/05-multi-agent/workflow.md index 26d71f93..cf558e30 100644 --- a/src/17-autonomous-tasks/workflow.md +++ b/src/05-multi-agent/workflow.md @@ -2,7 +2,7 @@ From request to working application, the task workflow handles every step automatically. -![Task Workflow](../assets/chapter-17/task-workflow.svg) +![Task Workflow](../assets/05-multi-agent/task-workflow.svg) --- diff --git a/src/18-appendix-external-services/README.md b/src/06-channels/README.md similarity index 94% rename from src/18-appendix-external-services/README.md rename to src/06-channels/README.md index c71dea3c..8ce13399 100644 --- a/src/18-appendix-external-services/README.md +++ b/src/06-channels/README.md @@ -1,6 +1,6 @@ -# Appendix B: External Services +# Chapter 6: Channels & Connectivity -This appendix catalogs all external services that General Bots integrates with, including their configuration requirements, associated BASIC keywords, and API endpoints. +This chapter catalogs all external services that General Bots integrates with. ## Overview diff --git a/src/18-appendix-external-services/attendance-queue.md b/src/06-channels/attendance-queue.md similarity index 97% rename from src/18-appendix-external-services/attendance-queue.md rename to src/06-channels/attendance-queue.md index 4c998051..10451e1d 100644 --- a/src/18-appendix-external-services/attendance-queue.md +++ b/src/06-channels/attendance-queue.md @@ -441,8 +441,8 @@ Configure these templates in your WhatsApp Business account: ## See Also -- [Human Approval](../chapter-06-gbdialog/keyword-human-approval.md) -- [SEND TEMPLATE](../chapter-06-gbdialog/keyword-send-template.md) -- [SET SCHEDULE](../chapter-06-gbdialog/keyword-set-schedule.md) -- [CREATE LEAD](../chapter-06-gbdialog/keywords-lead-scoring.md) -- [Sales CRM Template](../chapter-02/template-crm.md) \ No newline at end of file +- [Human Approval](../04-basic-scripting/keyword-human-approval.md) +- [SEND TEMPLATE](../04-basic-scripting/keyword-send-template.md) +- [SET SCHEDULE](../04-basic-scripting/keyword-set-schedule.md) +- [CREATE LEAD](../04-basic-scripting/keywords-lead-scoring.md) +- [Sales CRM Template](../02-architecture-packages/template-crm.md) \ No newline at end of file diff --git a/src/18-appendix-external-services/catalog.md b/src/06-channels/catalog.md similarity index 100% rename from src/18-appendix-external-services/catalog.md rename to src/06-channels/catalog.md diff --git a/src/18-appendix-external-services/channels.md b/src/06-channels/channels.md similarity index 100% rename from src/18-appendix-external-services/channels.md rename to src/06-channels/channels.md diff --git a/src/18-appendix-external-services/console.md b/src/06-channels/console.md similarity index 94% rename from src/18-appendix-external-services/console.md rename to src/06-channels/console.md index b2373536..276806ef 100644 --- a/src/18-appendix-external-services/console.md +++ b/src/06-channels/console.md @@ -110,5 +110,5 @@ tx.send(ProgressUpdate::new("Loading KB...", 50)).await; ## See Also -- [Building from Source](../chapter-07-gbapp/building.md) -- [Bot Configuration](../chapter-08-config/README.md) \ No newline at end of file +- [Building from Source](../02-architecture-packages/building.md) +- [Bot Configuration](../10-configuration-deployment/README.md) \ No newline at end of file diff --git a/src/18-appendix-external-services/directory.md b/src/06-channels/directory.md similarity index 100% rename from src/18-appendix-external-services/directory.md rename to src/06-channels/directory.md diff --git a/src/18-appendix-external-services/hosting-dns.md b/src/06-channels/hosting-dns.md similarity index 98% rename from src/18-appendix-external-services/hosting-dns.md rename to src/06-channels/hosting-dns.md index 735874b1..724de87a 100644 --- a/src/18-appendix-external-services/hosting-dns.md +++ b/src/06-channels/hosting-dns.md @@ -322,4 +322,4 @@ PRINT "Email sent successfully" - [Storage](./storage.md) — S3-compatible storage setup - [Directory](./directory.md) — User authentication - [Channels](./channels.md) — WhatsApp, Telegram, etc. -- [Installation](../chapter-01/installation.md) — Full installation guide \ No newline at end of file +- [Installation](../01-getting-started/installation.md) — Full installation guide \ No newline at end of file diff --git a/src/18-appendix-external-services/llm-providers.md b/src/06-channels/llm-providers.md similarity index 97% rename from src/18-appendix-external-services/llm-providers.md rename to src/06-channels/llm-providers.md index 363dafd4..ec614b6e 100644 --- a/src/18-appendix-external-services/llm-providers.md +++ b/src/06-channels/llm-providers.md @@ -516,7 +516,7 @@ episodic-memory-history,2 episodic-memory-auto-summarize,true ``` -See [Episodic Memory](../chapter-03/episodic-memory.md) for details. +See [Episodic Memory](../03-knowledge-ai/episodic-memory.md) for details. ## Troubleshooting @@ -574,7 +574,7 @@ llm-log-timing,true ## Next Steps -- [config.csv Reference](../chapter-08-config/config-csv.md) — Complete configuration guide -- [Secrets Management](../chapter-08-config/secrets-management.md) — Vault integration -- [Semantic Caching](../chapter-03/caching.md) — Cache configuration +- [config.csv Reference](../10-configuration-deployment/config-csv.md) — Complete configuration guide +- [Secrets Management](../10-configuration-deployment/secrets-management.md) — Vault integration +- [Semantic Caching](../03-knowledge-ai/caching.md) — Cache configuration - [NVIDIA GPU Setup](../appendix-external-services/nvidia.md) — GPU configuration for local models \ No newline at end of file diff --git a/src/18-appendix-external-services/multimodal.md b/src/06-channels/multimodal.md similarity index 97% rename from src/18-appendix-external-services/multimodal.md rename to src/06-channels/multimodal.md index 7ce972d8..2dd5a951 100644 --- a/src/18-appendix-external-services/multimodal.md +++ b/src/06-channels/multimodal.md @@ -140,4 +140,4 @@ if client.is_enabled() { ## See Also - [NVIDIA Module](./nvidia.md) - GPU monitoring -- [PLAY Keyword](../chapter-06-gbdialog/keyword-play.md) - Play generated audio \ No newline at end of file +- [PLAY Keyword](../04-basic-scripting/keyword-play.md) - Play generated audio \ No newline at end of file diff --git a/src/18-appendix-external-services/nvidia.md b/src/06-channels/nvidia.md similarity index 100% rename from src/18-appendix-external-services/nvidia.md rename to src/06-channels/nvidia.md diff --git a/src/06-channels/sms-providers.md b/src/06-channels/sms-providers.md new file mode 100644 index 00000000..cfe06956 --- /dev/null +++ b/src/06-channels/sms-providers.md @@ -0,0 +1 @@ +# SMS Providers diff --git a/src/18-appendix-external-services/storage.md b/src/06-channels/storage.md similarity index 100% rename from src/18-appendix-external-services/storage.md rename to src/06-channels/storage.md diff --git a/src/06-channels/teams-channel.md b/src/06-channels/teams-channel.md new file mode 100644 index 00000000..e68b3552 --- /dev/null +++ b/src/06-channels/teams-channel.md @@ -0,0 +1 @@ +# Teams Channel diff --git a/src/18-appendix-external-services/timeseries.md b/src/06-channels/timeseries.md similarity index 94% rename from src/18-appendix-external-services/timeseries.md rename to src/06-channels/timeseries.md index 795c8737..08227ebc 100644 --- a/src/18-appendix-external-services/timeseries.md +++ b/src/06-channels/timeseries.md @@ -81,5 +81,5 @@ Ports: 8086 (HTTP API), 8083 (RPC) ## See Also -- [Analytics Module](../chapter-04-gbui/apps/analytics.md) +- [Analytics Module](../07-user-interface/apps/analytics.md) - [Observability Setup](./observability.md) \ No newline at end of file diff --git a/src/18-appendix-external-services/weather.md b/src/06-channels/weather.md similarity index 94% rename from src/18-appendix-external-services/weather.md rename to src/06-channels/weather.md index a227f364..d48f9f0a 100644 --- a/src/18-appendix-external-services/weather.md +++ b/src/06-channels/weather.md @@ -307,12 +307,12 @@ If the OpenWeatherMap API is unavailable, the system will: ## Related Keywords -- [GET](../chapter-06-gbdialog/keyword-get.md) - Make custom HTTP requests to weather APIs -- [SET SCHEDULE](../chapter-06-gbdialog/keyword-set-schedule.md) - Schedule regular weather checks -- [SEND MAIL](../chapter-06-gbdialog/keyword-send-mail.md) - Send weather alerts via email -- [SEND SMS](../chapter-06-gbdialog/keyword-sms.md) - Send weather alerts via SMS +- [GET](../04-basic-scripting/keyword-get.md) - Make custom HTTP requests to weather APIs +- [SET SCHEDULE](../04-basic-scripting/keyword-set-schedule.md) - Schedule regular weather checks +- [SEND MAIL](../04-basic-scripting/keyword-send-mail.md) - Send weather alerts via email +- [SEND SMS](../04-basic-scripting/keyword-sms.md) - Send weather alerts via SMS ## See Also - [OpenWeatherMap API Documentation](https://openweathermap.org/api) -- [API Tool Generator](../chapter-06-gbdialog/keyword-use-tool.md) - Create custom weather integrations \ No newline at end of file +- [API Tool Generator](../04-basic-scripting/keyword-use-tool.md) - Create custom weather integrations \ No newline at end of file diff --git a/src/18-appendix-external-services/whatsapp-examples.md b/src/06-channels/whatsapp-examples.md similarity index 100% rename from src/18-appendix-external-services/whatsapp-examples.md rename to src/06-channels/whatsapp-examples.md diff --git a/src/18-appendix-external-services/whatsapp-quick-reference.md b/src/06-channels/whatsapp-quick-reference.md similarity index 100% rename from src/18-appendix-external-services/whatsapp-quick-reference.md rename to src/06-channels/whatsapp-quick-reference.md diff --git a/src/18-appendix-external-services/whatsapp-quick-start.md b/src/06-channels/whatsapp-quick-start.md similarity index 100% rename from src/18-appendix-external-services/whatsapp-quick-start.md rename to src/06-channels/whatsapp-quick-start.md diff --git a/src/18-appendix-external-services/whatsapp-troubleshooting.md b/src/06-channels/whatsapp-troubleshooting.md similarity index 100% rename from src/18-appendix-external-services/whatsapp-troubleshooting.md rename to src/06-channels/whatsapp-troubleshooting.md diff --git a/src/18-appendix-external-services/whatsapp-webhooks.md b/src/06-channels/whatsapp-webhooks.md similarity index 100% rename from src/18-appendix-external-services/whatsapp-webhooks.md rename to src/06-channels/whatsapp-webhooks.md diff --git a/src/07-gbapp/assets/data-flow.svg.backup b/src/07-gbapp/assets/data-flow.svg.backup deleted file mode 100644 index 777aff72..00000000 --- a/src/07-gbapp/assets/data-flow.svg.backup +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BotServer Data Flow Architecture - - - - - User Input Layer - - - - Web UI - - - WhatsApp - - - Teams - - - Email - - - API - - - - - - - - - Core Processing Engine - - - - Session Manager - User Context - - - - BASIC Interpreter - Script Execution - - - - LLM Integration - AI Processing - - - - Knowledge Base - Vector Search - - - - - - - - - Tool System - External APIs & Functions - - - - Cache Layer - Response Optimization - - - - - - - - - Storage & Persistence Layer - - - - Database - User Data - - - - Vector DB - Embeddings - - - - Drive Storage - Files & Assets - - - - Cache - Fast Access - - - - - - - - - - - - - - Data Flow: - - Request/Response - - - Data Access - - - - All components run in async Rust for maximum performance - - - - - \ No newline at end of file diff --git a/src/07-gbapp/assets/module-data-flow.svg.backup b/src/07-gbapp/assets/module-data-flow.svg.backup deleted file mode 100644 index 8ec80c23..00000000 --- a/src/07-gbapp/assets/module-data-flow.svg.backup +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Data Flow Through Modules - - - - User Input - - - - - - - web_server/ | channels/ - Axum HTTP Server - Route to channel - - - - - - - session/ - Load/Create Session - Validate Token - - - - - - - auth/ - Check Permissions - Apply RBAC - - - - - - - bot/ - Route to Bot Instance - Load Configuration - - - - - - - basic/ - Execute BASIC Script - Parse Keywords - - - - - - - - - - - context/ - Load KB - - - - drive/ - Get Files - - - - database/ - Query DB - - - - llm/ - Call AI - - - - - - - - - - - - - Bot Response - - - - - 1. Input Reception - 2. HTTP Routing - 3. Session Management - 4. Authorization - 5. Bot Routing - 6. Script Execution - 7. Data Processing - 8. Response Generation - - - - All operations are async with Tokio runtime for maximum throughput - - - - - \ No newline at end of file diff --git a/src/07-gbapp/assets/module-dependency.svg.backup b/src/07-gbapp/assets/module-dependency.svg.backup deleted file mode 100644 index dbda108a..00000000 --- a/src/07-gbapp/assets/module-dependency.svg.backup +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Module Dependency Graph - - - - main.rs - - - - - - - bootstrap/ - - - - - - - - - - package_manager/ - - - - config/ - - - - database/ - - - - - - - - session/ - - - - web_server/ - - - - - - - - - - - - - - - - - channels/ - - - - bot/ - - - - basic/ - - - - auth/ - - - - - - - - - - llm/ - - - - - - - context/ - - - - Layers: - - - Entry Point - - - Core System - - - Services - - - Features - - - - Arrows indicate compile-time dependencies - - - - - \ No newline at end of file diff --git a/src/07-gbapp/assets/system-architecture.svg.backup b/src/07-gbapp/assets/system-architecture.svg.backup deleted file mode 100644 index 30911ff7..00000000 --- a/src/07-gbapp/assets/system-architecture.svg.backup +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - BotServer Architecture - Virtual Crates System - - - - - - - BotServer Binary - - - - compiles to - - - - - Core Engine (src/core/) - - - - Bootstrap - System Init - Service Start - - - Package Manager - Component Registry - Module Loader - - - Session Manager - Context Handling - State Management - - - Shared State - AppState - Configuration - - - Utils - Helpers - Common - - - - - - - - - - Virtual Crates (gbapp modules in src/) - - - - basic.gbapp - src/basic/ - - • BASIC Interpreter - • Keywords Registry - • Script Execution - • Rhai Engine - - - - channels.gbapp - src/channels/ - - • WhatsApp - • Teams - • Email - • Web UI - - - - storage.gbapp - src/storage/ - - • Knowledge Base - • Drive Integration - • Vector DB - • Cache - - - - your_feature.gbapp - src/your_feature/ - - • Your Keywords - • Your Services - • Your Models - + Add yours! - - - - - - - - - AI & LLM Integration - - - LLM Service - - - Embeddings - - - Semantic Search - - - - - - Persistence Layer - - - Database - - - Vector DB - - - Drive - - - Cache - - - - - Key Concepts: - - - Virtual Crates = Modules in src/ - - - Your Contribution Space - - All compile to single optimized binary - - - - gbapp virtual crates: The bridge between old Node.js packages and new Rust modules - - - - - \ No newline at end of file diff --git a/src/05-gbtheme/README.md b/src/07-user-interface/README.md similarity index 80% rename from src/05-gbtheme/README.md rename to src/07-user-interface/README.md index 3324db3b..6b2cc79d 100644 --- a/src/05-gbtheme/README.md +++ b/src/07-user-interface/README.md @@ -1,6 +1,6 @@ -# Chapter 05: Themes and Styling +# Chapter 7: User Interface -Customize your bot's appearance with `.gbtheme` packages. +Customize your bot's appearance and build complete productivity suites. ## Overview @@ -60,5 +60,5 @@ Create `style.css` in your `.gbtheme` folder: ## See Also -- [UI Reference](../chapter-04-gbui/README.md) - Interface options -- [.gbot Configuration](../chapter-08-config/README.md) - All settings \ No newline at end of file +- [UI Reference](../07-user-interface/README.md) - Interface options +- [.gbot Configuration](../10-configuration-deployment/README.md) - All settings \ No newline at end of file diff --git a/src/04-gbui/admin-user-views.md b/src/07-user-interface/admin-user-views.md similarity index 94% rename from src/04-gbui/admin-user-views.md rename to src/07-user-interface/admin-user-views.md index 232e7f37..e6c30647 100644 --- a/src/04-gbui/admin-user-views.md +++ b/src/07-user-interface/admin-user-views.md @@ -205,7 +205,7 @@ Note: Sync controls (`/files/sync/start`, `/files/sync/stop`) communicate with t ## Related Documentation -- [Permissions Matrix](../chapter-12-auth/permissions-matrix.md) - Detailed permission definitions -- [User Authentication](../chapter-12-auth/user-auth.md) - Login and session management -- [REST Endpoints](../chapter-10-rest/README.md) - Complete API reference +- [Permissions Matrix](../09-security/permissions-matrix.md) - Detailed permission definitions +- [User Authentication](../09-security/user-auth.md) - Login and session management +- [REST Endpoints](../08-rest-api-tools/README.md) - Complete API reference - [Suite User Manual](./suite-manual.md) - End-user guide \ No newline at end of file diff --git a/src/04-gbui/apps/README.md b/src/07-user-interface/apps/README.md similarity index 100% rename from src/04-gbui/apps/README.md rename to src/07-user-interface/apps/README.md diff --git a/src/04-gbui/apps/analytics.md b/src/07-user-interface/apps/analytics.md similarity index 96% rename from src/04-gbui/apps/analytics.md rename to src/07-user-interface/apps/analytics.md index 87f5a19e..409385f6 100644 --- a/src/04-gbui/apps/analytics.md +++ b/src/07-user-interface/apps/analytics.md @@ -334,7 +334,7 @@ Use Analytics in your bot dialogs: ### Query Metrics -```botserver/docs/src/chapter-04-gbui/apps/analytics.basic +```botserver/docs/src/07-user-interface/apps/analytics.basic revenue = GET METRIC "total_revenue" FOR "this month" lastMonth = GET METRIC "total_revenue" FOR "last month" @@ -346,7 +346,7 @@ TALK "Growth: " + FORMAT(growth, "#0.0") + "%" ### Generate Reports -```botserver/docs/src/chapter-04-gbui/apps/analytics-reports.basic +```botserver/docs/src/07-user-interface/apps/analytics-reports.basic HEAR period AS TEXT "Which period? (weekly/monthly/quarterly)" report = GENERATE REPORT "Sales Summary" FOR period @@ -360,7 +360,7 @@ TALK report.summary ### Get AI Insights -```botserver/docs/src/chapter-04-gbui/apps/analytics-insights.basic +```botserver/docs/src/07-user-interface/apps/analytics-insights.basic insights = GET INSIGHTS FOR "Sales Dashboard" TALK "Here are today's insights:" @@ -376,7 +376,7 @@ NEXT ### Create Dashboard Widget -```botserver/docs/src/chapter-04-gbui/apps/analytics-widget.basic +```botserver/docs/src/07-user-interface/apps/analytics-widget.basic widget = NEW OBJECT widget.type = "line_chart" widget.title = "Daily Active Users" @@ -391,7 +391,7 @@ TALK "Widget added successfully" ### Scheduled Reports -```botserver/docs/src/chapter-04-gbui/apps/analytics-scheduled.basic +```botserver/docs/src/07-user-interface/apps/analytics-scheduled.basic ' This dialog runs on a schedule report = GENERATE REPORT "Weekly Metrics" FOR "last 7 days" @@ -412,4 +412,4 @@ LOG "Weekly report sent to " + COUNT(recipients) + " recipients" - [Research App](./research.md) - Deep dive into data questions - [Paper App](./paper.md) - Create reports from insights - [How To: Monitor Your Bot](../how-to/monitor-sessions.md) -- [Talk to Data Template](../../chapter-02/templates.md) \ No newline at end of file +- [Talk to Data Template](../../02-architecture-packages/templates.md) \ No newline at end of file diff --git a/src/04-gbui/apps/billing.md b/src/07-user-interface/apps/billing.md similarity index 100% rename from src/04-gbui/apps/billing.md rename to src/07-user-interface/apps/billing.md diff --git a/src/04-gbui/apps/calendar.md b/src/07-user-interface/apps/calendar.md similarity index 98% rename from src/04-gbui/apps/calendar.md rename to src/07-user-interface/apps/calendar.md index 60abc1d8..a2987b19 100644 --- a/src/04-gbui/apps/calendar.md +++ b/src/07-user-interface/apps/calendar.md @@ -260,4 +260,4 @@ Tasks with due dates automatically appear on your calendar. When you complete a - [Suite Manual](../suite-manual.md) - Complete user guide - [Tasks App](./tasks.md) - Task integration - [Meet App](./meet.md) - Video meetings -- [Calendar API](../../chapter-10-rest/calendar-api.md) - API reference \ No newline at end of file +- [Calendar API](../../08-rest-api-tools/calendar-api.md) - API reference \ No newline at end of file diff --git a/src/07-user-interface/apps/campaigns.md b/src/07-user-interface/apps/campaigns.md new file mode 100644 index 00000000..2ae04890 --- /dev/null +++ b/src/07-user-interface/apps/campaigns.md @@ -0,0 +1 @@ +# Campaigns - Marketing Automation diff --git a/src/04-gbui/apps/chat.md b/src/07-user-interface/apps/chat.md similarity index 100% rename from src/04-gbui/apps/chat.md rename to src/07-user-interface/apps/chat.md diff --git a/src/04-gbui/apps/compliance-api.md b/src/07-user-interface/apps/compliance-api.md similarity index 99% rename from src/04-gbui/apps/compliance-api.md rename to src/07-user-interface/apps/compliance-api.md index 9b1281d3..fd3ca489 100644 --- a/src/04-gbui/apps/compliance-api.md +++ b/src/07-user-interface/apps/compliance-api.md @@ -688,4 +688,4 @@ X-Signature: sha256=... - [Compliance App](./compliance.md) - User interface guide - [How To: Configure Compliance](../how-to/configure-compliance.md) -- [BASIC Compliance Keywords](../../chapter-06-gbdialog/keywords-reference.md) \ No newline at end of file +- [BASIC Compliance Keywords](../../04-basic-scripting/keywords-reference.md) \ No newline at end of file diff --git a/src/04-gbui/apps/compliance.md b/src/07-user-interface/apps/compliance.md similarity index 97% rename from src/04-gbui/apps/compliance.md rename to src/07-user-interface/apps/compliance.md index 99e156f6..fb19a525 100644 --- a/src/04-gbui/apps/compliance.md +++ b/src/07-user-interface/apps/compliance.md @@ -452,7 +452,7 @@ Use Compliance features in your dialogs: ### Check Consent -```botserver/docs/src/chapter-04-gbui/apps/compliance-consent.basic +```botserver/docs/src/07-user-interface/apps/compliance-consent.basic hasConsent = CHECK CONSENT user.id FOR "marketing" IF hasConsent THEN @@ -469,7 +469,7 @@ END IF ### Request Data Access -```botserver/docs/src/chapter-04-gbui/apps/compliance-access.basic +```botserver/docs/src/07-user-interface/apps/compliance-access.basic TALK "I can help you access your personal data." HEAR email AS EMAIL "Please confirm your email address" @@ -488,7 +488,7 @@ END IF ### Delete User Data -```botserver/docs/src/chapter-04-gbui/apps/compliance-delete.basic +```botserver/docs/src/07-user-interface/apps/compliance-delete.basic TALK "Are you sure you want to delete all your data?" TALK "This action cannot be undone." HEAR confirm AS BOOLEAN @@ -507,7 +507,7 @@ END IF ### Log Compliance Event -```botserver/docs/src/chapter-04-gbui/apps/compliance-log.basic +```botserver/docs/src/07-user-interface/apps/compliance-log.basic ' Log when sensitive data is accessed LOG COMPLIANCE EVENT TYPE "data_access" @@ -541,13 +541,13 @@ The Compliance API allows programmatic access to compliance features. All endpoints require API key authentication: -```botserver/docs/src/chapter-04-gbui/apps/compliance-auth.txt +```botserver/docs/src/07-user-interface/apps/compliance-auth.txt Authorization: Bearer your-api-key ``` ### Example: Check User Consent -```botserver/docs/src/chapter-04-gbui/apps/compliance-api-example.json +```botserver/docs/src/07-user-interface/apps/compliance-api-example.json GET /api/compliance/consent/usr_abc123 Response: diff --git a/src/04-gbui/apps/crm.md b/src/07-user-interface/apps/crm.md similarity index 100% rename from src/04-gbui/apps/crm.md rename to src/07-user-interface/apps/crm.md diff --git a/src/04-gbui/apps/dashboards.md b/src/07-user-interface/apps/dashboards.md similarity index 100% rename from src/04-gbui/apps/dashboards.md rename to src/07-user-interface/apps/dashboards.md diff --git a/src/04-gbui/apps/designer.md b/src/07-user-interface/apps/designer.md similarity index 97% rename from src/04-gbui/apps/designer.md rename to src/07-user-interface/apps/designer.md index c84657e0..83a2ea64 100644 --- a/src/04-gbui/apps/designer.md +++ b/src/07-user-interface/apps/designer.md @@ -361,7 +361,7 @@ Designer flows generate BASIC code. You can view and customize it. Right-click any component and select "View Code": -```botserver/docs/src/chapter-04-gbui/apps/designer-generated.basic +```botserver/docs/src/07-user-interface/apps/designer-generated.basic ' Generated from "Customer Support" flow TALK "Hello! How can I help you today?" @@ -384,7 +384,7 @@ END IF Use the **Code** component to add custom BASIC: -```botserver/docs/src/chapter-04-gbui/apps/designer-custom.basic +```botserver/docs/src/07-user-interface/apps/designer-custom.basic ' Custom calculation discount = 0 @@ -404,4 +404,4 @@ finalPrice = orderTotal - discount - [Sources App](./sources.md) - Manage prompts and templates - [Chat App](./chat.md) - Test your flows - [How To: Write Your First Dialog](../how-to/write-first-dialog.md) -- [BASIC Keywords Reference](../../chapter-06-gbdialog/keywords-reference.md) \ No newline at end of file +- [BASIC Keywords Reference](../../04-basic-scripting/keywords-reference.md) \ No newline at end of file diff --git a/src/04-gbui/apps/drive.md b/src/07-user-interface/apps/drive.md similarity index 99% rename from src/04-gbui/apps/drive.md rename to src/07-user-interface/apps/drive.md index e3d3803f..60ac2bca 100644 --- a/src/04-gbui/apps/drive.md +++ b/src/07-user-interface/apps/drive.md @@ -328,4 +328,4 @@ drive-quota-gb,10 - [Admin vs User Views](../admin-user-views.md) - Permission levels - [Chat App](./chat.md) - Upload files via chat - [Player App](./player.md) - View files in Player -- [Storage API](../../chapter-10-rest/storage-api.md) - API reference \ No newline at end of file +- [Storage API](../../08-rest-api-tools/storage-api.md) - API reference \ No newline at end of file diff --git a/src/04-gbui/apps/mail.md b/src/07-user-interface/apps/mail.md similarity index 98% rename from src/04-gbui/apps/mail.md rename to src/07-user-interface/apps/mail.md index 52d0e599..506a7a4e 100644 --- a/src/04-gbui/apps/mail.md +++ b/src/07-user-interface/apps/mail.md @@ -309,5 +309,5 @@ email-from,Your Name - [Suite Manual](../suite-manual.md) - Complete user guide - [Chat App](./chat.md) - Send quick emails via chat -- [Email API](../../chapter-10-rest/email-api.md) - API reference -- [SEND MAIL Keyword](../../chapter-06-gbdialog/keyword-send-mail.md) - BASIC integration \ No newline at end of file +- [Email API](../../08-rest-api-tools/email-api.md) - API reference +- [SEND MAIL Keyword](../../04-basic-scripting/keyword-send-mail.md) - BASIC integration \ No newline at end of file diff --git a/src/04-gbui/apps/meet.md b/src/07-user-interface/apps/meet.md similarity index 99% rename from src/04-gbui/apps/meet.md rename to src/07-user-interface/apps/meet.md index 85f0f33e..ece91e03 100644 --- a/src/04-gbui/apps/meet.md +++ b/src/07-user-interface/apps/meet.md @@ -313,4 +313,4 @@ Allow browser access to: - [Suite Manual](../suite-manual.md) - Complete user guide - [Calendar App](./calendar.md) - Schedule meetings - [Chat App](./chat.md) - Quick calls from chat -- [Calls API](../../chapter-10-rest/calls-api.md) - API reference \ No newline at end of file +- [Calls API](../../08-rest-api-tools/calls-api.md) - API reference \ No newline at end of file diff --git a/src/04-gbui/apps/paper.md b/src/07-user-interface/apps/paper.md similarity index 97% rename from src/04-gbui/apps/paper.md rename to src/07-user-interface/apps/paper.md index a4c4d73b..30c6d8a7 100644 --- a/src/04-gbui/apps/paper.md +++ b/src/07-user-interface/apps/paper.md @@ -489,7 +489,7 @@ Control Paper from your bot dialogs: ### Create a Document -```botserver/docs/src/chapter-04-gbui/apps/paper-create.basic +```botserver/docs/src/07-user-interface/apps/paper-create.basic doc = CREATE DOCUMENT "Project Notes" doc.content = "Meeting notes from " + TODAY @@ -499,7 +499,7 @@ TALK "Document created: " + doc.id ### Generate Content with AI -```botserver/docs/src/chapter-04-gbui/apps/paper-generate.basic +```botserver/docs/src/07-user-interface/apps/paper-generate.basic HEAR topic AS TEXT "What should I write about?" content = GENERATE TEXT "Write a brief introduction about " + topic @@ -515,7 +515,7 @@ TALK LEFT(content, 200) + "..." ### Export a Document -```botserver/docs/src/chapter-04-gbui/apps/paper-export.basic +```botserver/docs/src/07-user-interface/apps/paper-export.basic HEAR docName AS TEXT "Which document should I export?" doc = FIND DOCUMENT docName @@ -531,7 +531,7 @@ END IF ### Search Documents -```botserver/docs/src/chapter-04-gbui/apps/paper-search.basic +```botserver/docs/src/07-user-interface/apps/paper-search.basic HEAR query AS TEXT "What are you looking for?" results = SEARCH DOCUMENTS query @@ -548,7 +548,7 @@ END IF ### Summarize a Document -```botserver/docs/src/chapter-04-gbui/apps/paper-summarize.basic +```botserver/docs/src/07-user-interface/apps/paper-summarize.basic HEAR docName AS TEXT "Which document should I summarize?" doc = FIND DOCUMENT docName diff --git a/src/04-gbui/apps/player.md b/src/07-user-interface/apps/player.md similarity index 97% rename from src/04-gbui/apps/player.md rename to src/07-user-interface/apps/player.md index a153600c..6993c3d9 100644 --- a/src/04-gbui/apps/player.md +++ b/src/07-user-interface/apps/player.md @@ -269,5 +269,5 @@ Player is fully responsive: ## See Also - [Drive App](./drive.md) - File management -- [Drive Integration](../../chapter-08-config/drive.md) - File storage configuration -- [Storage API](../../chapter-10-rest/storage-api.md) - File management API \ No newline at end of file +- [Drive Integration](../../10-configuration-deployment/drive.md) - File storage configuration +- [Storage API](../../08-rest-api-tools/storage-api.md) - File management API \ No newline at end of file diff --git a/src/04-gbui/apps/products.md b/src/07-user-interface/apps/products.md similarity index 100% rename from src/04-gbui/apps/products.md rename to src/07-user-interface/apps/products.md diff --git a/src/04-gbui/apps/research.md b/src/07-user-interface/apps/research.md similarity index 96% rename from src/04-gbui/apps/research.md rename to src/07-user-interface/apps/research.md index 3bde1a1c..c2f27942 100644 --- a/src/04-gbui/apps/research.md +++ b/src/07-user-interface/apps/research.md @@ -317,7 +317,7 @@ Use Research in your bot dialogs: ### Basic Search -```botserver/docs/src/chapter-04-gbui/apps/research-basic.basic +```botserver/docs/src/07-user-interface/apps/research-basic.basic HEAR question AS TEXT "What would you like to know?" result = SEARCH question @@ -332,7 +332,7 @@ NEXT ### Search Specific Sources -```botserver/docs/src/chapter-04-gbui/apps/research-sources.basic +```botserver/docs/src/07-user-interface/apps/research-sources.basic ' Search only documents result = SEARCH "vacation policy" IN "documents" @@ -345,7 +345,7 @@ result = SEARCH "product specs" IN "products.gbkb" ### Research with Follow-up -```botserver/docs/src/chapter-04-gbui/apps/research-followup.basic +```botserver/docs/src/07-user-interface/apps/research-followup.basic TALK "What would you like to research?" HEAR topic AS TEXT @@ -365,7 +365,7 @@ TALK "Research complete!" ### Export Research -```botserver/docs/src/chapter-04-gbui/apps/research-export.basic +```botserver/docs/src/07-user-interface/apps/research-export.basic HEAR query AS TEXT "What should I research?" result = SEARCH query @@ -384,7 +384,7 @@ TALK "Research saved to Paper" ### Automated Research Report -```botserver/docs/src/chapter-04-gbui/apps/research-report.basic +```botserver/docs/src/07-user-interface/apps/research-report.basic topics = ["market trends", "competitor analysis", "customer feedback"] report = "" diff --git a/src/04-gbui/apps/sources.md b/src/07-user-interface/apps/sources.md similarity index 98% rename from src/04-gbui/apps/sources.md rename to src/07-user-interface/apps/sources.md index 351eb2b3..8bee7071 100644 --- a/src/04-gbui/apps/sources.md +++ b/src/07-user-interface/apps/sources.md @@ -4,7 +4,7 @@ --- -Sources Interface +Sources Interface ## Overview diff --git a/src/04-gbui/apps/suite.md b/src/07-user-interface/apps/suite.md similarity index 98% rename from src/04-gbui/apps/suite.md rename to src/07-user-interface/apps/suite.md index 4231fce5..1e993a5c 100644 --- a/src/04-gbui/apps/suite.md +++ b/src/07-user-interface/apps/suite.md @@ -221,4 +221,4 @@ suite-sidebar-collapsed,false - [Drive App](./drive.md) - File management - [Tasks App](./tasks.md) - Task management - [HTMX Architecture](../htmx-architecture.md) - Technical details -- [Theme Customization](../../chapter-05-gbtheme/README.md) - Styling +- [Theme Customization](../../07-user-interface-gbtheme/README.md) - Styling diff --git a/src/04-gbui/apps/tasks.md b/src/07-user-interface/apps/tasks.md similarity index 100% rename from src/04-gbui/apps/tasks.md rename to src/07-user-interface/apps/tasks.md diff --git a/src/04-gbui/apps/tickets.md b/src/07-user-interface/apps/tickets.md similarity index 100% rename from src/04-gbui/apps/tickets.md rename to src/07-user-interface/apps/tickets.md diff --git a/src/04-gbui/console-mode.md b/src/07-user-interface/console-mode.md similarity index 100% rename from src/04-gbui/console-mode.md rename to src/07-user-interface/console-mode.md diff --git a/src/05-gbtheme/css.md b/src/07-user-interface/css.md similarity index 97% rename from src/05-gbtheme/css.md rename to src/07-user-interface/css.md index bbbe6dae..c8a3cfa7 100644 --- a/src/05-gbtheme/css.md +++ b/src/07-user-interface/css.md @@ -419,9 +419,9 @@ Consistent button styling: ## See Also - [Theme Structure](./structure.md) - File organization -- [Chapter 4: User Interface](../chapter-04-gbui/README.md) - Applying themes to templates -- [Chapter 6: BASIC](../chapter-06-gbdialog/README.md) - Dynamic theme switching +- [Chapter 4: User Interface](../07-user-interface/README.md) - Applying themes to templates +- [Chapter 6: BASIC](../04-basic-scripting/README.md) - Dynamic theme switching ## Next Step -Return to [Chapter 5 Overview](./README.md) or continue to [Chapter 6: BASIC Dialogs](../chapter-06-gbdialog/README.md). +Return to [Chapter 5 Overview](./README.md) or continue to [Chapter 6: BASIC Dialogs](../04-basic-scripting/README.md). diff --git a/src/04-gbui/dev-chat.md b/src/07-user-interface/dev-chat.md similarity index 98% rename from src/04-gbui/dev-chat.md rename to src/07-user-interface/dev-chat.md index ca012627..6a7e98a7 100644 --- a/src/04-gbui/dev-chat.md +++ b/src/07-user-interface/dev-chat.md @@ -240,4 +240,4 @@ The dev chat widget: - [Autonomous Tasks](../17-autonomous-tasks/README.md) - How apps are generated - [HTMX Architecture](./htmx-architecture.md) - Frontend patterns -- [REST API](../10-rest/README.md) - API reference \ No newline at end of file +- [REST API](../08-rest-api-tools/README.md) - API reference \ No newline at end of file diff --git a/src/04-gbui/how-to/README.md b/src/07-user-interface/how-to/README.md similarity index 100% rename from src/04-gbui/how-to/README.md rename to src/07-user-interface/how-to/README.md diff --git a/src/04-gbui/how-to/add-kb-documents.md b/src/07-user-interface/how-to/add-kb-documents.md similarity index 98% rename from src/04-gbui/how-to/add-kb-documents.md rename to src/07-user-interface/how-to/add-kb-documents.md index d78b9d80..e817354c 100644 --- a/src/04-gbui/how-to/add-kb-documents.md +++ b/src/07-user-interface/how-to/add-kb-documents.md @@ -6,7 +6,7 @@ --- -Add Documents to KB - 4 Step Process +Add Documents to KB - 4 Step Process --- @@ -40,7 +40,7 @@ Before you begin, make sure you have: A **Knowledge Base (KB)** is a collection of documents that your bot uses to answer questions. When a user asks something, the bot searches through these documents to find relevant information. -Knowledge Base Semantic Search Flow +Knowledge Base Semantic Search Flow --- diff --git a/src/04-gbui/how-to/connect-whatsapp.md b/src/07-user-interface/how-to/connect-whatsapp.md similarity index 99% rename from src/04-gbui/how-to/connect-whatsapp.md rename to src/07-user-interface/how-to/connect-whatsapp.md index d27ce68f..e013031c 100644 --- a/src/04-gbui/how-to/connect-whatsapp.md +++ b/src/07-user-interface/how-to/connect-whatsapp.md @@ -6,7 +6,7 @@ --- -Connect WhatsApp - 4 Step Process +Connect WhatsApp - 4 Step Process --- @@ -39,7 +39,7 @@ Before you begin, make sure you have: ## Understanding WhatsApp Integration -WhatsApp Integration Flow +WhatsApp Integration Flow --- @@ -698,4 +698,4 @@ whatsapp-business-account-id,987654321098765 - [Chat App](../apps/chat.md) - Web chat interface - [Sources App](../apps/sources.md) - Bot configuration - [Compliance App](../apps/compliance.md) - Data privacy for WhatsApp -- [BASIC Keywords](../../chapter-06-gbdialog/keywords-reference.md) - WhatsApp-specific keywords \ No newline at end of file +- [BASIC Keywords](../../04-basic-scripting/keywords-reference.md) - WhatsApp-specific keywords \ No newline at end of file diff --git a/src/04-gbui/how-to/create-first-bot.md b/src/07-user-interface/how-to/create-first-bot.md similarity index 100% rename from src/04-gbui/how-to/create-first-bot.md rename to src/07-user-interface/how-to/create-first-bot.md diff --git a/src/04-gbui/how-to/monitor-sessions.md b/src/07-user-interface/how-to/monitor-sessions.md similarity index 100% rename from src/04-gbui/how-to/monitor-sessions.md rename to src/07-user-interface/how-to/monitor-sessions.md diff --git a/src/04-gbui/how-to/write-first-dialog.md b/src/07-user-interface/how-to/write-first-dialog.md similarity index 100% rename from src/04-gbui/how-to/write-first-dialog.md rename to src/07-user-interface/how-to/write-first-dialog.md diff --git a/src/04-gbui/htmx-architecture.md b/src/07-user-interface/htmx-architecture.md similarity index 100% rename from src/04-gbui/htmx-architecture.md rename to src/07-user-interface/htmx-architecture.md diff --git a/src/04-gbui/monitoring.md b/src/07-user-interface/monitoring.md similarity index 100% rename from src/04-gbui/monitoring.md rename to src/07-user-interface/monitoring.md diff --git a/src/04-gbui/single-gbui.md b/src/07-user-interface/single-gbui.md similarity index 95% rename from src/04-gbui/single-gbui.md rename to src/07-user-interface/single-gbui.md index 9b2a635a..7e2dadec 100644 --- a/src/04-gbui/single-gbui.md +++ b/src/07-user-interface/single-gbui.md @@ -165,8 +165,8 @@ The interface works on all modern browsers including Chrome 90+, Firefox 88+, Sa - [default.gbui](./default-gbui.md) - Full-featured interface - [Console Mode](./console-mode.md) - Terminal interface -- [Chapter 5: Themes](../chapter-05-gbtheme/README.md) - Custom styling -- [Chapter 6: BASIC](../chapter-06-gbdialog/README.md) - Dialog scripting +- [Chapter 5: Themes](../07-user-interface-gbtheme/README.md) - Custom styling +- [Chapter 6: BASIC](../04-basic-scripting/README.md) - Dialog scripting ## Next Step diff --git a/src/05-gbtheme/structure.md b/src/07-user-interface/structure.md similarity index 97% rename from src/05-gbtheme/structure.md rename to src/07-user-interface/structure.md index b0f35a3a..54972c07 100644 --- a/src/05-gbtheme/structure.md +++ b/src/07-user-interface/structure.md @@ -217,8 +217,8 @@ Remember: The UI is just HTML/CSS/JS talking to the bot via WebSocket. You have ## See Also - [CSS Customization](./css.md) - Detailed CSS guide -- [Chapter 4: User Interface](../chapter-04-gbui/README.md) - UI templates -- [Chapter 6: BASIC](../chapter-06-gbdialog/README.md) - Theme switching in dialogs +- [Chapter 4: User Interface](../07-user-interface/README.md) - UI templates +- [Chapter 6: BASIC](../04-basic-scripting/README.md) - Theme switching in dialogs - [GitHub Repository](https://github.com/GeneralBots/botserver) - Contribute to the project ## Next Step diff --git a/src/04-gbui/suite-manual.md b/src/07-user-interface/suite-manual.md similarity index 93% rename from src/04-gbui/suite-manual.md rename to src/07-user-interface/suite-manual.md index 70d1d682..e29b3eb7 100644 --- a/src/04-gbui/suite-manual.md +++ b/src/07-user-interface/suite-manual.md @@ -30,7 +30,7 @@ General Bots Suite is your all-in-one workspace that combines communication, pro When the Suite opens, you see: -Suite Main Layout +Suite Main Layout ### The Apps Menu @@ -125,7 +125,7 @@ Drive is your file storage - like Google Drive or OneDrive. Store documents, ima ### The Drive Interface -Drive Interface +Drive Interface ### Creating and Uploading @@ -187,7 +187,7 @@ Tasks revolutionizes how you work. Instead of manually tracking to-do items, you ### The Tasks Interface -Tasks Interface +Tasks Interface ### Creating an Task @@ -263,7 +263,7 @@ Mail connects to your email accounts so you can read, write, and organize emails ### The Mail Interface -Mail Interface +Mail Interface ### Reading Email @@ -329,7 +329,7 @@ Calendar shows your schedule, meetings, and events. Plan your day, week, or mont ### The Calendar Interface -Calendar Interface +Calendar Interface ### Creating an Event @@ -404,7 +404,7 @@ Bot: Meeting scheduled: ### The Meeting Interface -Meet Interface +Meet Interface ### Meeting Controls @@ -466,7 +466,7 @@ Paper is your writing space with AI assistance. Write documents, notes, reports ### The Paper Interface -Paper Interface +Paper Interface ### Creating a Document @@ -533,7 +533,7 @@ Research is like having a research assistant. Search the web, your documents, an ### The Research Interface -Research Interface +Research Interface ### Search Modes @@ -584,7 +584,7 @@ Analytics shows you reports about usage, conversations, and performance. Underst ### The Analytics Interface -Analytics Interface +Analytics Interface ### Key Metrics @@ -623,7 +623,7 @@ Designer lets you create bot conversations visually. Drag and drop blocks to bui ### The Designer Interface -Designer Interface +Designer Interface ### Building a Dialog @@ -692,7 +692,7 @@ Sources is your library of prompts, templates, tools, and AI models. Find and us ### The Sources Interface -Sources Interface +Sources Interface ### Tabs Explained @@ -734,7 +734,7 @@ Sources is your library of prompts, templates, tools, and AI models. Find and us ### Compliance Scanner -Compliance Scanner Interface +Compliance Scanner Interface **What It Checks:** - Hardcoded passwords @@ -923,4 +923,4 @@ You: Help me with tasks *© General Bots - Built with ❤️ and AI* -*For the latest documentation, visit the [online manual](../chapter-04-gbui/README.md)* \ No newline at end of file +*For the latest documentation, visit the [online manual](../07-user-interface/README.md)* \ No newline at end of file diff --git a/src/04-gbui/ui-structure.md b/src/07-user-interface/ui-structure.md similarity index 100% rename from src/04-gbui/ui-structure.md rename to src/07-user-interface/ui-structure.md diff --git a/src/10-rest/README.md b/src/08-rest-api-tools/README.md similarity index 89% rename from src/10-rest/README.md rename to src/08-rest-api-tools/README.md index 458e104c..e4def05c 100644 --- a/src/10-rest/README.md +++ b/src/08-rest-api-tools/README.md @@ -1,4 +1,4 @@ -# Chapter 10: REST Endpoints +# Chapter 8: REST API & Tools HTTP API endpoints for integrating with botserver. @@ -81,6 +81,6 @@ curl -X POST http://localhost:8000/api/v1/chat \ ## See Also -- [LLM Tools](../chapter-09-tools/README.md) - Tool definitions -- [Authentication](../chapter-12-auth/README.md) - Security -- [Permissions Matrix](../chapter-12-auth/permissions-matrix.md) - Access control \ No newline at end of file +- [LLM Tools](../08-rest-api-tools/README.md) - Tool definitions +- [Authentication](../09-security/README.md) - Security +- [Permissions Matrix](../09-security/permissions-matrix.md) - Access control \ No newline at end of file diff --git a/src/10-rest/admin-api.md b/src/08-rest-api-tools/admin-api.md similarity index 100% rename from src/10-rest/admin-api.md rename to src/08-rest-api-tools/admin-api.md diff --git a/src/10-rest/ai-api.md b/src/08-rest-api-tools/ai-api.md similarity index 100% rename from src/10-rest/ai-api.md rename to src/08-rest-api-tools/ai-api.md diff --git a/src/10-rest/analytics-api.md b/src/08-rest-api-tools/analytics-api.md similarity index 100% rename from src/10-rest/analytics-api.md rename to src/08-rest-api-tools/analytics-api.md diff --git a/src/10-rest/assets/api-architecture.svg.backup b/src/08-rest-api-tools/assets/api-architecture.svg.backup similarity index 100% rename from src/10-rest/assets/api-architecture.svg.backup rename to src/08-rest-api-tools/assets/api-architecture.svg.backup diff --git a/src/10-rest/assets/api-request-flow.svg.backup b/src/08-rest-api-tools/assets/api-request-flow.svg.backup similarity index 100% rename from src/10-rest/assets/api-request-flow.svg.backup rename to src/08-rest-api-tools/assets/api-request-flow.svg.backup diff --git a/src/10-rest/backup-api.md b/src/08-rest-api-tools/backup-api.md similarity index 100% rename from src/10-rest/backup-api.md rename to src/08-rest-api-tools/backup-api.md diff --git a/src/10-rest/calendar-api.md b/src/08-rest-api-tools/calendar-api.md similarity index 100% rename from src/10-rest/calendar-api.md rename to src/08-rest-api-tools/calendar-api.md diff --git a/src/10-rest/calls-api.md b/src/08-rest-api-tools/calls-api.md similarity index 100% rename from src/10-rest/calls-api.md rename to src/08-rest-api-tools/calls-api.md diff --git a/src/09-tools/compilation.md b/src/08-rest-api-tools/compilation.md similarity index 100% rename from src/09-tools/compilation.md rename to src/08-rest-api-tools/compilation.md diff --git a/src/10-rest/compliance-api.md b/src/08-rest-api-tools/compliance-api.md similarity index 100% rename from src/10-rest/compliance-api.md rename to src/08-rest-api-tools/compliance-api.md diff --git a/src/10-rest/conversations-api.md b/src/08-rest-api-tools/conversations-api.md similarity index 94% rename from src/10-rest/conversations-api.md rename to src/08-rest-api-tools/conversations-api.md index ca76c0de..a0573062 100644 --- a/src/10-rest/conversations-api.md +++ b/src/08-rest-api-tools/conversations-api.md @@ -214,6 +214,6 @@ CREATE TABLE message_history ( ## See Also -- [Sessions and Channels](../chapter-01/sessions.md) - Session management -- [TALK Keyword](../chapter-06-gbdialog/keyword-talk.md) - Sending messages from BASIC -- [HEAR Keyword](../chapter-06-gbdialog/keyword-hear.md) - Receiving user input \ No newline at end of file +- [Sessions and Channels](../01-getting-started/sessions.md) - Session management +- [TALK Keyword](../04-basic-scripting/keyword-talk.md) - Sending messages from BASIC +- [HEAR Keyword](../04-basic-scripting/keyword-hear.md) - Receiving user input \ No newline at end of file diff --git a/src/10-rest/document-processing.md b/src/08-rest-api-tools/document-processing.md similarity index 99% rename from src/10-rest/document-processing.md rename to src/08-rest-api-tools/document-processing.md index f584a5f1..6e62e84c 100644 --- a/src/10-rest/document-processing.md +++ b/src/08-rest-api-tools/document-processing.md @@ -553,4 +553,4 @@ print(text_response.json()['text']) - [Storage API](./storage-api.md) - Document storage - [ML API](./ml-api.md) - Advanced text analysis -- [Knowledge Base API](../chapter-03/kb-and-tools.md) - Document indexing \ No newline at end of file +- [Knowledge Base API](../03-knowledge-ai/kb-and-tools.md) - Document indexing \ No newline at end of file diff --git a/src/10-rest/email-api.md b/src/08-rest-api-tools/email-api.md similarity index 97% rename from src/10-rest/email-api.md rename to src/08-rest-api-tools/email-api.md index 9891cf97..fc9bb964 100644 --- a/src/10-rest/email-api.md +++ b/src/08-rest-api-tools/email-api.md @@ -593,7 +593,7 @@ CREATE TABLE sent_email_tracking ( ## See Also -- [SEND MAIL Keyword](../chapter-06-gbdialog/keyword-send-mail.md) - BASIC email -- [CREATE DRAFT Keyword](../chapter-06-gbdialog/keyword-create-draft.md) - Draft creation +- [SEND MAIL Keyword](../04-basic-scripting/keyword-send-mail.md) - BASIC email +- [CREATE DRAFT Keyword](../04-basic-scripting/keyword-create-draft.md) - Draft creation - [External Services](../appendix-external-services/README.md) - Service configuration -- [Configuration Parameters](../chapter-08-config/parameters.md) - email-read-pixel setting \ No newline at end of file +- [Configuration Parameters](../10-configuration-deployment/parameters.md) - email-read-pixel setting \ No newline at end of file diff --git a/src/10-rest/examples.md b/src/08-rest-api-tools/examples.md similarity index 100% rename from src/10-rest/examples.md rename to src/08-rest-api-tools/examples.md diff --git a/src/09-tools/external-apis.md b/src/08-rest-api-tools/external-apis.md similarity index 100% rename from src/09-tools/external-apis.md rename to src/08-rest-api-tools/external-apis.md diff --git a/src/10-rest/files-api.md b/src/08-rest-api-tools/files-api.md similarity index 100% rename from src/10-rest/files-api.md rename to src/08-rest-api-tools/files-api.md diff --git a/src/09-tools/get-integration.md b/src/08-rest-api-tools/get-integration.md similarity index 100% rename from src/09-tools/get-integration.md rename to src/08-rest-api-tools/get-integration.md diff --git a/src/10-rest/group-membership.md b/src/08-rest-api-tools/group-membership.md similarity index 100% rename from src/10-rest/group-membership.md rename to src/08-rest-api-tools/group-membership.md diff --git a/src/10-rest/groups-api.md b/src/08-rest-api-tools/groups-api.md similarity index 100% rename from src/10-rest/groups-api.md rename to src/08-rest-api-tools/groups-api.md diff --git a/src/09-tools/llm-rest-server.md b/src/08-rest-api-tools/llm-rest-server.md similarity index 100% rename from src/09-tools/llm-rest-server.md rename to src/08-rest-api-tools/llm-rest-server.md diff --git a/src/09-tools/mcp-format.md b/src/08-rest-api-tools/mcp-format.md similarity index 100% rename from src/09-tools/mcp-format.md rename to src/08-rest-api-tools/mcp-format.md diff --git a/src/10-rest/ml-api.md b/src/08-rest-api-tools/ml-api.md similarity index 100% rename from src/10-rest/ml-api.md rename to src/08-rest-api-tools/ml-api.md diff --git a/src/10-rest/monitoring-api.md b/src/08-rest-api-tools/monitoring-api.md similarity index 100% rename from src/10-rest/monitoring-api.md rename to src/08-rest-api-tools/monitoring-api.md diff --git a/src/10-rest/notifications-api.md b/src/08-rest-api-tools/notifications-api.md similarity index 98% rename from src/10-rest/notifications-api.md rename to src/08-rest-api-tools/notifications-api.md index b90de63d..4f160e31 100644 --- a/src/10-rest/notifications-api.md +++ b/src/08-rest-api-tools/notifications-api.md @@ -486,5 +486,5 @@ curl -X POST \ ## Related APIs - [User API](./user-security.md) - User management -- [WebSocket API](../chapter-04/web-interface.md) - Real-time notifications +- [WebSocket API](../07-user-interface/web-interface.md) - Real-time notifications - [Email API](./keyword-send-mail.md) - Email notifications \ No newline at end of file diff --git a/src/09-tools/nvidia-gpu-setup.md b/src/08-rest-api-tools/nvidia-gpu-setup.md similarity index 98% rename from src/09-tools/nvidia-gpu-setup.md rename to src/08-rest-api-tools/nvidia-gpu-setup.md index 734c84f9..f1dbdb6d 100644 --- a/src/09-tools/nvidia-gpu-setup.md +++ b/src/08-rest-api-tools/nvidia-gpu-setup.md @@ -284,4 +284,4 @@ With GPU acceleration enabled: - [Installation Guide](./installation.md) - Complete botserver setup - [Quick Start](./quick-start.md) - Create your first bot -- [Configuration Reference](../chapter-02/gbot.md) - All GPU-related parameters \ No newline at end of file +- [Configuration Reference](../02-architecture-packages/gbot.md) - All GPU-related parameters \ No newline at end of file diff --git a/src/09-tools/openai-format.md b/src/08-rest-api-tools/openai-format.md similarity index 100% rename from src/09-tools/openai-format.md rename to src/08-rest-api-tools/openai-format.md diff --git a/src/10-rest/opensource-components.md b/src/08-rest-api-tools/opensource-components.md similarity index 100% rename from src/10-rest/opensource-components.md rename to src/08-rest-api-tools/opensource-components.md diff --git a/src/09-tools/param-declaration.md b/src/08-rest-api-tools/param-declaration.md similarity index 100% rename from src/09-tools/param-declaration.md rename to src/08-rest-api-tools/param-declaration.md diff --git a/src/10-rest/reports-api.md b/src/08-rest-api-tools/reports-api.md similarity index 100% rename from src/10-rest/reports-api.md rename to src/08-rest-api-tools/reports-api.md diff --git a/src/10-rest/security-api.md b/src/08-rest-api-tools/security-api.md similarity index 100% rename from src/10-rest/security-api.md rename to src/08-rest-api-tools/security-api.md diff --git a/src/10-rest/storage-api.md b/src/08-rest-api-tools/storage-api.md similarity index 100% rename from src/10-rest/storage-api.md rename to src/08-rest-api-tools/storage-api.md diff --git a/src/10-rest/tasks-api.md b/src/08-rest-api-tools/tasks-api.md similarity index 100% rename from src/10-rest/tasks-api.md rename to src/08-rest-api-tools/tasks-api.md diff --git a/src/09-tools/tool-definition.md b/src/08-rest-api-tools/tool-definition.md similarity index 100% rename from src/09-tools/tool-definition.md rename to src/08-rest-api-tools/tool-definition.md diff --git a/src/10-rest/user-security.md b/src/08-rest-api-tools/user-security.md similarity index 98% rename from src/10-rest/user-security.md rename to src/08-rest-api-tools/user-security.md index c69cfb6b..33832d1c 100644 --- a/src/10-rest/user-security.md +++ b/src/08-rest-api-tools/user-security.md @@ -637,6 +637,6 @@ Revoke an API key. ## Related APIs -- [Authentication](../chapter-11/authentication.md) - Auth details +- [Authentication](../09-security.md) - Auth details - [Audit Logs](./monitoring-api.md) - System monitoring - [Notifications](./notifications-api.md) - Security alerts \ No newline at end of file diff --git a/src/10-rest/users-api.md b/src/08-rest-api-tools/users-api.md similarity index 97% rename from src/10-rest/users-api.md rename to src/08-rest-api-tools/users-api.md index 2cb9e102..1a36009e 100644 --- a/src/10-rest/users-api.md +++ b/src/08-rest-api-tools/users-api.md @@ -445,7 +445,7 @@ END IF ## See Also -- [User Authentication](../chapter-12-auth/user-auth.md) - Auth details -- [Permissions Matrix](../chapter-12-auth/permissions-matrix.md) - Access control +- [User Authentication](../09-security/user-auth.md) - Auth details +- [Permissions Matrix](../09-security/permissions-matrix.md) - Access control - [Groups API](./groups-api.md) - Group management -- [SET USER Keyword](../chapter-06-gbdialog/keyword-set-user.md) - BASIC user context \ No newline at end of file +- [SET USER Keyword](../04-basic-scripting/keyword-set-user.md) - BASIC user context \ No newline at end of file diff --git a/src/10-rest/whiteboard-api.md b/src/08-rest-api-tools/whiteboard-api.md similarity index 100% rename from src/10-rest/whiteboard-api.md rename to src/08-rest-api-tools/whiteboard-api.md diff --git a/src/23-security/README.md b/src/09-security/README.md similarity index 90% rename from src/23-security/README.md rename to src/09-security/README.md index 81630c26..b943bfb0 100644 --- a/src/23-security/README.md +++ b/src/09-security/README.md @@ -1,6 +1,6 @@ -# Advanced Security +# Chapter 9: Security -This chapter covers advanced security topics for General Bots, including Role-Based Access Control (RBAC), organization multi-tenancy, knowledge base security, and compliance requirements. +This chapter covers advanced security topics for General Bots. ## Overview @@ -79,9 +79,9 @@ These permissions are enforced during vector search, ensuring users only see con ## Quick Links -- [Authentication & Permissions](../12-auth/README.md) - Basic auth setup -- [API Security](../10-rest/authentication.md) - API authentication -- [Subscription & Billing](../22-white-label/billing.md) - Plan-based access control +- [Authentication & Permissions](../09-security/README.md) - Basic auth setup +- [API Security](../08-rest-api-tools/authentication.md) - API authentication +- [Subscription & Billing](../12-ecosystem-reference/billing.md) - Plan-based access control ## Best Practices diff --git a/src/12-auth/api-endpoints.md b/src/09-security/api-endpoints.md similarity index 100% rename from src/12-auth/api-endpoints.md rename to src/09-security/api-endpoints.md diff --git a/src/12-auth/bot-auth.md b/src/09-security/bot-auth.md similarity index 100% rename from src/12-auth/bot-auth.md rename to src/09-security/bot-auth.md diff --git a/src/12-auth/compliance-requirements.md b/src/09-security/compliance-requirements.md similarity index 100% rename from src/12-auth/compliance-requirements.md rename to src/09-security/compliance-requirements.md diff --git a/src/09-security/endpoint-checklist.md b/src/09-security/endpoint-checklist.md new file mode 100644 index 00000000..bb6929c3 --- /dev/null +++ b/src/09-security/endpoint-checklist.md @@ -0,0 +1 @@ +# Endpoint Security Checklist diff --git a/src/12-auth/initial-setup.md b/src/09-security/initial-setup.md similarity index 100% rename from src/12-auth/initial-setup.md rename to src/09-security/initial-setup.md diff --git a/src/23-security/kb-permissions.md b/src/09-security/kb-permissions.md similarity index 100% rename from src/23-security/kb-permissions.md rename to src/09-security/kb-permissions.md diff --git a/src/23-security/kb-security.md b/src/09-security/kb-security.md similarity index 100% rename from src/23-security/kb-security.md rename to src/09-security/kb-security.md diff --git a/src/23-security/organizations.md b/src/09-security/organizations.md similarity index 98% rename from src/23-security/organizations.md rename to src/09-security/organizations.md index 7227fc48..3a067760 100644 --- a/src/23-security/organizations.md +++ b/src/09-security/organizations.md @@ -438,6 +438,6 @@ Set up alerts for quota usage: ## Related Topics - [RBAC Configuration](./rbac-configuration.md) -- [Subscription & Billing](../22-white-label/billing.md) +- [Subscription & Billing](../12-ecosystem-reference/billing.md) - [Security Matrix](./security-matrix.md) - [SOC 2 Compliance](./soc2-compliance.md) \ No newline at end of file diff --git a/src/12-auth/password-security.md b/src/09-security/password-security.md similarity index 100% rename from src/12-auth/password-security.md rename to src/09-security/password-security.md diff --git a/src/12-auth/permissions-compliance.md b/src/09-security/permissions-compliance.md similarity index 100% rename from src/12-auth/permissions-compliance.md rename to src/09-security/permissions-compliance.md diff --git a/src/12-auth/permissions-matrix.md b/src/09-security/permissions-matrix.md similarity index 100% rename from src/12-auth/permissions-matrix.md rename to src/09-security/permissions-matrix.md diff --git a/src/12-auth/permissions-reference.md b/src/09-security/permissions-reference.md similarity index 100% rename from src/12-auth/permissions-reference.md rename to src/09-security/permissions-reference.md diff --git a/src/23-security/protection-tools.md b/src/09-security/protection-tools.md similarity index 100% rename from src/23-security/protection-tools.md rename to src/09-security/protection-tools.md diff --git a/src/23-security/rbac-configuration.md b/src/09-security/rbac-configuration.md similarity index 100% rename from src/23-security/rbac-configuration.md rename to src/09-security/rbac-configuration.md diff --git a/src/23-security/rbac-design.md b/src/09-security/rbac-design.md similarity index 99% rename from src/23-security/rbac-design.md rename to src/09-security/rbac-design.md index 4357b97b..3c50c305 100644 --- a/src/23-security/rbac-design.md +++ b/src/09-security/rbac-design.md @@ -388,6 +388,6 @@ All permission-related actions are logged: ## Related Documentation -- [Subscription & Billing](../22-white-label/billing.md) +- [Subscription & Billing](../12-ecosystem-reference/billing.md) - [SOC 2 Compliance](./soc2-compliance.md) -- [API Authentication](../12-auth/README.md) \ No newline at end of file +- [API Authentication](../09-security/README.md) \ No newline at end of file diff --git a/src/12-auth/rbac-overview.md b/src/09-security/rbac-overview.md similarity index 98% rename from src/12-auth/rbac-overview.md rename to src/09-security/rbac-overview.md index 7bf5f4d8..2bfa07f3 100644 --- a/src/12-auth/rbac-overview.md +++ b/src/09-security/rbac-overview.md @@ -268,7 +268,7 @@ All permission changes are logged: 3. Map admin roles to equivalent roles 4. Import and test -See [Migration Guide](../14-migration/overview.md) for detailed instructions. +See [Migration Guide](../12-ecosystem-reference/overview.md) for detailed instructions. ## API Reference diff --git a/src/12-auth/security-checklist.md b/src/09-security/security-checklist.md similarity index 100% rename from src/12-auth/security-checklist.md rename to src/09-security/security-checklist.md diff --git a/src/12-auth/security-features.md b/src/09-security/security-features.md similarity index 100% rename from src/12-auth/security-features.md rename to src/09-security/security-features.md diff --git a/src/23-security/security-matrix.md b/src/09-security/security-matrix.md similarity index 100% rename from src/23-security/security-matrix.md rename to src/09-security/security-matrix.md diff --git a/src/12-auth/security-policy.md b/src/09-security/security-policy.md similarity index 100% rename from src/12-auth/security-policy.md rename to src/09-security/security-policy.md diff --git a/src/23-security/soc2-compliance.md b/src/09-security/soc2-compliance.md similarity index 99% rename from src/23-security/soc2-compliance.md rename to src/09-security/soc2-compliance.md index 185a035a..20669aa5 100644 --- a/src/23-security/soc2-compliance.md +++ b/src/09-security/soc2-compliance.md @@ -435,4 +435,4 @@ Content-Type: application/json - [RBAC Configuration](./rbac-configuration.md) - [Audit Logging](./audit-logging.md) - [Security Matrix](./security-matrix.md) -- [Privacy & GDPR](../12-auth/compliance-requirements.md) \ No newline at end of file +- [Privacy & GDPR](../09-security/compliance-requirements.md) \ No newline at end of file diff --git a/src/12-auth/system-limits.md b/src/09-security/system-limits.md similarity index 100% rename from src/12-auth/system-limits.md rename to src/09-security/system-limits.md diff --git a/src/12-auth/user-auth.md b/src/09-security/user-auth.md similarity index 100% rename from src/12-auth/user-auth.md rename to src/09-security/user-auth.md diff --git a/src/12-auth/user-system-context.md b/src/09-security/user-system-context.md similarity index 98% rename from src/12-auth/user-system-context.md rename to src/09-security/user-system-context.md index 3cbec013..0a920d2e 100644 --- a/src/12-auth/user-system-context.md +++ b/src/09-security/user-system-context.md @@ -289,4 +289,4 @@ Ensure your script is triggered in the intended way for the correct sender. - [Permissions Matrix](./permissions-matrix.md) - Full permission reference - [Bot Authentication](./bot-auth.md) - Service account setup - [Security Policy](./security-policy.md) - Security guidelines -- [SET SCHEDULE](../chapter-06-gbdialog/keyword-set-schedule.md) - Scheduled execution \ No newline at end of file +- [SET SCHEDULE](../04-basic-scripting/keyword-set-schedule.md) - Scheduled execution \ No newline at end of file diff --git a/src/09-tools/README.md b/src/09-tools/README.md deleted file mode 100644 index 46f42acb..00000000 --- a/src/09-tools/README.md +++ /dev/null @@ -1,68 +0,0 @@ -# Chapter 09: LLM Tools - -Define tools that LLMs can call from your BASIC scripts. - -## Overview - -Tools are BASIC scripts with PARAM declarations that become callable functions for the LLM. This enables AI-driven automation with structured inputs. - -## Tool Structure - -```basic -' weather.bas - A tool the LLM can invoke -PARAM city AS STRING LIKE "London" DESCRIPTION "City name" -PARAM units AS STRING LIKE "celsius" DESCRIPTION "Temperature units" - -DESCRIPTION "Gets current weather for a city" - -data = GET "api.weather.com/current?city=" + city -TALK "Weather in " + city + ": " + data.temperature + "°" -``` - -## How It Works - -1. **PARAM** declarations define inputs -2. **DESCRIPTION** explains the tool's purpose -3. LLM decides when to call the tool -4. Parameters collected through conversation -5. Tool executes with validated inputs - -## PARAM Declaration - -```basic -PARAM name AS type LIKE "example" DESCRIPTION "explanation" -``` - -| Component | Purpose | -|-----------|---------| -| `name` | Variable name | -| `type` | STRING, INTEGER, DATE, etc. | -| `LIKE` | Example value for LLM | -| `DESCRIPTION` | What this parameter is for | - -## Tool Formats - -Tools compile to multiple formats: - -| Format | Use Case | -|--------|----------| -| MCP | Model Context Protocol | -| OpenAI | Function calling | -| Internal | BASIC runtime | - -## Chapter Contents - -- [Tool Definition](./tool-definition.md) - Creating tools -- [PARAM Declaration](./param-declaration.md) - Parameter syntax -- [Tool Compilation](./compilation.md) - Build process -- [MCP Format](./mcp-format.md) - MCP integration -- [OpenAI Format](./openai-format.md) - Function calling -- [GET Integration](./get-integration.md) - API calls -- [External APIs](./external-apis.md) - Third-party services -- [LLM REST Server](./llm-rest-server.md) - Hosting models -- [NVIDIA GPU Setup](./nvidia-gpu-setup.md) - GPU acceleration - -## See Also - -- [BASIC Dialogs](../chapter-06-gbdialog/README.md) - Scripting reference -- [REST Endpoints](../chapter-10-rest/README.md) - HTTP endpoints \ No newline at end of file diff --git a/src/08-config/README.md b/src/10-configuration-deployment/README.md similarity index 92% rename from src/08-config/README.md rename to src/10-configuration-deployment/README.md index 80323fa3..defcb3c6 100644 --- a/src/08-config/README.md +++ b/src/10-configuration-deployment/README.md @@ -1,6 +1,6 @@ -# Bot Configuration +# Chapter 10: Configuration & Deployment -This chapter covers bot configuration through the `config.csv` file system. Each bot's behavior is controlled by a simple CSV configuration file in its `.gbot` package. +This chapter covers bot configuration and deployment options. Each bot's behavior is controlled by a simple CSV configuration file in its `.gbot` package. ## Configuration System diff --git a/src/08-config/config-csv.md b/src/10-configuration-deployment/config-csv.md similarity index 100% rename from src/08-config/config-csv.md rename to src/10-configuration-deployment/config-csv.md diff --git a/src/08-config/context-config.md b/src/10-configuration-deployment/context-config.md similarity index 100% rename from src/08-config/context-config.md rename to src/10-configuration-deployment/context-config.md diff --git a/src/08-config/drive.md b/src/10-configuration-deployment/drive.md similarity index 100% rename from src/08-config/drive.md rename to src/10-configuration-deployment/drive.md diff --git a/src/08-config/llm-config.md b/src/10-configuration-deployment/llm-config.md similarity index 100% rename from src/08-config/llm-config.md rename to src/10-configuration-deployment/llm-config.md diff --git a/src/08-config/minio.md b/src/10-configuration-deployment/minio.md similarity index 100% rename from src/08-config/minio.md rename to src/10-configuration-deployment/minio.md diff --git a/src/08-config/multimodal.md b/src/10-configuration-deployment/multimodal.md similarity index 93% rename from src/08-config/multimodal.md rename to src/10-configuration-deployment/multimodal.md index bb1c065d..28d02e8a 100644 --- a/src/08-config/multimodal.md +++ b/src/10-configuration-deployment/multimodal.md @@ -17,7 +17,6 @@ General Bots integrates with botmodels—a Python service for multimodal AI task │ - VIDEO │ - Zeroscope │ - AUDIO │ - TTS/Whisper │ - SEE │ - BLIP2 - │ │ - Real-time Audio (S2S) ``` When a BASIC script calls a multimodal keyword, botserver forwards the request to botmodels, which runs the appropriate AI model and returns the generated content. @@ -59,13 +58,6 @@ Add these settings to your bot's `config.csv` file to enable multimodal capabili | `video-generator-gpu-layers` | `15` | Layers to offload to GPU | | `video-generator-batch-size` | `1` | Batch size for generation | -### Real-time Audio (S2S) - -| Key | Default | Description | -|-----|---------|-------------| -| `realtime-audio-model` | — | Path to Real-time S2S model | -| `realtime-audio-enabled` | `false` | Enable real-time audio processing | - ## Example Configuration ```csv @@ -168,7 +160,6 @@ The botmodels service exposes these REST endpoints: | `/api/vision/describe` | POST | Describe an image | | `/api/vision/describe_video` | POST | Describe a video | | `/api/vision/vqa` | POST | Visual question answering | -| `/api/speech/realtime` | POST | Real-time speech-to-speech interaction | | `/api/health` | GET | Health check | All endpoints except `/api/health` require the `X-API-Key` header for authentication. @@ -252,5 +243,5 @@ Reduce `gpu-layers` or `batch-size`. Video generation is particularly memory-int - [LLM Configuration](./llm-config.md) - Language model settings - [Bot Parameters](./parameters.md) - All configuration options -- [IMAGE Keyword](../chapter-06-gbdialog/keywords.md) - Image generation reference -- [SEE Keyword](../chapter-06-gbdialog/keywords.md) - Vision capabilities \ No newline at end of file +- [IMAGE Keyword](../04-basic-scripting/keywords.md) - Image generation reference +- [SEE Keyword](../04-basic-scripting/keywords.md) - Vision capabilities \ No newline at end of file diff --git a/src/08-config/parameters.md b/src/10-configuration-deployment/parameters.md similarity index 98% rename from src/08-config/parameters.md rename to src/10-configuration-deployment/parameters.md index 91bfa2b6..4ea2010c 100644 --- a/src/08-config/parameters.md +++ b/src/10-configuration-deployment/parameters.md @@ -195,13 +195,6 @@ These parameters configure external database connections for use with BASIC keyw | `video-generator-gpu-layers` | GPU offload layers | `15` | Number | | `video-generator-batch-size` | Batch size | `1` | Number | -## Real-time Audio Parameters - -| Parameter | Description | Default | Type | -|-----------|-------------|---------|------| -| `realtime-audio-model` | Real-time S2S audio model path | Not set | Path | -| `realtime-audio-enabled` | Enable real-time audio processing | `false` | Boolean | - ## BotModels Service Parameters | Parameter | Description | Default | Type | @@ -378,7 +371,7 @@ bot-improvement-threshold,7.0 | `episodic-memory-retention-days` | Days to retain episodes | `365` | Number | | `episodic-memory-auto-summarize` | Enable automatic summarization | `true` | Boolean | -Episodic memory automatically manages conversation context to stay within LLM token limits. When conversation exchanges exceed `episodic-memory-threshold`, older messages are summarized and only the last `episodic-memory-history` exchanges are kept in full. See [Chapter 03 - Episodic Memory](../chapter-03/episodic-memory.md) for details. +Episodic memory automatically manages conversation context to stay within LLM token limits. When conversation exchanges exceed `episodic-memory-threshold`, older messages are summarized and only the last `episodic-memory-history` exchanges are kept in full. See [Chapter 03 - Episodic Memory](../03-knowledge-ai/episodic-memory.md) for details. ## Model Routing Parameters diff --git a/src/08-config/secrets-management.md b/src/10-configuration-deployment/secrets-management.md similarity index 99% rename from src/08-config/secrets-management.md rename to src/10-configuration-deployment/secrets-management.md index 21fcb28e..5d691850 100644 --- a/src/08-config/secrets-management.md +++ b/src/10-configuration-deployment/secrets-management.md @@ -802,4 +802,4 @@ tar -czf vault-backup.tar.gz botserver-stack/data/vault/ - [config.csv Format](./config-csv.md) - Bot configuration reference - [LLM Configuration](./llm-config.md) - LLM-specific settings -- [Infrastructure Design](../chapter-07-gbapp/infrastructure.md) - Full architecture \ No newline at end of file +- [Infrastructure Design](../02-architecture-packages/infrastructure.md) - Full architecture \ No newline at end of file diff --git a/src/08-config/sms-providers.md b/src/10-configuration-deployment/sms-providers.md similarity index 100% rename from src/08-config/sms-providers.md rename to src/10-configuration-deployment/sms-providers.md diff --git a/src/08-config/sources-sync-strategy.md b/src/10-configuration-deployment/sources-sync-strategy.md similarity index 100% rename from src/08-config/sources-sync-strategy.md rename to src/10-configuration-deployment/sources-sync-strategy.md diff --git a/src/08-config/system-limits.md b/src/10-configuration-deployment/system-limits.md similarity index 99% rename from src/08-config/system-limits.md rename to src/10-configuration-deployment/system-limits.md index 2eca9761..be99a23a 100644 --- a/src/08-config/system-limits.md +++ b/src/10-configuration-deployment/system-limits.md @@ -465,4 +465,4 @@ When limits are exceeded, the system returns: - [Session Management](../01-introduction/sessions.md) - [Package Structure](../02-templates/gbai.md) - [Knowledge Base](../03-knowledge-base/README.md) -- [API Reference](../10-rest/README.md) \ No newline at end of file +- [API Reference](../08-rest-api-tools/README.md) \ No newline at end of file diff --git a/src/08-config/teams-channel.md b/src/10-configuration-deployment/teams-channel.md similarity index 97% rename from src/08-config/teams-channel.md rename to src/10-configuration-deployment/teams-channel.md index 7f3bc4ad..298afef4 100644 --- a/src/08-config/teams-channel.md +++ b/src/10-configuration-deployment/teams-channel.md @@ -433,9 +433,9 @@ Teams requires HTTPS with a valid certificate. Self-signed certificates are not - [WhatsApp Configuration](./whatsapp-channel.md) — WhatsApp channel setup - [SMS Configuration](./sms-providers.md) — SMS provider configuration -- [Universal Messaging](../chapter-06-gbdialog/universal-messaging.md) — Multi-channel messaging +- [Universal Messaging](../04-basic-scripting/universal-messaging.md) — Multi-channel messaging - [Secrets Management](./secrets-management.md) — Secure credential storage -- [CARD Keyword](../chapter-06-gbdialog/keyword-card.md) — Creating rich cards +- [CARD Keyword](../04-basic-scripting/keyword-card.md) — Creating rich cards --- diff --git a/src/08-config/whatsapp-channel.md b/src/10-configuration-deployment/whatsapp-channel.md similarity index 97% rename from src/08-config/whatsapp-channel.md rename to src/10-configuration-deployment/whatsapp-channel.md index 7674c814..ba8c9eb3 100644 --- a/src/08-config/whatsapp-channel.md +++ b/src/10-configuration-deployment/whatsapp-channel.md @@ -487,9 +487,9 @@ SEND SMS test_phone, "Test message from General Bots" - [Teams Configuration](./teams-channel.md) — Microsoft Teams setup - [SMS Configuration](./sms-providers.md) — SMS provider configuration -- [Universal Messaging](../chapter-06-gbdialog/universal-messaging.md) — Multi-channel messaging -- [SEND TEMPLATE Keyword](../chapter-06-gbdialog/keyword-send-template.md) — Template messaging -- [CARD Keyword](../chapter-06-gbdialog/keyword-card.md) — Rich card messages +- [Universal Messaging](../04-basic-scripting/universal-messaging.md) — Multi-channel messaging +- [SEND TEMPLATE Keyword](../04-basic-scripting/keyword-send-template.md) — Template messaging +- [CARD Keyword](../04-basic-scripting/keyword-card.md) — Rich card messages --- diff --git a/src/21-scale/README.md b/src/11-hardware-scaling/README.md similarity index 95% rename from src/21-scale/README.md rename to src/11-hardware-scaling/README.md index 8785d229..7a26ddf3 100644 --- a/src/21-scale/README.md +++ b/src/11-hardware-scaling/README.md @@ -1,6 +1,6 @@ -# Scale +# Chapter 11: Hardware & Scaling -This chapter covers horizontal scaling strategies for General Bots to support millions to billions of users across global deployments. +This chapter covers hardware requirements and horizontal scaling strategies for General Bots. ## Overview diff --git a/src/13-hardware-devices/buying-guide.md b/src/11-hardware-scaling/buying-guide.md similarity index 98% rename from src/13-hardware-devices/buying-guide.md rename to src/11-hardware-scaling/buying-guide.md index 0187509e..975c4465 100644 --- a/src/13-hardware-devices/buying-guide.md +++ b/src/11-hardware-scaling/buying-guide.md @@ -16,7 +16,7 @@ A Single Board Computer (SBC) is a complete computer on a single circuit board. ### Decision Flowchart -Hardware Budget Decision Tree +Hardware Budget Decision Tree ### Recommended Starter Kits diff --git a/src/21-scale/database-optimization.md b/src/11-hardware-scaling/database-optimization.md similarity index 100% rename from src/21-scale/database-optimization.md rename to src/11-hardware-scaling/database-optimization.md diff --git a/src/13-hardware-devices/desktop-hardware.md b/src/11-hardware-scaling/desktop-hardware.md similarity index 100% rename from src/13-hardware-devices/desktop-hardware.md rename to src/11-hardware-scaling/desktop-hardware.md diff --git a/src/20-embedding/hardware.md b/src/11-hardware-scaling/hardware.md similarity index 100% rename from src/20-embedding/hardware.md rename to src/11-hardware-scaling/hardware.md diff --git a/src/20-embedding/local-llm.md b/src/11-hardware-scaling/local-llm.md similarity index 100% rename from src/20-embedding/local-llm.md rename to src/11-hardware-scaling/local-llm.md diff --git a/src/13-hardware-devices/mobile.md b/src/11-hardware-scaling/mobile.md similarity index 97% rename from src/13-hardware-devices/mobile.md rename to src/11-hardware-scaling/mobile.md index eecb8fec..9722ef8d 100644 --- a/src/13-hardware-devices/mobile.md +++ b/src/11-hardware-scaling/mobile.md @@ -6,7 +6,7 @@ Deploy General Bots as the primary interface on Android and HarmonyOS devices, t BotDevice transforms any Android or HarmonyOS device into a dedicated General Bots system, removing manufacturer bloatware and installing GB as the default launcher. -BotDevice Architecture +BotDevice Architecture ## Supported Platforms diff --git a/src/20-embedding/quick-start.md b/src/11-hardware-scaling/quick-start.md similarity index 100% rename from src/20-embedding/quick-start.md rename to src/11-hardware-scaling/quick-start.md diff --git a/src/21-scale/sharding.md b/src/11-hardware-scaling/sharding.md similarity index 100% rename from src/21-scale/sharding.md rename to src/11-hardware-scaling/sharding.md diff --git a/src/12-auth/README.md b/src/12-auth/README.md deleted file mode 100644 index f54be562..00000000 --- a/src/12-auth/README.md +++ /dev/null @@ -1,114 +0,0 @@ -# Chapter 12: Authentication & Security - -User authentication, permission management, and resource protection for botserver. - -## Overview - -botserver provides enterprise-grade security with flexible authentication options, granular permissions, and comprehensive rate limiting to prevent abuse. - -## Initial Setup - -When General Bots starts for the first time, it automatically creates an administrator account and displays the credentials in the console. See [Initial Setup & Bootstrap](./initial-setup.md) for details. - -``` -╔════════════════════════════════════════════════════════════╗ -║ 🤖 GENERAL BOTS - INITIAL SETUP COMPLETE ║ -╠════════════════════════════════════════════════════════════╣ -║ Username: admin ║ -║ Email: admin@localhost ║ -║ Password: (displayed in console) ║ -╚════════════════════════════════════════════════════════════╝ -``` - -> **Important**: Save the password shown in your console during first startup. It will not be displayed again. - -## Authentication Methods - -| Method | Use Case | -|--------|----------| -| **Session Token** | Web/API access | -| **OAuth2/OIDC** | SSO integration via Zitadel | -| **API Key** | Service accounts | -| **Bot Auth** | Bot-to-bot communication | - -## Quick Start - -```basic -' Check if user is authenticated -IF user.authenticated THEN - TALK "Welcome, " + user.name -ELSE - TALK "Please log in first" -END IF -``` - -## Security Features - -- **Directory Service**: Zitadel handles all user identity management -- **No Password Storage**: Passwords never stored in General Bots -- **Session Management**: Cryptographic tokens, configurable expiry -- **Rate Limiting**: Per-user and global limits with HTTP 429 responses -- **System Limits**: Loop protection, file size limits, resource constraints -- **Audit Logging**: Track all authentication events -- **Organizations**: Multi-tenant support with org-based isolation - -## Permission Levels - -| Level | Access | -|-------|--------| -| `admin` | Full system access, user management | -| `org_owner` | Organization management | -| `bot_owner` | Bot configuration and deployment | -| `bot_operator` | Bot operation and monitoring | -| `user` | Standard access | -| `guest` | Read-only, anonymous chat | - -## Organization Structure - -``` -Organization (e.g., "Acme Corp") -├── Users (with roles) -├── Bots (owned by org) -│ ├── sales-bot -│ └── support-bot -└── Drive Storage - ├── acme-sales-bot.gbai/ - └── acme-support-bot.gbai/ -``` - -## Configuration - -```csv -name,value -auth-session-ttl,3600 -auth-max-attempts,5 -auth-lockout-duration,900 -``` - -## Chapter Contents - -- [Initial Setup & Bootstrap](./initial-setup.md) - First-time admin setup -- [User Authentication](./user-auth.md) - Login flows -- [Password Security](./password-security.md) - Password policies -- [API Endpoints](./api-endpoints.md) - Auth API reference -- [Bot Authentication](./bot-auth.md) - Service accounts -- [Security Features](./security-features.md) - Protection mechanisms -- [Security Policy](./security-policy.md) - Best practices -- [Compliance Requirements](./compliance-requirements.md) - GDPR, LGPD, HIPAA -- [Permissions Matrix](./permissions-matrix.md) - Access control -- [User vs System Context](./user-system-context.md) - Execution contexts -- [System Limits & Rate Limiting](./system-limits.md) - Resource constraints and abuse prevention - -## Anonymous Chat Access - -Anonymous users can use the chat functionality without logging in. The system automatically creates temporary sessions for anonymous users. Authentication is only required for: - -- User management (Settings) -- Bot configuration -- Administrative functions -- Organization management - -## See Also - -- [REST API](../10-rest/README.md) - API authentication -- [Configuration](../08-config/README.md) - Auth settings \ No newline at end of file diff --git a/src/22-white-label/README.md b/src/12-ecosystem-reference/README.md similarity index 94% rename from src/22-white-label/README.md rename to src/12-ecosystem-reference/README.md index 7b9a75cf..47c5fc38 100644 --- a/src/22-white-label/README.md +++ b/src/12-ecosystem-reference/README.md @@ -1,6 +1,6 @@ -# White Label Configuration +# Chapter 12: Ecosystem & Reference -General Bots supports full white-label customization, allowing you to rebrand the entire platform with your own company name, logo, colors, and feature set. This is controlled through a simple `.product` configuration file. +General Bots supports full white-label customization, allowing you to rebrand the entire platform. ## Overview @@ -404,7 +404,7 @@ If the product name doesn't change: ## Related Documentation -- [Theme Customization](../05-gbtheme/README.md) - Detailed theme configuration -- [UI Components](../04-gbui/README.md) - UI customization options -- [Configuration](../08-config/README.md) - General server configuration -- [Authentication](../12-auth/README.md) - Auth customization for white-label \ No newline at end of file +- [Theme Customization](../07-user-interface/README.md) - Detailed theme configuration +- [UI Components](../07-user-interface/README.md) - UI customization options +- [Configuration](../10-configuration-deployment/README.md) - General server configuration +- [Authentication](../09-security/README.md) - Auth customization for white-label \ No newline at end of file diff --git a/src/17-testing/architecture.md b/src/12-ecosystem-reference/architecture.md similarity index 100% rename from src/17-testing/architecture.md rename to src/12-ecosystem-reference/architecture.md diff --git a/src/14-migration/automation.md b/src/12-ecosystem-reference/automation.md similarity index 100% rename from src/14-migration/automation.md rename to src/12-ecosystem-reference/automation.md diff --git a/src/19-maintenance/backup-recovery.md b/src/12-ecosystem-reference/backup-recovery.md similarity index 100% rename from src/19-maintenance/backup-recovery.md rename to src/12-ecosystem-reference/backup-recovery.md diff --git a/src/17-testing/best-practices.md b/src/12-ecosystem-reference/best-practices.md similarity index 100% rename from src/17-testing/best-practices.md rename to src/12-ecosystem-reference/best-practices.md diff --git a/src/22-white-label/billing.md b/src/12-ecosystem-reference/billing.md similarity index 98% rename from src/22-white-label/billing.md rename to src/12-ecosystem-reference/billing.md index b1aaf4cc..2db98a81 100644 --- a/src/22-white-label/billing.md +++ b/src/12-ecosystem-reference/billing.md @@ -616,7 +616,7 @@ Content-Type: application/json ## Related Topics -- [Organization Management](../23-security/organizations.md) -- [RBAC Configuration](../23-security/rbac-configuration.md) +- [Organization Management](../09-security/organizations.md) +- [RBAC Configuration](../09-security/rbac-configuration.md) - [White-Label Setup](./setup.md) -- [API Authentication](../10-rest/authentication.md) \ No newline at end of file +- [API Authentication](../08-rest-api-tools/authentication.md) \ No newline at end of file diff --git a/src/14-migration/botpress.md b/src/12-ecosystem-reference/botpress.md similarity index 97% rename from src/14-migration/botpress.md rename to src/12-ecosystem-reference/botpress.md index 13dad10e..e81eaf2d 100644 --- a/src/14-migration/botpress.md +++ b/src/12-ecosystem-reference/botpress.md @@ -455,7 +455,7 @@ customer = FIND "customers", "email = '" + email + "'" ## See Also -- [Dialog Basics](../chapter-06-gbdialog/basics.md) - Script fundamentals -- [HEAR Keyword](../chapter-06-gbdialog/keyword-hear.md) - Input validation -- [Knowledge Base](../chapter-03/README.md) - RAG configuration +- [Dialog Basics](../04-basic-scripting/basics.md) - Script fundamentals +- [HEAR Keyword](../04-basic-scripting/keyword-hear.md) - Input validation +- [Knowledge Base](../03-knowledge-ai/README.md) - RAG configuration - [Platform Comparison](./comparison-matrix.md) - Full comparison \ No newline at end of file diff --git a/src/17-testing/ci-cd.md b/src/12-ecosystem-reference/ci-cd.md similarity index 100% rename from src/17-testing/ci-cd.md rename to src/12-ecosystem-reference/ci-cd.md diff --git a/src/19-maintenance/cli-reference.md b/src/12-ecosystem-reference/cli-reference.md similarity index 100% rename from src/19-maintenance/cli-reference.md rename to src/12-ecosystem-reference/cli-reference.md diff --git a/src/13-community/code-of-conduct-pt-br.md b/src/12-ecosystem-reference/code-of-conduct-pt-br.md similarity index 100% rename from src/13-community/code-of-conduct-pt-br.md rename to src/12-ecosystem-reference/code-of-conduct-pt-br.md diff --git a/src/13-community/code-of-conduct.md b/src/12-ecosystem-reference/code-of-conduct.md similarity index 100% rename from src/13-community/code-of-conduct.md rename to src/12-ecosystem-reference/code-of-conduct.md diff --git a/src/14-migration/common-concepts.md b/src/12-ecosystem-reference/common-concepts.md similarity index 100% rename from src/14-migration/common-concepts.md rename to src/12-ecosystem-reference/common-concepts.md diff --git a/src/13-community/community.md b/src/12-ecosystem-reference/community.md similarity index 100% rename from src/13-community/community.md rename to src/12-ecosystem-reference/community.md diff --git a/src/14-migration/comparison-matrix.md b/src/12-ecosystem-reference/comparison-matrix.md similarity index 99% rename from src/14-migration/comparison-matrix.md rename to src/12-ecosystem-reference/comparison-matrix.md index ddccf3a9..cb374c73 100644 --- a/src/14-migration/comparison-matrix.md +++ b/src/12-ecosystem-reference/comparison-matrix.md @@ -197,4 +197,4 @@ The combination of enterprise productivity features, native AI, powerful automat - [Migration Overview](./overview.md) - Getting started - [Migration Resources](./resources.md) - Tools and templates - [Enterprise Platform Migration](./microsoft-365.md) - Detailed migration guide -- [Quick Start](../chapter-01/quick-start.md) - Deploy in minutes \ No newline at end of file +- [Quick Start](../01-getting-started/quick-start.md) - Deploy in minutes \ No newline at end of file diff --git a/src/19-maintenance/component-reference.md b/src/12-ecosystem-reference/component-reference.md similarity index 100% rename from src/19-maintenance/component-reference.md rename to src/12-ecosystem-reference/component-reference.md diff --git a/src/13-community/contributing-guidelines.md b/src/12-ecosystem-reference/contributing-guidelines.md similarity index 100% rename from src/13-community/contributing-guidelines.md rename to src/12-ecosystem-reference/contributing-guidelines.md diff --git a/src/12-ecosystem-reference/data-migration.md b/src/12-ecosystem-reference/data-migration.md new file mode 100644 index 00000000..67fbf684 --- /dev/null +++ b/src/12-ecosystem-reference/data-migration.md @@ -0,0 +1 @@ +# Data Migration diff --git a/src/12-ecosystem-reference/data-validation.md b/src/12-ecosystem-reference/data-validation.md new file mode 100644 index 00000000..3a83a5a6 --- /dev/null +++ b/src/12-ecosystem-reference/data-validation.md @@ -0,0 +1 @@ +# Data Validation diff --git a/src/14-migration/dialogflow.md b/src/12-ecosystem-reference/dialogflow.md similarity index 97% rename from src/14-migration/dialogflow.md rename to src/12-ecosystem-reference/dialogflow.md index d9c37d15..01b5d95e 100644 --- a/src/14-migration/dialogflow.md +++ b/src/12-ecosystem-reference/dialogflow.md @@ -470,7 +470,7 @@ TALK FILE "/documents/brochure.pdf" ## See Also -- [HEAR Keyword](../chapter-06-gbdialog/keyword-hear.md) - Input validation (replaces entities) -- [SET CONTEXT](../chapter-06-gbdialog/keyword-set-context.md) - AI behavior configuration -- [Knowledge Base](../chapter-03/README.md) - RAG setup +- [HEAR Keyword](../04-basic-scripting/keyword-hear.md) - Input validation (replaces entities) +- [SET CONTEXT](../04-basic-scripting/keyword-set-context.md) - AI behavior configuration +- [Knowledge Base](../03-knowledge-ai/README.md) - RAG setup - [Platform Comparison](./comparison-matrix.md) - Full feature comparison \ No newline at end of file diff --git a/src/13-community/documentation.md b/src/12-ecosystem-reference/documentation.md similarity index 100% rename from src/13-community/documentation.md rename to src/12-ecosystem-reference/documentation.md diff --git a/src/17-testing/e2e-testing.md b/src/12-ecosystem-reference/e2e-testing.md similarity index 100% rename from src/17-testing/e2e-testing.md rename to src/12-ecosystem-reference/e2e-testing.md diff --git a/src/14-migration/google-workspace.md b/src/12-ecosystem-reference/google-workspace.md similarity index 100% rename from src/14-migration/google-workspace.md rename to src/12-ecosystem-reference/google-workspace.md diff --git a/src/13-community/ide-extensions.md b/src/12-ecosystem-reference/ide-extensions.md similarity index 100% rename from src/13-community/ide-extensions.md rename to src/12-ecosystem-reference/ide-extensions.md diff --git a/src/14-migration/intercom.md b/src/12-ecosystem-reference/intercom.md similarity index 98% rename from src/14-migration/intercom.md rename to src/12-ecosystem-reference/intercom.md index 07169542..200c8158 100644 --- a/src/14-migration/intercom.md +++ b/src/12-ecosystem-reference/intercom.md @@ -421,7 +421,7 @@ Migrating to General Bots provides several significant advantages. There is no p ## See Also -- [Projects](../chapter-11-features/projects.md) - Organizing support queues -- [HEAR Validation](../chapter-06-gbdialog/keyword-hear.md) - Input validation -- [Lead Scoring](../chapter-06-gbdialog/keywords-lead-scoring.md) - Qualification +- [Projects](../03-knowledge-ai/projects.md) - Organizing support queues +- [HEAR Validation](../04-basic-scripting/keyword-hear.md) - Input validation +- [Lead Scoring](../04-basic-scripting/keywords-lead-scoring.md) - Qualification - [Platform Comparison](./comparison-matrix.md) - Full feature comparison \ No newline at end of file diff --git a/src/14-migration/kb-migration.md b/src/12-ecosystem-reference/kb-migration.md similarity index 100% rename from src/14-migration/kb-migration.md rename to src/12-ecosystem-reference/kb-migration.md diff --git a/src/12-ecosystem-reference/local-development.md b/src/12-ecosystem-reference/local-development.md new file mode 100644 index 00000000..2331b22e --- /dev/null +++ b/src/12-ecosystem-reference/local-development.md @@ -0,0 +1 @@ +# Local Development diff --git a/src/19-maintenance/lxc-migration.md b/src/12-ecosystem-reference/lxc-migration.md similarity index 100% rename from src/19-maintenance/lxc-migration.md rename to src/12-ecosystem-reference/lxc-migration.md diff --git a/src/14-migration/microsoft-365.md b/src/12-ecosystem-reference/microsoft-365.md similarity index 100% rename from src/14-migration/microsoft-365.md rename to src/12-ecosystem-reference/microsoft-365.md diff --git a/src/14-migration/n8n.md b/src/12-ecosystem-reference/n8n.md similarity index 97% rename from src/14-migration/n8n.md rename to src/12-ecosystem-reference/n8n.md index 551b6cac..cc0ec530 100644 --- a/src/14-migration/n8n.md +++ b/src/12-ecosystem-reference/n8n.md @@ -355,7 +355,7 @@ SET SCHEDULE "0 18 * * 1-5" ## See Also -- [SET SCHEDULE](../chapter-06-gbdialog/keyword-set-schedule.md) - Scheduling reference -- [WEBHOOK](../chapter-06-gbdialog/keyword-webhook.md) - Webhook creation -- [HTTP Keywords](../chapter-06-gbdialog/keywords-http.md) - API integration +- [SET SCHEDULE](../04-basic-scripting/keyword-set-schedule.md) - Scheduling reference +- [WEBHOOK](../04-basic-scripting/keyword-webhook.md) - Webhook creation +- [HTTP Keywords](../04-basic-scripting/keywords-http.md) - API integration - [Platform Comparison](./comparison-matrix.md) - Full feature comparison \ No newline at end of file diff --git a/src/14-migration/notion.md b/src/12-ecosystem-reference/notion.md similarity index 97% rename from src/14-migration/notion.md rename to src/12-ecosystem-reference/notion.md index 0eef1006..7a55dad7 100644 --- a/src/14-migration/notion.md +++ b/src/12-ecosystem-reference/notion.md @@ -410,7 +410,7 @@ Keep templates as scripts since BASIC templates are more powerful than Notion's ## See Also -- [Knowledge Base](../chapter-03/README.md) - KB configuration -- [Projects](../chapter-11-features/projects.md) - Project management -- [Template Variables](../chapter-06-gbdialog/template-variables.md) - Dynamic content +- [Knowledge Base](../03-knowledge-ai/README.md) - KB configuration +- [Projects](../03-knowledge-ai/projects.md) - Project management +- [Template Variables](../04-basic-scripting/template-variables.md) - Dynamic content - [Platform Comparison](./comparison-matrix.md) - Full feature comparison \ No newline at end of file diff --git a/src/14-migration/overview.md b/src/12-ecosystem-reference/overview.md similarity index 100% rename from src/14-migration/overview.md rename to src/12-ecosystem-reference/overview.md diff --git a/src/17-testing/performance.md b/src/12-ecosystem-reference/performance.md similarity index 100% rename from src/17-testing/performance.md rename to src/12-ecosystem-reference/performance.md diff --git a/src/14-migration/perplexity.md b/src/12-ecosystem-reference/perplexity.md similarity index 97% rename from src/14-migration/perplexity.md rename to src/12-ecosystem-reference/perplexity.md index 930b3c13..f756d98e 100644 --- a/src/14-migration/perplexity.md +++ b/src/12-ecosystem-reference/perplexity.md @@ -400,7 +400,7 @@ LOOP ## See Also -- [Knowledge Base](../chapter-03/README.md) - Building effective KBs -- [USE KB](../chapter-06-gbdialog/keyword-use-kb.md) - Knowledge base keyword -- [SET CONTEXT](../chapter-06-gbdialog/keyword-set-context.md) - AI configuration +- [Knowledge Base](../03-knowledge-ai/README.md) - Building effective KBs +- [USE KB](../04-basic-scripting/keyword-use-kb.md) - Knowledge base keyword +- [SET CONTEXT](../04-basic-scripting/keyword-set-context.md) - AI configuration - [Platform Comparison](./comparison-matrix.md) - Full feature comparison \ No newline at end of file diff --git a/src/13-community/pull-requests.md b/src/12-ecosystem-reference/pull-requests.md similarity index 100% rename from src/13-community/pull-requests.md rename to src/12-ecosystem-reference/pull-requests.md diff --git a/src/15-appendix/relationships.md b/src/12-ecosystem-reference/relationships.md similarity index 100% rename from src/15-appendix/relationships.md rename to src/12-ecosystem-reference/relationships.md diff --git a/src/14-migration/resources.md b/src/12-ecosystem-reference/resources.md similarity index 97% rename from src/14-migration/resources.md rename to src/12-ecosystem-reference/resources.md index a3f7a516..553751f8 100644 --- a/src/14-migration/resources.md +++ b/src/12-ecosystem-reference/resources.md @@ -199,4 +199,4 @@ The lessons learned section captures challenges encountered, solutions implement ## See Also -Review the [Migration Overview](./overview.md) for getting started with migration concepts. See [Validation and Testing](./validation.md) to verify migration success. The [Enterprise Platform Migration](../chapter-11-features/m365-comparison.md) guide provides detailed feature mapping. Start with the [Quick Start](../chapter-01/quick-start.md) guide for initial deployment. \ No newline at end of file +Review the [Migration Overview](./overview.md) for getting started with migration concepts. See [Validation and Testing](./validation.md) to verify migration success. The [Enterprise Platform Migration](../03-knowledge-ai/m365-comparison.md) guide provides detailed feature mapping. Start with the [Quick Start](../01-getting-started/quick-start.md) guide for initial deployment. \ No newline at end of file diff --git a/src/15-appendix/schema.md b/src/12-ecosystem-reference/schema.md similarity index 100% rename from src/15-appendix/schema.md rename to src/12-ecosystem-reference/schema.md diff --git a/src/19-maintenance/security-auditing.md b/src/12-ecosystem-reference/security-auditing.md similarity index 98% rename from src/19-maintenance/security-auditing.md rename to src/12-ecosystem-reference/security-auditing.md index 8712fb3d..073ab7ba 100644 --- a/src/19-maintenance/security-auditing.md +++ b/src/12-ecosystem-reference/security-auditing.md @@ -422,6 +422,6 @@ If you discover a security vulnerability in botserver: ## See Also -- [Secrets Management](../08-config/secrets-management.md) - Vault configuration +- [Secrets Management](../10-configuration-deployment/secrets-management.md) - Vault configuration - [Updating Components](./updating-components.md) - Applying security updates - [Backup and Recovery](./backup-recovery.md) - Data protection \ No newline at end of file diff --git a/src/13-community/setup.md b/src/12-ecosystem-reference/setup.md similarity index 97% rename from src/13-community/setup.md rename to src/12-ecosystem-reference/setup.md index 230b01b6..6df1ec24 100644 --- a/src/13-community/setup.md +++ b/src/12-ecosystem-reference/setup.md @@ -389,7 +389,7 @@ See [Contributing Guidelines](./contributing-guidelines.md) for: ## Next Steps -- Read the [Architecture Overview](../chapter-06/architecture.md) -- Explore the [BASIC Language Reference](../chapter-05/README.md) +- Read the [Architecture Overview](../04-basic-scripting/architecture.md) +- Explore the [BASIC Language Reference](../07-user-interface/README.md) - Review [Code Standards](./standards.md) - Start with a [good first issue](https://github.com/GeneralBots/botserver/labels/good%20first%20issue) \ No newline at end of file diff --git a/src/13-community/standards.md b/src/12-ecosystem-reference/standards.md similarity index 100% rename from src/13-community/standards.md rename to src/12-ecosystem-reference/standards.md diff --git a/src/15-appendix/tables.md b/src/12-ecosystem-reference/tables.md similarity index 100% rename from src/15-appendix/tables.md rename to src/12-ecosystem-reference/tables.md diff --git a/src/13-community/testing.md b/src/12-ecosystem-reference/testing.md similarity index 100% rename from src/13-community/testing.md rename to src/12-ecosystem-reference/testing.md diff --git a/src/19-maintenance/troubleshooting.md b/src/12-ecosystem-reference/troubleshooting.md similarity index 100% rename from src/19-maintenance/troubleshooting.md rename to src/12-ecosystem-reference/troubleshooting.md diff --git a/src/19-maintenance/updating-components.md b/src/12-ecosystem-reference/updating-components.md similarity index 100% rename from src/19-maintenance/updating-components.md rename to src/12-ecosystem-reference/updating-components.md diff --git a/src/14-migration/validation.md b/src/12-ecosystem-reference/validation.md similarity index 100% rename from src/14-migration/validation.md rename to src/12-ecosystem-reference/validation.md diff --git a/src/14-migration/zapier-make.md b/src/12-ecosystem-reference/zapier-make.md similarity index 98% rename from src/14-migration/zapier-make.md rename to src/12-ecosystem-reference/zapier-make.md index 6500dfbd..0d5c3892 100644 --- a/src/14-migration/zapier-make.md +++ b/src/12-ecosystem-reference/zapier-make.md @@ -483,7 +483,7 @@ SET SCHEDULE "0 18 * * 1-5" ## See Also -- [SET SCHEDULE](../chapter-06-gbdialog/keyword-set-schedule.md) - Scheduling -- [WEBHOOK](../chapter-06-gbdialog/keyword-webhook.md) - Webhooks -- [HTTP Keywords](../chapter-06-gbdialog/keywords-http.md) - API calls +- [SET SCHEDULE](../04-basic-scripting/keyword-set-schedule.md) - Scheduling +- [WEBHOOK](../04-basic-scripting/keyword-webhook.md) - Webhooks +- [HTTP Keywords](../04-basic-scripting/keywords-http.md) - API calls - [Platform Comparison](./comparison-matrix.md) - Full comparison \ No newline at end of file diff --git a/src/13-community/README.md b/src/13-community/README.md deleted file mode 100644 index cdfa4d5f..00000000 --- a/src/13-community/README.md +++ /dev/null @@ -1,73 +0,0 @@ -# Chapter 13: Contributing - -Join the General Bots community and help improve the platform. - -## Quick Links - -| Resource | Purpose | -|----------|---------| -| [GitHub](https://github.com/GeneralBots/botserver) | Source code, issues | -| [Discussions](https://github.com/GeneralBots/botserver/discussions) | Q&A, ideas | -| [Blog](https://pragmatismo.com.br/blog) | Updates, tutorials | - -## How to Contribute - -### Code Contributions - -1. Fork the repository -2. Create a feature branch -3. Make your changes -4. Write tests -5. Submit a pull request - -### Documentation - -- Fix typos and errors -- Add examples -- Improve clarity -- Translate content - -### Community Support - -- Answer questions in discussions -- Share your bots and templates -- Report bugs with reproduction steps -- Suggest features - -## Development Setup - -```bash -git clone https://github.com/GeneralBots/botserver -cd botserver -cargo build -./target/debug/botserver -``` - -## What We Accept - -✅ Bug fixes with tests -✅ Performance improvements -✅ New BASIC keywords (if broadly useful) -✅ Documentation improvements -✅ Security enhancements - -## What We Don't Accept - -❌ Vendor-specific integrations -❌ Undocumented code -❌ Code without tests -❌ Features achievable with existing BASIC + LLM - -## Chapter Contents - -- [Development Setup](./setup.md) - Build environment -- [Testing Guide](./testing.md) - Running tests -- [Documentation](./documentation.md) - Writing docs -- [Pull Requests](./pull-requests.md) - PR process -- [Community Guidelines](./community.md) - Code of conduct -- [IDEs](./ide-extensions.md) - Editor support - -## See Also - -- [Architecture](../chapter-07-gbapp/README.md) - System design -- [BASIC Reference](../chapter-06-gbdialog/README.md) - Scripting language \ No newline at end of file diff --git a/src/13-hardware-devices/README.md b/src/13-hardware-devices/README.md deleted file mode 100644 index 30fa2c63..00000000 --- a/src/13-hardware-devices/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Chapter 13: Device & Offline Deployment - -Deploy General Bots to any device - from smartphones to Raspberry Pi to industrial kiosks - with local LLM inference for fully offline AI capabilities. - -## Overview - -General Bots can run on any device, from mobile phones to minimal embedded hardware with displays as small as 16x2 character LCDs, enabling AI-powered interactions anywhere: - -- **Kiosks** - Self-service terminals in stores, airports, hospitals -- **Industrial IoT** - Factory floor assistants, machine interfaces -- **Smart Home** - Wall panels, kitchen displays, door intercoms -- **Retail** - Point-of-sale systems, product information terminals -- **Education** - Classroom assistants, lab equipment interfaces -- **Healthcare** - Patient check-in, medication reminders - -Embedded GB Architecture - -## What's in This Chapter - -### Mobile Deployment -- [Mobile (Android & HarmonyOS)](./mobile.md) - BotOS for smartphones and tablets - -### Embedded Deployment -- [Supported Hardware](./hardware.md) - SBCs, displays, and peripherals -- [Quick Start](./quick-start.md) - Deploy in 5 minutes -- [Local LLM](./local-llm.md) - Offline AI with llama.cpp -- [Buying Guide](./buying-guide.md) - Choose your first SBC - -### Deployment Options - -| Platform | Use Case | Requirements | -|----------|----------|--------------| -| **Android/HarmonyOS** | Smartphones, tablets, kiosks | Any Android 8+ device | -| **Raspberry Pi** | IoT, displays, terminals | 1GB+ RAM | -| **Orange Pi** | Full offline AI | 4GB+ RAM for LLM | -| **Industrial** | Factory, retail, healthcare | Any ARM/x86 SBC | diff --git a/src/13-hardware-devices/hardware.md b/src/13-hardware-devices/hardware.md deleted file mode 100644 index 5e2e3401..00000000 --- a/src/13-hardware-devices/hardware.md +++ /dev/null @@ -1,159 +0,0 @@ -# Supported Hardware - -## Single Board Computers (SBCs) - -### Recommended Boards - -| Board | CPU | RAM | Best For | Price | -|-------|-----|-----|----------|-------| -| **Orange Pi 5** | RK3588S | 4-16GB | Full LLM, NPU accel | $89-149 | -| **Raspberry Pi 5** | BCM2712 | 4-8GB | General purpose | $60-80 | -| **Orange Pi Zero 3** | H618 | 1-4GB | Minimal deployments | $20-35 | -| **Raspberry Pi 4** | BCM2711 | 2-8GB | Established ecosystem | $45-75 | -| **Raspberry Pi Zero 2W** | RP3A0 | 512MB | Ultra-compact | $15 | -| **Rock Pi 4** | RK3399 | 4GB | NPU available | $75 | -| **NVIDIA Jetson Nano** | Tegra X1 | 4GB | GPU inference | $149 | -| **BeagleBone Black** | AM3358 | 512MB | Industrial | $55 | -| **LattePanda 3 Delta** | N100 | 8GB | x86 compatibility | $269 | -| **ODROID-N2+** | S922X | 4GB | High performance | $79 | - -### Minimum Requirements - -**For UI only (connect to remote botserver):** -- Any ARM/x86 Linux board -- 256MB RAM -- Network connection -- Display output - -**For local botserver:** -- ARM64 or x86_64 -- 1GB RAM minimum -- 4GB storage - -**For local LLM (llama.cpp):** -- ARM64 or x86_64 -- 2GB+ RAM (4GB recommended) -- 2GB+ storage for model - -### Orange Pi 5 (Recommended for LLM) - -The Orange Pi 5 with RK3588S is ideal for embedded LLM: - -Orange Pi 5 Specifications - -## Displays - -### Character LCDs (Minimal) - -For text-only interfaces: - -| Display | Resolution | Interface | Use Case | -|---------|------------|-----------|----------| -| HD44780 16x2 | 16 chars × 2 lines | I2C/GPIO | Status, simple Q&A | -| HD44780 20x4 | 20 chars × 4 lines | I2C/GPIO | More context | -| LCD2004 | 20 chars × 4 lines | I2C | Industrial | - -**Example output on 16x2:** Simple text display showing user prompt and bot status. - -### OLED Displays - -For graphical monochrome interfaces: - -| Display | Resolution | Interface | Size | -|---------|------------|-----------|------| -| SSD1306 | 128×64 | I2C/SPI | 0.96" | -| SSD1309 | 128×64 | I2C/SPI | 2.42" | -| SH1106 | 128×64 | I2C/SPI | 1.3" | -| SSD1322 | 256×64 | SPI | 3.12" | - -### TFT/IPS Color Displays - -For full graphical interface: - -| Display | Resolution | Interface | Notes | -|---------|------------|-----------|-------| -| ILI9341 | 320×240 | SPI | Common, cheap | -| ST7789 | 240×320 | SPI | Fast refresh | -| ILI9488 | 480×320 | SPI | Larger | -| Waveshare 5" | 800×480 | HDMI | Touch optional | -| Waveshare 7" | 1024×600 | HDMI | Touch, IPS | -| Official Pi 7" | 800×480 | DSI | Best for Pi | - -### E-Ink/E-Paper - -For low-power, readable in sunlight: - -| Display | Resolution | Colors | Refresh | -|---------|------------|--------|---------| -| Waveshare 2.13" | 250×122 | B/W | 2s | -| Waveshare 4.2" | 400×300 | B/W | 4s | -| Waveshare 7.5" | 800×480 | B/W | 5s | -| Good Display 9.7" | 1200×825 | B/W | 6s | - -**Best for:** Menu displays, signs, low-update applications - -### Industrial Displays - -| Display | Resolution | Features | -|---------|------------|----------| -| Advantech | Various | Wide temp, sunlight | -| Winstar | Various | Industrial grade | -| Newhaven | Various | Long availability | - -## Input Devices - -### Keyboards - -- **USB Keyboard** - Standard, any USB keyboard works -- **PS/2 Keyboard** - Via adapter, lower latency -- **Matrix Keypad** - 4x4 or 3x4, GPIO connected -- **I2C Keypad** - Fewer GPIO pins needed - -### Touch Input - -- **Capacitive Touch** - Better response, needs driver -- **Resistive Touch** - Works with gloves, pressure-based -- **IR Touch Frame** - Large displays, vandal-resistant - -### Buttons & GPIO - -GPIO Button Interface - -## Enclosures - -### Commercial Options - -- **Hammond Manufacturing** - Industrial metal enclosures -- **Polycase** - Plastic, IP65 rated -- **Bud Industries** - Various sizes -- **Pi-specific cases** - Argon, Flirc, etc. - -### DIY Options - -- **3D Printed** - Custom fit, PLA/PETG -- **Laser Cut** - Acrylic, wood -- **Metal Fabrication** - Professional look - -## Power - -### Power Requirements - -| Configuration | Power | Recommended PSU | -|---------------|-------|-----------------| -| Pi Zero + LCD | 1-2W | 5V 1A | -| Pi 4 + Display | 5-10W | 5V 3A | -| Orange Pi 5 | 8-15W | 5V 4A or 12V 2A | -| With NVMe SSD | +2-3W | Add 1A headroom | - -### Power Options - -- **USB-C PD** - Modern, efficient -- **PoE HAT** - Power over Ethernet -- **12V Barrel** - Industrial standard -- **Battery** - UPS, solar applications - -### UPS Solutions - -- **PiJuice** - Pi-specific UPS HAT -- **UPS PIco** - Small form factor -- **Powerboost** - Adafruit, lithium battery diff --git a/src/13-hardware-devices/local-llm.md b/src/13-hardware-devices/local-llm.md deleted file mode 100644 index 440c0c46..00000000 --- a/src/13-hardware-devices/local-llm.md +++ /dev/null @@ -1,365 +0,0 @@ -# Local LLM - Offline AI with llama.cpp - -Run AI inference completely offline on embedded devices. No internet, no API costs, full privacy. - -## Overview - -Local LLM Architecture - -## Recommended Models - -### By Device RAM - -| RAM | Model | Size | Speed | Quality | -|-----|-------|------|-------|---------| -| **2GB** | TinyLlama 1.1B Q4_K_M | 670MB | ~5 tok/s | Basic | -| **4GB** | Phi-2 2.7B Q4_K_M | 1.6GB | ~3-4 tok/s | Good | -| **4GB** | Gemma 2B Q4_K_M | 1.4GB | ~4 tok/s | Good | -| **8GB** | Llama 3.2 3B Q4_K_M | 2GB | ~3 tok/s | Better | -| **8GB** | Mistral 7B Q4_K_M | 4.1GB | ~2 tok/s | Great | -| **16GB** | Llama 3.1 8B Q4_K_M | 4.7GB | ~2 tok/s | Excellent | - -### By Use Case - -**Simple Q&A, Commands:** -``` -TinyLlama 1.1B - Fast, basic understanding -``` - -**Customer Service, FAQ:** -``` -Phi-2 or Gemma 2B - Good comprehension, reasonable speed -``` - -**Complex Reasoning:** -``` -Llama 3.2 3B or Mistral 7B - Better accuracy, slower -``` - -## Installation - -### Automatic (via deploy script) - -```bash -./scripts/deploy-embedded.sh pi@device --with-llama -``` - -### Manual Installation - -```bash -# SSH to device -ssh pi@raspberrypi.local - -# Install dependencies -sudo apt update -sudo apt install -y build-essential cmake git wget - -# Clone llama.cpp -cd /opt -sudo git clone https://github.com/ggerganov/llama.cpp -sudo chown -R $(whoami):$(whoami) llama.cpp -cd llama.cpp - -# Build for ARM (auto-optimizes) -mkdir build && cd build -cmake .. -DLLAMA_NATIVE=ON -DCMAKE_BUILD_TYPE=Release -make -j$(nproc) - -# Download model -mkdir -p /opt/llama.cpp/models -cd /opt/llama.cpp/models -wget https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/resolve/main/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf -``` - -### Start Server - -```bash -# Test run -/opt/llama.cpp/build/bin/llama-server \ - -m /opt/llama.cpp/models/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf \ - --host 0.0.0.0 \ - --port 8080 \ - -c 2048 \ - --threads 4 - -# Verify -curl http://localhost:9000/v1/models -``` - -### Systemd Service - -Create `/etc/systemd/system/llama-server.service`: - -```ini -[Unit] -Description=llama.cpp Server - Local LLM -After=network.target - -[Service] -Type=simple -User=root -WorkingDirectory=/opt/llama.cpp -ExecStart=/opt/llama.cpp/build/bin/llama-server \ - -m /opt/llama.cpp/models/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf \ - --host 0.0.0.0 \ - --port 8080 \ - -c 2048 \ - -ngl 0 \ - --threads 4 -Restart=always -RestartSec=5 - -[Install] -WantedBy=multi-user.target -``` - -Enable and start: -```bash -sudo systemctl daemon-reload -sudo systemctl enable llama-server -sudo systemctl start llama-server -``` - -## Configuration - -### botserver .env - -```env -# Use local llama.cpp -LLM_PROVIDER=llamacpp -LLM_API_URL=http://127.0.0.1:9000 -LLM_MODEL=tinyllama - -# Memory limits -MAX_CONTEXT_TOKENS=2048 -MAX_RESPONSE_TOKENS=512 -STREAMING_ENABLED=true -``` - -### llama.cpp Parameters - -| Parameter | Default | Description | -|-----------|---------|-------------| -| `-c` | 2048 | Context size (tokens) | -| `--threads` | 4 | CPU threads | -| `-ngl` | 0 | GPU layers (0 for CPU only) | -| `--host` | 127.0.0.1 | Bind address | -| `--port` | 8080 | Server port | -| `-b` | 512 | Batch size | -| `--mlock` | off | Lock model in RAM | - -### Memory vs Context Size - -``` -Context 512: ~400MB RAM, fast, limited conversation -Context 1024: ~600MB RAM, moderate -Context 2048: ~900MB RAM, good for most uses -Context 4096: ~1.5GB RAM, long conversations -``` - -## Performance Optimization - -### CPU Optimization - -```bash -# Check CPU features -cat /proc/cpuinfo | grep -E "(model name|Features)" - -# Build with specific optimizations -cmake .. -DLLAMA_NATIVE=ON \ - -DCMAKE_BUILD_TYPE=Release \ - -DLLAMA_ARM_FMA=ON \ - -DLLAMA_ARM_DOTPROD=ON -``` - -### Memory Optimization - -```bash -# For 2GB RAM devices -# Use smaller context --c 1024 - -# Use memory mapping (slower but less RAM) ---mmap - -# Disable mlock (don't pin to RAM) -# (default is disabled) -``` - -### Swap Configuration - -For devices with limited RAM: - -```bash -# Create 2GB swap -sudo fallocate -l 2G /swapfile -sudo chmod 600 /swapfile -sudo mkswap /swapfile -sudo swapon /swapfile - -# Make permanent -echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab - -# Optimize swap usage -echo 'vm.swappiness=10' | sudo tee -a /etc/sysctl.conf -``` - -## NPU Acceleration (Orange Pi 5) - -Orange Pi 5 has a 6 TOPS NPU that can accelerate inference: - -### Using rkllm (Rockchip NPU) - -```bash -# Install rkllm runtime -git clone https://github.com/airockchip/rknn-llm -cd rknn-llm -./install.sh - -# Convert model to RKNN format -python3 convert_model.py \ - --model tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf \ - --output tinyllama.rkllm - -# Run with NPU -rkllm-server \ - --model tinyllama.rkllm \ - --port 8080 -``` - -Expected speedup: **3-5x faster** than CPU only. - -## Model Download URLs - -### TinyLlama 1.1B (Recommended for 2GB) -```bash -wget https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/resolve/main/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf -``` - -### Phi-2 2.7B (Recommended for 4GB) -```bash -wget https://huggingface.co/TheBloke/phi-2-GGUF/resolve/main/phi-2.Q4_K_M.gguf -``` - -### Gemma 2B -```bash -wget https://huggingface.co/bartowski/gemma-2-2b-it-GGUF/resolve/main/gemma-2-2b-it-Q4_K_M.gguf -``` - -### Llama 3.2 3B (Recommended for 8GB) -```bash -wget https://huggingface.co/bartowski/Llama-3.2-3B-Instruct-GGUF/resolve/main/Llama-3.2-3B-Instruct-Q4_K_M.gguf -``` - -### Mistral 7B -```bash -wget https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.2-GGUF/resolve/main/mistral-7b-instruct-v0.2.Q4_K_M.gguf -``` - -## API Usage - -llama.cpp exposes an OpenAI-compatible API: - -### Chat Completion - -```bash -curl http://localhost:9000/v1/chat/completions \ - -H "Content-Type: application/json" \ - -d '{ - "model": "tinyllama", - "messages": [ - {"role": "user", "content": "What is 2+2?"} - ], - "max_tokens": 100 - }' -``` - -### Streaming - -```bash -curl http://localhost:9000/v1/chat/completions \ - -H "Content-Type: application/json" \ - -d '{ - "model": "tinyllama", - "messages": [{"role": "user", "content": "Tell me a story"}], - "stream": true - }' -``` - -### Health Check - -```bash -curl http://localhost:9000/health -curl http://localhost:9000/v1/models -``` - -## Monitoring - -### Check Performance - -```bash -# Watch resource usage -htop - -# Check inference speed in logs -sudo journalctl -u llama-server -f | grep "tokens/s" - -# Memory usage -free -h -``` - -### Benchmarking - -```bash -# Run llama.cpp benchmark -/opt/llama.cpp/build/bin/llama-bench \ - -m /opt/llama.cpp/models/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf \ - -p 512 -n 128 -t 4 -``` - -## Troubleshooting - -### Model Loading Fails - -```bash -# Check available RAM -free -h - -# Try smaller context --c 512 - -# Use memory mapping ---mmap -``` - -### Slow Inference - -```bash -# Increase threads (up to CPU cores) ---threads $(nproc) - -# Use optimized build -cmake .. -DLLAMA_NATIVE=ON - -# Consider smaller model -``` - -### Out of Memory Killer - -```bash -# Check if OOM killed the process -dmesg | grep -i "killed process" - -# Increase swap -# Use smaller model -# Reduce context size -``` - -## Best Practices - -1. **Start small** - Begin with TinyLlama, upgrade if needed -2. **Monitor memory** - Use `htop` during initial tests -3. **Set appropriate context** - 1024-2048 for most embedded use -4. **Use quantized models** - Q4_K_M is a good balance -5. **Enable streaming** - Better UX on slow inference -6. **Test offline** - Verify it works without internet before deployment diff --git a/src/13-hardware-devices/quick-start.md b/src/13-hardware-devices/quick-start.md deleted file mode 100644 index 3354d769..00000000 --- a/src/13-hardware-devices/quick-start.md +++ /dev/null @@ -1,209 +0,0 @@ -# Quick Start - Deploy in 5 Minutes - -Get General Bots running on your embedded device with local AI in just a few commands. - -## Prerequisites - -- An SBC (Raspberry Pi, Orange Pi, etc.) with Armbian/Raspbian -- SSH access to the device -- Internet connection (for initial setup only) - -## One-Line Deploy - -From your development machine: - -```bash -# Clone and run the deployment script -git clone https://github.com/GeneralBots/botserver.git -cd botserver - -# Deploy to Orange Pi (replace with your device IP) -./scripts/deploy-embedded.sh orangepi@192.168.1.100 --with-ui --with-llama -``` - -That's it! After ~10-15 minutes: -- botserver runs on port 9000 -- llama.cpp runs on port 8081 with TinyLlama -- Embedded UI available at `http://your-device:9000/embedded/` - -## Step-by-Step Guide - -### Step 1: Prepare Your Device - -Flash your SBC with a compatible OS: - -**Raspberry Pi:** -```bash -# Download Raspberry Pi Imager -# Select: Raspberry Pi OS Lite (64-bit) -# Enable SSH in settings -``` - -**Orange Pi:** -```bash -# Download Armbian from armbian.com -# Flash with balenaEtcher -``` - -### Step 2: First Boot Configuration - -```bash -# SSH into your device -ssh pi@raspberrypi.local # or orangepi@orangepi.local - -# Update system -sudo apt update && sudo apt upgrade -y - -# Set timezone -sudo timedatectl set-timezone America/Sao_Paulo - -# Enable I2C/SPI if using GPIO displays -sudo raspi-config # or armbian-config -``` - -### Step 3: Run Deployment Script - -From your development PC: - -```bash -# Basic deployment (botserver only) -./scripts/deploy-embedded.sh pi@raspberrypi.local - -# With embedded UI -./scripts/deploy-embedded.sh pi@raspberrypi.local --with-ui - -# With local LLM (requires 4GB+ RAM) -./scripts/deploy-embedded.sh pi@raspberrypi.local --with-ui --with-llama - -# Specify a different model -./scripts/deploy-embedded.sh pi@raspberrypi.local --with-llama --model phi-2-Q4_K_M.gguf -``` - -### Step 4: Verify Installation - -```bash -# Check services -ssh pi@raspberrypi.local 'sudo systemctl status botserver' -ssh pi@raspberrypi.local 'sudo systemctl status llama-server' - -# Test botserver -curl http://raspberrypi.local:9000/health - -# Test llama.cpp -curl http://raspberrypi.local:9000/v1/models -``` - -### Step 5: Access the Interface - -Open in your browser: -``` -http://raspberrypi.local:9000/embedded/ -``` - -Or set up kiosk mode (auto-starts on boot): -```bash -# Already configured if you used --with-ui -# Just reboot: -ssh pi@raspberrypi.local 'sudo reboot' -``` - -## Local Installation (On the Device) - -If you prefer to install directly on the device: - -```bash -# SSH into the device -ssh pi@raspberrypi.local - -# Install Rust -curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -source ~/.cargo/env - -# Clone and build -git clone https://github.com/GeneralBots/botserver.git -cd botserver - -# Run local deployment -./scripts/deploy-embedded.sh --local --with-ui --with-llama -``` - -⚠️ **Note:** Building on ARM devices is slow (1-2 hours). Cross-compilation is faster. - -## Configuration - -After deployment, edit the config file: - -```bash -ssh pi@raspberrypi.local -sudo nano /opt/botserver/.env -``` - -Key settings: -```env -# Server -HOST=0.0.0.0 -PORT=9000 - -# Local LLM -LLM_PROVIDER=llamacpp -LLM_API_URL=http://127.0.0.1:8081 -LLM_MODEL=tinyllama - -# Memory limits for small devices -MAX_CONTEXT_TOKENS=2048 -MAX_RESPONSE_TOKENS=512 -``` - -Restart after changes: -```bash -sudo systemctl restart botserver -``` - -## Troubleshooting - -### Out of Memory - -```bash -# Check memory usage -free -h - -# Reduce llama.cpp context -sudo nano /etc/systemd/system/llama-server.service -# Change -c 2048 to -c 1024 - -# Or use a smaller model -# TinyLlama uses ~700MB, Phi-2 uses ~1.6GB -``` - -### Service Won't Start - -```bash -# Check logs -sudo journalctl -u botserver -f -sudo journalctl -u llama-server -f - -# Common issues: -# - Port already in use -# - Missing model file -# - Database permissions -``` - -### Display Not Working - -```bash -# Check if display is detected -ls /dev/fb* # HDMI/DSI -ls /dev/i2c* # I2C displays -ls /dev/spidev* # SPI displays - -# For HDMI, check config -sudo nano /boot/config.txt # Raspberry Pi -sudo nano /boot/armbianEnv.txt # Orange Pi -``` - -## Next Steps - -- [Embedded UI Guide](./embedded-ui.md) - Customize the interface -- [Local LLM Configuration](./local-llm.md) - Optimize AI performance -- [Kiosk Mode](./kiosk-mode.md) - Production deployment -- [Offline Operation](./offline.md) - Disconnected environments diff --git a/src/14-migration/README.md b/src/14-migration/README.md deleted file mode 100644 index 95de60da..00000000 --- a/src/14-migration/README.md +++ /dev/null @@ -1,85 +0,0 @@ -# Chapter 14: Migration Guide - -Migrate from cloud services to self-hosted General Bots with complete data sovereignty. - -## Why Migrate? - -| Cloud Services | General Bots | -|----------------|--------------| -| Data on vendor servers | Data on YOUR servers | -| $40-60/user/month | ~$7/user/month | -| Vendor-controlled AI | Transparent, traceable logic | -| Black box processing | Extensible via BASIC | -| Subscription forever | One-time deployment | - -## Core Principles - -### Component Architecture - -Install only what you need: - -```bash -./botserver package install mail # Email -./botserver package install drive # Storage -./botserver package install directory # Users -./botserver package install meet # Video -``` - -### Standard Protocols - -- **Storage**: S3 API (MinIO) -- **Email**: SMTP/IMAP/JMAP -- **Auth**: OIDC/SAML/LDAP -- **Video**: WebRTC - -### Knowledge Base Integration - -```basic -USE KB "company_docs" -USE WEBSITE "https://sharepoint.company.com/docs" -' Documents now searchable via natural language -``` - -## Migration Timeline - -| Phase | Duration | Activities | -|-------|----------|------------| -| **Assessment** | Week 1-2 | Inventory services, identify dependencies | -| **Infrastructure** | Week 2-3 | Deploy botserver, configure auth/storage | -| **Data Migration** | Week 3-6 | Users, email, files, documents | -| **Process Migration** | Week 6-8 | Convert workflows to .gbdialog | -| **Validation** | Week 8-10 | Testing, training, documentation | -| **Cutover** | Week 10-12 | User migration, decommission old | - -## Migration Paths - -| Source | Guide | -|--------|-------| -| Microsoft 365 | [M365 Migration](./microsoft-365.md) | -| Google Workspace | [Google Migration](./google-workspace.md) | -| Dialogflow | [Dialogflow Migration](./dialogflow.md) | -| Botpress | [Botpress Migration](./botpress.md) | -| n8n / Zapier / Make | [Automation Migration](./zapier-make.md) | -| Notion | [Notion Migration](./notion.md) | - -## Prerequisites Checklist - -- [ ] Executive sponsorship -- [ ] Infrastructure provisioned -- [ ] Backup strategy defined -- [ ] Rollback plan documented -- [ ] User communication ready - -## Success Metrics - -- **Performance**: Response times, availability -- **Adoption**: User login frequency -- **Cost**: TCO reduction (target: 80%+) -- **Security**: Compliance achievement - -## See Also - -- [Common Concepts](./common-concepts.md) - Shared migration patterns -- [Comparison Matrix](./comparison-matrix.md) - Feature mapping -- [KB Migration](./kb-migration.md) - Document conversion -- [Validation](./validation.md) - Testing procedures \ No newline at end of file diff --git a/src/15-appendix/README.md b/src/15-appendix/README.md deleted file mode 100644 index 59373cf3..00000000 --- a/src/15-appendix/README.md +++ /dev/null @@ -1,52 +0,0 @@ -## Appendix I – Database Model - -Database Schema Overview - -The core database schema for GeneralBots is defined in `src/shared/models.rs`. It uses **Diesel** with PostgreSQL and includes the following primary tables: - -| Table | Description | -|-------|-------------| -| `users` | Stores user accounts, authentication tokens, and profile data. | -| `sessions` | Tracks active `BotSession` instances, their start/end timestamps, and associated user. | -| `knowledge_bases` | Metadata for each `.gbkb` collection (name, vector store configuration, creation date). | -| `messages` | Individual chat messages (role = user/assistant, content, timestamp, linked to a session). | -| `tools` | Registered custom tools per session (name, definition JSON, activation status). | -| `files` | References to files managed by the `.gbdrive` package (path, size, MIME type, storage location). | - -### Relationships -- **User ↔ Sessions** – One‑to‑many: a user can have many sessions. -- **Session ↔ Messages** – One‑to‑many: each session contains a sequence of messages. -- **Session ↔ KnowledgeBase** – Many‑to‑one: a session uses a single knowledge base at a time. -- **Session ↔ Tools** – One‑to‑many: tools are scoped to the session that registers them. -- **File ↔ KnowledgeBase** – Optional link for documents stored in a knowledge base. - -### Key Tables - -**User Table** -- id: Integer primary key -- username: String -- email: String -- password_hash: String -- created_at: Timestamp - -**Session Table** -- id: Integer primary key -- user_id: Foreign key to User -- started_at: Timestamp -- last_active: Timestamp -- knowledge_base_id: Integer - -**Message Table** -- id: Integer primary key -- session_id: Foreign key to Session -- role: String ("user" or "assistant") -- content: Text -- timestamp: Timestamp - -The schema is automatically migrated when the server starts. - ---- - -
- General Bots -
diff --git a/src/16-appendix-docs-style/conversation-examples.md b/src/16-appendix-docs-style/conversation-examples.md deleted file mode 100644 index 12f0e5e1..00000000 --- a/src/16-appendix-docs-style/conversation-examples.md +++ /dev/null @@ -1,235 +0,0 @@ -# Conversation Examples Style Guide - -> **Standard format for displaying bot-user conversations in documentation** - -## Overview - -All conversation examples in General Bots documentation use a WhatsApp-style chat format. This provides a consistent, familiar, and readable way to show bot interactions. - -## CSS Include - -The styling is defined in `/assets/wa-chat.css`. Include it in your mdBook or HTML output. - ---- - -## Basic Structure - -```html -
- - -
-``` - ---- - -## Message Types - -### Bot Message - -```html -
- -
-``` - -### User Message - -```html -
- -
-``` - ---- - -## Formatting Within Messages - -### Multiple Paragraphs - -```html -
-

You have 2 meetings scheduled:

-

• 2:00 PM - Team Standup (30 min)

-

• 4:00 PM - Project Review (1 hour)

- -
-``` - -### Bold Text - -```html -

Name: John Smith

-

Email: john@example.com

-``` - -### Emoji Usage - -Emojis are encouraged to make conversations more expressive: - -| Purpose | Emoji Examples | -|---------|----------------| -| Success | ✅ ✓ 🎉 | -| Warning | ⚠️ ⚡ | -| Error | ❌ 🔴 | -| Info | ℹ️ 📋 | -| File | 📄 📁 📎 | -| Calendar | 📅 🗓️ | -| Email | 📧 ✉️ | -| Person | 👤 👥 | -| Time | 🕐 ⏱️ | - -### File Attachments - -```html -
- -
-``` - -### Action Buttons (visual representation) - -```html -

[📧 Send] [✏️ Edit] [🗑 Discard]

-``` - ---- - -## Complete Example - -```html -
- - -
-``` - -**Rendered Output:** - -
- - -
- ---- - -## Variants - -### Full Width - -Add `wa-full-width` class for wider conversations: - -```html -
- ... -
-``` - -### Compact - -Add `wa-compact` class for tighter spacing: - -```html -
- ... -
-``` - -### Hide Timestamps - -Add `wa-no-time` class to hide timestamps: - -```html -
- ... -
-``` - ---- - -## Best Practices - -1. **Keep messages concise** - Break long bot responses into multiple paragraphs -2. **Use consistent timestamps** - Use realistic times (10:30, 10:31, etc.) -3. **Start with user context** - Show what the user asked before the bot response -4. **Include visual feedback** - Use emojis for status (✅, ❌, 📋) -5. **Show realistic flows** - Include multi-turn conversations when appropriate -6. **Use semantic formatting** - Bold for labels, lists for options - ---- - -## Files Using This Format - -This format is used throughout the documentation: - -- `chapter-02/template-crm-contacts.md` -- `chapter-04-gbui/apps/*.md` -- `chapter-06-gbdialog/basic-vs-automation-tools.md` -- And many more... - ---- - -## See Also - -- [UI Structure](../chapter-04-gbui/ui-structure.md) -- [Chat App Documentation](../chapter-04-gbui/apps/chat.md) - - \ No newline at end of file diff --git a/src/16-appendix-docs-style/svg.md b/src/16-appendix-docs-style/svg.md deleted file mode 100644 index deed09ed..00000000 --- a/src/16-appendix-docs-style/svg.md +++ /dev/null @@ -1,289 +0,0 @@ -# Documentation Style Standards - -All interface layouts in this documentation use SVG-based wireframe representations for screenshots and diagrams. Conversation examples use the WhatsApp-style HTML format for consistent, visually appealing rendering. - ---- - -## Interface Wireframes (SVG) - -All interface screenshots and layouts should use SVG wireframes located in `/assets/`. - -### Directory Structure - -``` -assets/ -├── suite/ -│ ├── chat-screen.svg -│ ├── drive-screen.svg -│ ├── calendar-screen.svg -│ ├── mail-screen.svg -│ ├── tasks-screen.svg -│ ├── meet-screen.svg -│ ├── live-monitoring-organism.svg -│ └── ... -├── chapter-01/ -│ ├── bootstrap-process.svg -│ └── session-states.svg -└── chapter-04/ - └── analytics-interface.svg -``` - -### Referencing SVG Wireframes - -Use standard HTML image syntax with responsive styling: - -```html -Chat Interface -``` - ---- - -## SVG Theme Transparency Guidelines - -All SVGs MUST be theme-agnostic and work with light/dark modes. Follow these requirements: - -### Required CSS Media Query - -Every SVG must include a ` -``` - -### Background Transparency - -- Use `fill="#FAFBFC"` for light backgrounds (subtle, not pure white) -- Add dot pattern overlay for texture: `fill="url(#dots)"` with low opacity -- Cards use `fill="#FFFFFF"` with border strokes for definition -- **NEVER** use pure black (`#000000`) backgrounds - -### Color Palette (Theme-Safe) - -| Purpose | Light Mode | Dark Mode Adaptation | -|---------|------------|---------------------| -| Title text | `#1E1B4B` | `#F1F5F9` (via CSS) | -| Main text | `#334155` | `#E2E8F0` (via CSS) | -| Secondary text | `#64748B` | `#94A3B8` (via CSS) | -| Mono/code text | `#475569` | `#CBD5E1` (via CSS) | -| Card backgrounds | `#FFFFFF` | Keep white (contrast) | -| Borders | `#E2E8F0` | Keep (works both) | - -### Standard Gradients - -Use these gradient IDs consistently across all SVGs: - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -### DO NOT - -- ❌ Hardcode text colors without CSS class -- ❌ Use pure black (`#000000`) or pure white (`#FFFFFF`) for text -- ❌ Forget the `@media (prefers-color-scheme: dark)` block -- ❌ Use opaque backgrounds that don't adapt -- ❌ Create new gradient IDs when standard ones exist - -### DO - -- ✅ Use CSS classes for all text elements -- ✅ Include dark mode media query in every SVG -- ✅ Use standard gradient IDs from the palette -- ✅ Test SVGs in both light and dark browser modes -- ✅ Use subtle shadows with low opacity (`0.15`) -- ✅ Keep white cards for contrast in both modes - ---- - -## Conversation Examples (WhatsApp Style) - -All conversation examples throughout the book use the WhatsApp-style HTML format. This provides a familiar, visually consistent representation of bot interactions. - -### Standard Format - -```html -
- - -
-``` - -### Complete Example - -```html -
- - - - - -
-``` - -### Message Classes - -| Class | Usage | -|-------|-------| -| `wa-chat` | Container for the conversation | -| `wa-message` | Individual message wrapper | -| `wa-message user` | User message (right-aligned, colored) | -| `wa-message bot` | Bot message (left-aligned) | -| `wa-bubble` | Message bubble with styling | -| `wa-time` | Timestamp display | - -### Formatting Guidelines - -1. **User messages** — Use `wa-message user` class -2. **Bot messages** — Use `wa-message bot` class -3. **Timestamps** — Include `wa-time` div with realistic times -4. **Multi-line responses** — Use separate `

` tags for each line -5. **Emojis** — Use sparingly for status indicators (✅, ❌, 📧, 📅, 📁) -6. **Bold text** — Use `` for emphasis -7. **Attachments** — Indicate with 📎 emoji and filename - -### File Attachments Example - -```html -

- - -
-``` - ---- - -## CSS Styling - -The WhatsApp chat styling is defined in `whatsapp-chat.css` and automatically included in the book build. The styles provide: - -- Familiar messaging app appearance -- Proper alignment (user right, bot left) -- Bubble styling with shadows -- Responsive layout -- Timestamp formatting - ---- - -## When to Use Each Format - -| Content Type | Format | -|--------------|--------| -| Interface screenshots | SVG wireframe | -| System architecture | SVG diagram | -| Data flow diagrams | SVG diagram | -| Bot conversations | WhatsApp HTML | -| API examples | Code blocks | -| Configuration | Code blocks | - ---- - -## Global Conversation Style Reference - -For all conversation examples throughout the book, follow the format established in: - -**[BASIC vs Automation Tools](../chapter-06-gbdialog/basic-vs-automation-tools.md)** - -This document serves as the canonical reference for: - -- Conversation formatting -- Multi-channel message representation -- Bot response styling -- User input examples - ---- - -## See Also - -- [Conversation Examples](./conversation-examples.md) — Example patterns -- [BASIC vs Automation Tools](../chapter-06-gbdialog/basic-vs-automation-tools.md) — Canonical conversation style -- [Chapter 04 Apps](../chapter-04-gbui/apps/README.md) — Interface documentation \ No newline at end of file diff --git a/src/17-autonomous-tasks/vibe-database.md b/src/17-autonomous-tasks/vibe-database.md deleted file mode 100644 index ad02b444..00000000 --- a/src/17-autonomous-tasks/vibe-database.md +++ /dev/null @@ -1,164 +0,0 @@ -# Vibe Database - -Visual PostgreSQL schema browser and SQL editor. - -![Vibe Database](./assets/vibe/database.png) - ---- - -## Overview - -Vibe Database provides a visual interface for exploring your bot's PostgreSQL database. View tables, relationships, run queries, and manage data. - ---- - -## Quick Start - -1. Click **Database** button in Vibe window -2. Browse tables in left panel -3. Click table to see schema -4. Run SQL queries in editor - ---- - -## Features - -### Schema Browser -- List all tables in database -- View column definitions -- See data types and constraints -- View indexes and foreign keys - -### Table Viewer -- Browse table data -- Filter and sort -- Pagination controls -- Export to CSV - -### SQL Editor -- Write and execute queries -- Syntax highlighting -- Query history -- Results visualization - -### Relationship Viewer -- Visual foreign key relationships -- ER diagram view -- Click to navigate related tables - ---- - -## Interface - -### Left Panel - Tables List -``` -📦 customers - ├─ id (UUID, PK) - ├─ name (VARCHAR) - ├─ email (VARCHAR, UNIQUE) - ├─ created_at (TIMESTAMP) - └─ updated_at (TIMESTAMP) - -📦 orders - ├─ id (UUID, PK) - ├─ customer_id (UUID, FK → customers) - ├─ total (DECIMAL) - ├─ status (VARCHAR) - └─ created_at (TIMESTAMP) -``` - -### Main Panel - Table Data -| id | name | email | created_at | -|----|------|-------|------------| -| xxx | John | john@... | 2024-01-01 | -| xxx | Jane | jane@... | 2024-01-02 | - ---- - -## SQL Query Examples - -### Select All -```sql -SELECT * FROM customers; -``` - -### Join Tables -```sql -SELECT o.id, c.name, o.total -FROM orders o -JOIN customers c ON o.customer_id = c.id; -``` - -### Insert -```sql -INSERT INTO customers (name, email) -VALUES ('New Customer', 'new@example.com'); -``` - -### Update -```sql -UPDATE customers -SET name = 'Updated Name' -WHERE id = 'xxx'; -``` - -### Delete -```sql -DELETE FROM customers -WHERE id = 'xxx'; -``` - ---- - -## Keyboard Shortcuts - -| Shortcut | Action | -|----------|--------| -| `Ctrl+Enter` | Execute query | -| `Ctrl+S` | Save query | -| `Ctrl+L` | Clear editor | -| `Ctrl+H` | Toggle history | - ---- - -## Configuration - -### Connection Settings -The database connects using bot configuration: -- Host: PostgreSQL server -- Port: 5432 -- Database: `{bot_id}_botserver` -- User: Configured in bot settings - -### Query Limits -- Default: 100 rows -- Configurable: 10 - 10000 rows -- Export: Unlimited - ---- - -## Security - -- Read-only mode available -- SQL injection protection -- Query logging for audit -- Row-level access control - ---- - -## Troubleshooting - -### Connection Failed -- Check PostgreSQL is running -- Verify bot has database credentials -- Check network connectivity - -### Query Error -- Check SQL syntax -- Verify table/column names -- Review error message details - -### No Tables Visible -- Bot may have no tables yet -- AI hasn't generated database schema -- Try creating app first diff --git a/src/17-autonomous-tasks/vibe-editor.md b/src/17-autonomous-tasks/vibe-editor.md deleted file mode 100644 index e2b06fe4..00000000 --- a/src/17-autonomous-tasks/vibe-editor.md +++ /dev/null @@ -1,147 +0,0 @@ -# Vibe Editor - -Monaco-powered code editor with full IDE features. - -![Vibe Editor](./assets/vibe/editor.png) - ---- - -## Overview - -The Vibe Editor is based on Monaco (the same editor that powers VS Code). It provides a full IDE experience with syntax highlighting, IntelliSense, multi-file editing, and more. - ---- - -## Features - -### Syntax Highlighting -Supports 70+ languages including: -- JavaScript/TypeScript -- Python -- Rust -- Go -- HTML/CSS -- SQL -- JSON/YAML -- And many more - -### IntelliSense -- Auto-completion -- Parameter hints -- Signature help -- Quick fixes - -### Multi-Cursor Editing -- `Ctrl+D` - Select next occurrence -- `Alt+Click` - Add cursor -- `Ctrl+Alt+Down` - Add line below - -### Search & Replace -- `Ctrl+F` - Find -- `Ctrl+H` - Replace -- `Ctrl+Shift+F` - Find in files -- Regex support enabled - -### Minimap -- Code overview on right side -- Click to navigate -- Draggable viewport - ---- - -## Keyboard Shortcuts - -| Shortcut | Action | -|----------|--------| -| `Ctrl+S` | Save file | -| `Ctrl+P` | Quick open file | -| `Ctrl+Shift+P` | Command palette | -| `Ctrl+F` | Find | -| `Ctrl+H` | Replace | -| `Ctrl+Shift+F` | Find in files | -| `Ctrl+D` | Select next occurrence | -| `Alt+Up/Down` | Move line up/down | -| `Ctrl+/` | Toggle comment | -| `Ctrl+Shift+K` | Delete line | -| `Ctrl+Enter` | Insert line below | -| `Ctrl+Shift+Enter` | Insert line above | -| `F12` | Go to definition | -| `Ctrl+Space` | Trigger IntelliSense | - ---- - -## File Operations - -### Opening Files -- Click file in file tree -- `Ctrl+P` for quick open -- Drag and drop files - -### Saving Files -- `Ctrl+S` to save -- Auto-save on focus loss -- Shows unsaved indicator (dot on tab) - -### Creating Files -- Right-click in file tree -- New file button in toolbar - ---- - -## Workspace - -### File Tree -Located on the left side: -- Expand/collapse folders -- File icons by type -- Right-click context menu - -### Supported File Types -| Icon | Type | -|------|------| -| 📄 | Generic file | -| 📜 | Script (js, ts, py) | -| 🎨 | Style (css, scss) | -| 📦 | Config (json, yaml, toml) | -| 🔷 | Component (vue, svelte) | - ---- - -## Configuration - -### Theme -- Dark (default) -- Light -- High contrast - -### Font -- Fira Code (with ligatures) -- Customizable size -- Line height control - -### Editor Settings -```json -{ - "editor.fontSize": 14, - "editor.fontFamily": "Fira Code", - "editor.tabSize": 4, - "editor.minimap.enabled": true, - "editor.formatOnSave": true -} -``` - ---- - -## Integration - -### With Vibe Pipeline -The editor integrates with the Vibe AI pipeline: -1. AI generates code in editor -2. Review agent checks code -3. You can edit manually -4. Changes tracked in Git - -### With Terminal -- `Ctrl+`` - Toggle terminal panel -- Run code directly from editor -- See output in terminal diff --git a/src/17-autonomous-tasks/vibe-git.md b/src/17-autonomous-tasks/vibe-git.md deleted file mode 100644 index 23b72b6c..00000000 --- a/src/17-autonomous-tasks/vibe-git.md +++ /dev/null @@ -1,183 +0,0 @@ -# Vibe Git - -Git operations integrated with Forgejo ALM. - -![Vibe Git](./assets/vibe/git.png) - ---- - -## Overview - -Vibe Git provides visual Git operations for version control of your generated applications. Connect to Forgejo for remote operations. - ---- - -## Features - -### Local Operations -- Initialize repository -- Stage/unstage files -- Commit changes -- View diff -- Branch management - -### Remote Operations -- Push to Forgejo -- Pull from remote -- Fetch updates -- Create pull requests - -### History -- Commit log viewer -- Author and date display -- Message search -- File change history - ---- - -## Interface - -### Changes Panel -``` -Changes: - M index.html - A styles.css - D old-file.js - -Staged (2): - + styles.css - M index.html -``` - -### Commit History -``` -abc1234 (main) Add user authentication - John, 2h ago -def5678 Fix login validation - Jane, 5h ago -ghi9012 Initial commit - John, 1d ago -``` - ---- - -## Quick Start - -### 1. Initialize Repository -```bash -git init -``` - -### 2. Add Files -```bash -git add . -``` - -### 3. Commit -```bash -git commit -m "Initial commit" -``` - -### 4. Connect to Remote -```bash -git remote add origin https://forgejo.example/user/repo.git -git push -u origin main -``` - ---- - -## Git Commands - -### Status -```bash -git status -``` - -### Add Files -```bash -# Add specific file -git add file.txt - -# Add all changes -git add -A -``` - -### Commit -```bash -git commit -m "Your message" -``` - -### Push -```bash -git push origin main -``` - -### Pull -```bash -git pull origin main -``` - -### Branch -```bash -# List branches -git branch - -# Create branch -git branch feature-name - -# Switch branch -git checkout feature-name - -# Create and switch -git checkout -b feature-name -``` - -### Merge -```bash -git merge feature-name -``` - ---- - -## Forgejo Integration - -### Configure Remote -``` -Remote URL: https://forgejo.example/owner/repo.git -Username: Your Forgejo username -Token: Your API token -``` - -### Create Pull Request -1. Push branch to Forgejo -2. Click "Create PR" button -3. Fill title and description -4. Submit - ---- - -## Keyboard Shortcuts - -| Shortcut | Action | -|----------|--------| -| `Ctrl+S` | Stage current file | -| `Ctrl+Shift+S` | Stage all | -| `Ctrl+C` | Commit | -| `Ctrl+P` | Push | -| `Ctrl+U` | Pull | - ---- - -## Troubleshooting - -### Push Failed -- Check remote URL is correct -- Verify Forgejo credentials -- Check network connectivity - -### Merge Conflicts -- View conflicting files -- Edit to resolve -- Stage and commit - -### Empty History -- Repository may be new -- Check correct directory -- Verify .git exists diff --git a/src/17-autonomous-tasks/vibe-mcp.md b/src/17-autonomous-tasks/vibe-mcp.md deleted file mode 100644 index bc693bec..00000000 --- a/src/17-autonomous-tasks/vibe-mcp.md +++ /dev/null @@ -1,181 +0,0 @@ -# Vibe MCP - -Model Context Protocol integrations for extended AI capabilities. - -![Vibe MCP](./assets/vibe/mcp.png) - ---- - -## Overview - -MCP (Model Context Protocol) allows Vibe to connect to external tools and services. Extend AI capabilities with databases, APIs, and custom tools. - ---- - -## What is MCP? - -MCP is a protocol that lets AI models interact with external systems: -- **Filesystem** - Read/write local files -- **Database** - Query databases directly -- **HTTP** - Make API requests -- **Custom** - Your own tools - ---- - -## Supported Integrations - -### Filesystem -```json -{ - "name": "filesystem", - "type": "stdio", - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/dir"] -} -``` - -### PostgreSQL -```json -{ - "name": "postgres", - "type": "stdio", - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-postgres", "postgres://user:pass@localhost/db"] -} -``` - -### Browser Automation -```json -{ - "name": "browser", - "type": "stdio", - "command": "npx", - "args": ["-y", "@modelcontextprotocol/server-puppeteer"] -} -``` - ---- - -## Configuration - -### Add MCP Server - -1. Go to **Sources → MCP** -2. Click **Add Server** -3. Select server type or enter custom -4. Configure connection -5. Save and connect - -### Server Types - -| Type | Description | -|------|-------------| -| `stdio` | Local command-line tool | -| `sse` | Server-Sent Events endpoint | -| `websocket` | WebSocket connection | - ---- - -## Using MCP Tools - -### In Vibe Chat -``` -User: Show me all orders from the database - -AI: (uses postgres MCP to query) -Orders: -| id | customer | total | -|----|----------|-------| -| 1 | John | 99.00 | -``` - -### Available Actions - -- **Read** - Query data -- **Write** - Insert/Update/Delete -- **Search** - Full-text search -- **Analyze** - Run computations - ---- - -## MCP Panel - -Access MCP panel in Vibe: -1. Click **MCP** button in toolbar -2. View connected servers -3. Test tools -4. View logs - ---- - -## Creating Custom MCP Server - -### 1. Create Server Script -```javascript -// my-server.js -const { Server } = require('@modelcontextprotocol/sdk/server'); -const { StdioServerTransport } = require('@modelcontextprotocol/sdk/server/stdio'); - -const server = new Server({ - name: 'my-custom-server', - version: '1.0.0' -}, { - capabilities: { - tools: {} - } -}); - -server.setRequestHandler('tools/list', async () => { - return { - tools: [{ - name: 'my_tool', - description: 'Does something useful', - inputSchema: { - type: 'object', - properties: { - param: { type: 'string' } - } - } - }] - }; -}); - -server.setRequestHandler('tools/call', async (request) => { - const { name, arguments: args } = request.params; - if (name === 'my_tool') { - return { content: [{ type: 'text', text: 'Result' }] }; - } -}); - -const transport = new StdioServerTransport(); -await server.connect(transport); -``` - -### 2. Register in Vibe -```json -{ - "name": "my-server", - "type": "stdio", - "command": "node", - "args": ["/path/to/my-server.js"] -} -``` - ---- - -## Troubleshooting - -### Connection Failed -- Check server is installed -- Verify command/path -- Check logs for errors - -### Tool Not Working -- Verify input format -- Check server logs -- Test with simpler parameters - -### Server Not Listed -- Restart Vibe -- Check configuration -- Review server status diff --git a/src/17-autonomous-tasks/vibe-terminal.md b/src/17-autonomous-tasks/vibe-terminal.md deleted file mode 100644 index aa549a35..00000000 --- a/src/17-autonomous-tasks/vibe-terminal.md +++ /dev/null @@ -1,113 +0,0 @@ -# Vibe Terminal - -Full-featured terminal with isolated LXC containers for each session. - -![Vibe Terminal](./assets/vibe/terminal.png) - ---- - -## Overview - -The Vibe terminal provides an isolated Ubuntu 22.04 container for each session. Your commands run in a secure, sandboxed environment that is automatically created on connect and destroyed on disconnect. - ---- - -## Quick Start - -1. Click **Terminal** icon on desktop or in Vibe window -2. Terminal connects to a new LXC container -3. Type commands as normal bash shell - -```bash -$ pwd -/root -$ whoami -root -$ uname -a -Linux term-abc123 5.15.0 #1 SMP x86_64 GNU/Linux -``` - ---- - -## Features - -### Isolated Containers -- Each terminal session gets its own Ubuntu 22.04 container -- Containers are ephemeral - destroyed on disconnect -- Full root access within container - -### 256-Color Support -- Full xterm-256color support -- Works with vim, tmux, htop, etc. - -### WebSocket Protocol -- Connects via WebSocket for real-time I/O -- Automatic reconnection on disconnect -- Session persistence during network issues - ---- - -## API Endpoints - -| Method | Endpoint | Description | -|--------|----------|-------------| -| `WS` | `/api/terminal/ws?session_id=xxx` | Terminal WebSocket | -| `GET` | `/api/terminal/list` | List active terminals | -| `POST` | `/api/terminal/create` | Create new terminal | -| `POST` | `/api/terminal/kill` | Kill terminal session | - -### WebSocket Commands - -Send text to execute commands: -``` -ls -la -``` - -Special commands: -- `resize COLS ROWS` - Resize terminal -- `exit` - Close terminal session - ---- - -## Configuration - -### Container Settings - -The terminal uses these LXC commands: -- `lxc launch ubuntu:22.04 {name}` - Create container -- `lxc exec {name} -- bash` - Execute shell -- `lxc stop {name} -f` - Stop container -- `lxc delete {name} -f` - Delete container - -### Environment Variables - -| Variable | Default | Description | -|----------|---------|-------------| -| `TERM` | `xterm-256color` | Terminal type | - ---- - -## Troubleshooting - -### Connection Failed -- Check that LXC is installed and running -- Verify network connectivity -- Check botserver logs for errors - -### Container Won't Start -- Ensure LXC daemon is running: `systemctl status lxc` -- Check LXC configuration: `lxc list` -- Review container logs: `lxc info {name}` - -### Commands Not Working -- Container may have been destroyed - reconnect -- Check WebSocket connection status - ---- - -## Security - -- Container names are sanitized (alphanumeric + dash only) -- Containers are isolated from host network by default -- Sessions are cleaned up on disconnect -- No persistent storage between sessions diff --git a/src/17-autonomous-tasks/vibe.md b/src/17-autonomous-tasks/vibe.md deleted file mode 100644 index 540b2d6b..00000000 --- a/src/17-autonomous-tasks/vibe.md +++ /dev/null @@ -1,148 +0,0 @@ -# Vibe - AI-Powered Development Environment - -Vibe is the autonomous coding mode that transforms your development workflow. Describe what you want to build, and AI agents create it automatically. - -![Vibe Architecture](./assets/vibe/vibe-architecture.png) - ---- - -## Quick Start - -1. Click **Vibe** icon on desktop -2. Describe your project in the chat -3. Watch agents build, review, and deploy - -```bash -# Example: Create an e-commerce app -"Build an e-commerce app for handmade crafts with shopping cart" -``` - ---- - -## Pipeline Stages - -| Stage | Agent | Description | -|-------|-------|-------------| -| **PLAN** | Architect | Analyzes requirements, creates spec | -| **BUILD** | Developer | Generates code, creates database | -| **REVIEW** | Reviewer | Security scan, quality checks | -| **DEPLOY** | DevOps | Pushes to Forgejo, deploys | -| **MONITOR** | QA | Runs tests, validates | - ---- - -## Features - -### Monaco Editor -- Full IDE editing with syntax highlighting -- Multi-file workspace support -- File tree navigation - -### Database UI -- Visual PostgreSQL schema browser -- SQL query editor -- Table relationship viewer - -### Git Operations -- Branch management -- Commit history -- Pull/push to Forgejo - -### Terminal -- Isolated LXC container per session -- Full shell access -- Persistent workspace - -### Browser Automation -- Chromiumoxide integration -- Visual test runner -- Screenshot capture - -### MCP Integration -- Connect external tools -- AI model integration -- Custom tool definitions - ---- - -## BYOK (Bring Your Own Key) - -Configure your own LLM API keys in **Sources → API Keys**: - -- OpenAI -- Anthropic (Claude) -- Google Gemini -- Azure OpenAI -- OpenAI Compatible - ---- - -## Use Cases - -### 1. Rapid Prototyping -```bash -"Create a CRM with contacts, leads, and deal pipeline" -``` - -### 2. Full-Stack Apps -```bash -"Build an e-commerce store with cart, checkout, and Stripe payments" -``` - -### 3. Internal Tools -```bash -"Make an employee onboarding checklist app with approvals" -``` - -### 4. Data Dashboards -```bash -"Create a sales analytics dashboard with charts and exports" -``` - ---- - -## Architecture - -``` -┌─────────────────────────────────────────────────────────┐ -│ Vibe UI │ -│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ │ -│ │ PLAN │→ │ BUILD │→ │ REVIEW │→ │ DEPLOY │ │ -│ └─────────┘ └─────────┘ └─────────┘ └─────────┘ │ -└─────────────────────────────────────────────────────────┘ - ↓ -┌─────────────────────────────────────────────────────────┐ -│ Orchestrator (5 Agents) │ -│ Architect → Developer → Reviewer → QA → DevOps │ -└─────────────────────────────────────────────────────────┘ - ↓ -┌─────────────────────────────────────────────────────────┐ -│ BotServer │ -│ - AppGenerator (code gen) │ -│ - Database Manager │ -│ - File System │ -└─────────────────────────────────────────────────────────┘ -``` - ---- - -## Keyboard Shortcuts - -| Shortcut | Action | -|----------|--------| -| `Ctrl+S` | Save file | -| `Ctrl+P` | Quick open | -| `Ctrl+Shift+P` | Command palette | -| `Ctrl+`` | Toggle terminal | - ---- - -## Related Documentation - -- [Vibe Terminal](./vibe-terminal.md) - Isolated container terminal -- [Vibe Editor](./vibe-editor.md) - Monaco editor guide -- [Vibe Database](./vibe-database.md) - Database UI -- [Vibe Git](./vibe-git.md) - Git operations -- [Vibe MCP](./vibe-mcp.md) - MCP integrations -- [Designer](./designer.md) - Visual app editor -- [App Generation](./app-generation.md) - Code generation diff --git a/src/17-testing/README.md b/src/17-testing/README.md deleted file mode 100644 index e4c58b09..00000000 --- a/src/17-testing/README.md +++ /dev/null @@ -1,76 +0,0 @@ -# Testing - -General Bots uses a comprehensive testing framework including unit tests, integration tests, and end-to-end (E2E) tests to ensure platform reliability and quality. - -## Overview - -The testing strategy covers: - -- **Unit Tests** - Individual component testing -- **Integration Tests** - Service interaction testing -- **E2E Tests** - Complete user journey validation - -## Test Structure - -All tests are organized in the `bottest` package: - -``` -bottest/ -├── src/ # Test utilities and harness -├── tests/ -│ ├── unit/ # Unit tests -│ ├── integration/ # Integration tests -│ └── e2e/ # End-to-end tests -├── benches/ # Performance benchmarks -└── Cargo.toml -``` - -## Running Tests - -### All Tests -```bash -cd gb/bottest -cargo test -``` - -### Specific Test Types -```bash -# Unit tests -cargo test --lib - -# Integration tests -cargo test --test integration - -# E2E tests -cargo test --test e2e -- --nocapture -``` - -## Test Harness - -The test harness provides utilities for setting up test environments: - -```rust -use bottest::prelude::*; - -#[tokio::test] -async fn my_test() { - let ctx = TestHarness::full().await.unwrap(); - // Test code here - ctx.cleanup().await.unwrap(); -} -``` - -## Continuous Integration - -Tests run automatically on: -- Pull requests -- Commits to main branch -- Pre-release checks - -See the repository's CI/CD configuration for details. - -## Next Steps - -- [End-to-End Testing](./e2e-testing.md) - Browser automation and user flow testing -- [Performance Testing](./performance.md) - Benchmarking and profiling -- [Test Architecture](./architecture.md) - Design patterns and best practices \ No newline at end of file diff --git a/src/19-maintenance/README.md b/src/19-maintenance/README.md deleted file mode 100644 index 1c5487d1..00000000 --- a/src/19-maintenance/README.md +++ /dev/null @@ -1,79 +0,0 @@ -# Chapter 19: Maintenance and Updates - -botserver includes a complete stack of self-hosted services that power your bots. This chapter covers how to maintain, update, and troubleshoot these components. - -## Stack Components Overview - -botserver automatically installs and manages these services: - -| Component | Service | Default Port | Purpose | -|-----------|---------|--------------|---------| -| **vault** | HashiCorp Vault | 8200 | Secrets management | -| **tables** | PostgreSQL | 5432 | Primary database | -| **directory** | Zitadel | 8080 | Identity & access management | -| **drive** | MinIO | 9000, 9001 | Object storage (S3-compatible) | -| **cache** | Valkey | 6379 | In-memory cache (Redis-compatible) | -| **llm** | llama.cpp | 8081, 8082 | Local LLM & embedding server | -| **email** | Stalwart | 25, 993 | Mail server | -| **proxy** | Caddy | 443, 80 | HTTPS reverse proxy | -| **dns** | CoreDNS | 53 | Local DNS resolution | -| **alm** | Forgejo | 3000 | Git repository (ALM) | -| **alm_ci** | Forgejo Runner | - | CI/CD runner | -| **meeting** | LiveKit | 7880 | Video conferencing | - -## Directory Structure - -``` -botserver-stack/ -├── bin/ # Service binaries -│ ├── vault/ -│ ├── tables/ -│ ├── drive/ -│ ├── cache/ -│ ├── llm/ -│ └── ... -├── conf/ # Configuration files -├── data/ # Persistent data -└── logs/ # Service logs - -botserver-installers/ # Downloaded archives (cache) -``` - -## Why Self-Hosted? - -1. **Privacy** - Data never leaves your infrastructure -2. **Offline** - Works without internet after initial setup -3. **Cost** - No per-user or API fees -4. **Control** - Full access to all services -5. **Compliance** - Meet data residency requirements - -## Chapter Contents - -- [CLI Reference](./cli-reference.md) - Command-line interface for botserver -- [Updating Components](./updating-components.md) - How to update individual services -- [Component Reference](./component-reference.md) - Detailed info for each component -- [Security Auditing](./security-auditing.md) - Running security audits -- [Backup and Recovery](./backup-recovery.md) - Data protection strategies -- [Troubleshooting](./troubleshooting.md) - Common issues and solutions - -## Quick Commands - -```bash -# Check service status -./botserver status - -# View logs -tail -f botserver-stack/logs/llm.log - -# Restart all services -./botserver restart - -# Update a specific component -./botserver update llm -``` - -## Related Documentation - -- [Installation](../01-introduction/installation.md) - Initial setup -- [Secrets Management](../08-config/secrets-management.md) - Vault configuration -- [LLM Configuration](../08-config/llm-config.md) - AI model settings \ No newline at end of file diff --git a/src/20-embedding/README.md b/src/20-embedding/README.md deleted file mode 100644 index 21ffe7e0..00000000 --- a/src/20-embedding/README.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 20: Embedded Deployment diff --git a/src/23-security/endpoint-checklist.md b/src/23-security/endpoint-checklist.md deleted file mode 100644 index 7c6f8bdb..00000000 --- a/src/23-security/endpoint-checklist.md +++ /dev/null @@ -1,65 +0,0 @@ -# Endpoint Security Checklist - -When adding new endpoints to the `.gbai` and BotServer APIs, ensure you adhere to this standard security checklist. All state-changing endpoints (those using `POST`, `PUT`, `PATCH`, or `DELETE` methods) must be protected against common Web vulnerabilities, including CSRF. - -## 1. CSRF Protection for State-Changing Endpoints - -Cross-Site Request Forgery (CSRF) protection must be applied to any endpoint that alters system state. Evaluate if the endpoint falls under one of the following exemptions: - -* **Exemptions:** - * API endpoints exclusively utilizing **Bearer Token** authentication (stateless requests that do not rely on cookies). - * Webhooks from external systems that provide their own authentication mechanisms (e.g., HMAC signatures like WhatsApp/Meta). - * Publicly fully accessible endpoints that do not affect any user data or system state. -* **Requirements:** - * All web-facing or cookie-authenticated endpoints must enforce CSRF checks. - * Tokens must be bound to the user session. - * Utilize double-submit cookie pattern or header-based token verification via the `CsrfManager`. - -## 2. Authentication & Authorization (RBAC) Requirements - -Do not expose new endpoints without explicitly defining their necessary permissions. - -* Ensure the endpoint is behind the `require_authentication_middleware` or similar authentication flow unless it is strictly intended to be public (e.g., `/api/auth/login`). -* Assign appropriate RBAC (Role-Based Access Control) permissions and ensure `require_role_middleware` is validated. -* Validate resource ownership. If a user tries to edit or delete an entity (e.g., a Bot, Document, or File), the backend must confirm they own the entity or possess tenant/admin privileges. - -## 3. Strict Security Headers - -All HTTP responses returning HTML content must include standard security headers. - -* Ensure the router uses `security_headers_middleware`. -* Mandatory Headers: - * `Content-Security-Policy`: Must clearly restrict `script-src`, `connect-src`, and `frame-ancestors`. - * `X-Frame-Options: DENY` (or `SAMEORIGIN` if absolutely necessary for the suite). - * `X-Content-Type-Options: nosniff`. - * `Strict-Transport-Security` (HSTS). - * `Referrer-Policy: strict-origin-when-cross-origin`. - -## 4. Input Validation & Sanitization - -Do not rely exclusively on client-side validation. - -* Validate the schema, length, and format of all incoming request payloads (`JSON`, `Query`, `Form`). -* Sanitize inputs that might be used inside SQL queries, though using ORMs (like Diesel) or parameterized queries safely mitigates straightforward SQL injection. Avoid dynamic SQL string formatting. -* Sanitize any output bound for HTML parsing to prevent Stored or Reflected XSS. - -## 5. Rate Limiting - -Endpoints must prevent brute force and DDoS abuse. - -* Apply or ensure that globally the `rate_limit_middleware` covers the new route. -* Authentication endpoints (like login forms) should have significantly stricter rate limits. -* Consider adding secondary quotas per underlying resource if dealing with expensive generation tasks (like LLM interactions). - -## 6. Secure Error Handling - -Never leak internal traces or paths. - -* Do not `unwrap()`, `expect()`, or `panic!()`. Use Rust's `?` operator. -* Use `ErrorSanitizer` logic, or return generalized application errors like `(StatusCode::INTERNAL_SERVER_ERROR, "An internal error occurred")` instead of specific database schema details. - ---- - -### Process for Review - -When submitting a PR incorporating new endpoints, mention that you have completed this checklist in your PR description. diff --git a/src/SUMMARY.md b/src/SUMMARY.md index a88f3b0e..a2383bbd 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -4,463 +4,289 @@ [Roadmap 2024-2026](./ROADMAP.md) [Introduction](./introduction.md) -# Part I - Getting Started +--- -- [Chapter 01: Run and Talk](./01-introduction/README.md) - - [Overview](./01-introduction/overview.md) - - [Quick Start](./01-introduction/quick-start.md) - - [Configuring .local Domains](./01-introduction/local-domains.md) - - [Installation](./01-introduction/installation.md) - - [First Conversation](./01-introduction/first-conversation.md) - - [Sessions and Channels](./01-introduction/sessions.md) +# Part I: Getting Started -# Part II - Package System +- [Chapter 1: Getting Started](./01-getting-started/README.md) + - [Overview](./01-getting-started/overview.md) + - [Quick Start](./01-getting-started/quick-start.md) + - [Installation](./01-getting-started/installation.md) + - [Configuring .local Domains](./01-getting-started/local-domains.md) + - [First Conversation](./01-getting-started/first-conversation.md) + - [Sessions and Channels](./01-getting-started/sessions.md) -- [Chapter 02: About Packages](./02-templates/README.md) - - [.gbai Architecture](./02-templates/gbai.md) - - [.gbdialog Dialogs](./02-templates/gbdialog.md) - - [.gbkb Knowledge Base](./02-templates/gbkb.md) - - [.gbot Bot Configuration](./02-templates/gbot.md) - - [.gbtheme UI Theming](./02-templates/gbtheme.md) - - [.gbdrive File Storage](./02-templates/gbdrive.md) - - [Bot Templates](./02-templates/templates.md) - - [Template Samples & Conversations](./02-templates/template-samples.md) - - [Template: Business Intelligence](./02-templates/template-bi.md) - - [Template: Web Crawler](./02-templates/template-crawler.md) - - [Template: Legal Documents](./02-templates/template-law.md) - - [Template: LLM Server](./02-templates/template-llm-server.md) - - [Template: LLM Tools](./02-templates/template-llm-tools.md) - - [Template: API Client](./02-templates/template-api-client.md) - - [Template: Platform Analytics](./02-templates/template-analytics.md) - - [Template: Office Automation](./02-templates/template-office.md) - - [Template: Reminders](./02-templates/template-reminder.md) - - [Template: Sales CRM](./02-templates/template-crm.md) - - [Template: CRM Contacts](./02-templates/template-crm-contacts.md) - - [Template: Attendance CRM](./02-templates/template-attendance-crm.md) - - [Template: Marketing](./02-templates/template-marketing.md) - - [Template: Embedded Devices](./02-templates/template-embedded.md) - - [Template: Creating Templates](./02-templates/template-template.md) +--- -# Part III - Knowledge Base +# Part II: Core Architecture -- [Chapter 03: gbkb Reference](./03-knowledge-base/README.md) - - [KB and Tools System](./03-knowledge-base/kb-and-tools.md) - - [Vector Collections](./03-knowledge-base/vector-collections.md) - - [Document Indexing](./03-knowledge-base/indexing.md) - - [Semantic Search](./03-knowledge-base/semantic-search.md) - - [Episodic Memory](./03-knowledge-base/episodic-memory.md) - - [Semantic Caching](./03-knowledge-base/caching.md) +- [Chapter 2: Architecture & Packages](./02-architecture-packages/README.md) + - [Architecture Overview](./02-architecture-packages/architecture.md) + - [Module Structure](./02-architecture-packages/crates.md) + - [Service Layer](./02-architecture-packages/services.md) + - [Building from Source](./02-architecture-packages/building.md) + - [Cargo Tools Reference](./02-architecture-packages/cargo-tools.md) + - [Container Deployment (LXC)](./02-architecture-packages/containers.md) + - [Docker Deployment](./02-architecture-packages/docker-deployment.md) + - [Kubernetes Deployment](./02-architecture-packages/kubernetes-deployment.md) + - [Scaling and Load Balancing](./02-architecture-packages/scaling.md) + - [Infrastructure Design](./02-architecture-packages/infrastructure.md) + - [Observability](./02-architecture-packages/observability.md) + - [Monitoring Setup](./02-architecture-packages/monitoring-setup.md) + - [Autonomous Task AI](./02-architecture-packages/autonomous-tasks.md) + - [Philosophy](./02-architecture-packages/philosophy.md) + - [.gbai Package Format](./02-architecture-packages/gbai.md) + - [.gbdialog Dialogs](./02-architecture-packages/gbdialog.md) + - [.gbkb Knowledge Base](./02-architecture-packages/gbkb.md) + - [.gbot Bot Configuration](./02-architecture-packages/gbot.md) + - [.gbtheme UI Theming](./02-architecture-packages/gbtheme.md) + - [.gbdrive File Storage](./02-architecture-packages/gbdrive.md) + - [Templates Overview](./02-architecture-packages/templates.md) + - [Template: BI](./02-architecture-packages/template-bi.md) + - [Template: Web Crawler](./02-architecture-packages/template-crawler.md) + - [Template: CRM](./02-architecture-packages/template-crm.md) + - [Template: Marketing](./02-architecture-packages/template-marketing.md) -# Part IV - User Interface +--- -- [Chapter 04: .gbui Interface Reference](./04-gbui/README.md) - - [Suite User Manual](./04-gbui/suite-manual.md) - - [Admin vs User Views](./04-gbui/admin-user-views.md) - - [UI Structure](./04-gbui/ui-structure.md) - - [single.gbui - Simple Chat](./04-gbui/single-gbui.md) - - [Console Mode](./04-gbui/console-mode.md) - - [Monitoring Dashboard](./04-gbui/monitoring.md) - - [HTMX Architecture](./04-gbui/htmx-architecture.md) - - [Dev Chat Widget](./04-gbui/dev-chat.md) - - [Suite Applications](./04-gbui/apps/README.md) - - [Suite - Full Desktop](./04-gbui/apps/suite.md) - - [Chat - AI Assistant](./04-gbui/apps/chat.md) - - [Drive - File Management](./04-gbui/apps/drive.md) - - [Tasks](./04-gbui/apps/tasks.md) - - [Mail - Email Client](./04-gbui/apps/mail.md) - - [Calendar - Scheduling](./04-gbui/apps/calendar.md) - - [Meet - Video Calls](./04-gbui/apps/meet.md) - - [Player - Media Viewer](./04-gbui/apps/player.md) - - [Paper - AI Writing](./04-gbui/apps/paper.md) - - [Research - AI Search](./04-gbui/apps/research.md) - - [CRM - Sales Pipeline](./04-gbui/apps/crm.md) - - [Billing - Invoices & Payments](./04-gbui/apps/billing.md) - - [Products - Catalog Management](./04-gbui/apps/products.md) - - [Tickets - Support Cases](./04-gbui/apps/tickets.md) - - [Analytics - Dashboards](./04-gbui/apps/analytics.md) - - [Dashboards - Custom BI](./04-gbui/apps/dashboards.md) - - [Designer - Visual Builder](./04-gbui/apps/designer.md) - - [Sources - Prompts & Templates](./04-gbui/apps/sources.md) - - [Compliance - Security Scanner](./04-gbui/apps/compliance.md) - - [Compliance API Reference](./04-gbui/apps/compliance-api.md) - - [How-To Tutorials](./04-gbui/how-to/README.md) - - [Create Your First Bot](./04-gbui/how-to/create-first-bot.md) - - [Write Your First Dialog](./04-gbui/how-to/write-first-dialog.md) - - [Add Documents to Knowledge Base](./04-gbui/how-to/add-kb-documents.md) - - [Connect WhatsApp](./04-gbui/how-to/connect-whatsapp.md) - - [Monitor Your Bot](./04-gbui/how-to/monitor-sessions.md) +# Part III: Intelligence -# Part V - Themes and Styling +- [Chapter 3: Knowledge & AI](./03-knowledge-ai/README.md) + - [KB and Tools System](./03-knowledge-ai/kb-and-tools.md) + - [Vector Collections](./03-knowledge-ai/vector-collections.md) + - [Document Indexing](./03-knowledge-ai/indexing.md) + - [Semantic Search](./03-knowledge-ai/semantic-search.md) + - [Episodic Memory](./03-knowledge-ai/episodic-memory.md) + - [Semantic Caching](./03-knowledge-ai/caching.md) + - [AI and LLM Integration](./03-knowledge-ai/ai-llm.md) + - [Hybrid RAG Search](./03-knowledge-ai/hybrid-search.md) + - [Memory Management](./03-knowledge-ai/memory-management.md) + - [Conversation Management](./03-knowledge-ai/conversation.md) + - [Automation](./03-knowledge-ai/automation.md) + - [Email Integration](./03-knowledge-ai/email.md) + - [Transfer to Human](./03-knowledge-ai/transfer-to-human.md) + - [LLM-Assisted Attendant](./03-knowledge-ai/attendant-llm-assist.md) -- [Chapter 05: gbtheme CSS Reference](./05-gbtheme/README.md) - - [Theme Structure](./05-gbtheme/structure.md) - - [CSS Customization](./05-gbtheme/css.md) +--- -# Part VI - BASIC Dialogs +# Part IV: Programming -- [Chapter 06: gbdialog Reference](./06-gbdialog/README.md) - - [Dialog Basics](./06-gbdialog/basics.md) - - [API Possibilities](./06-gbdialog/api-possibilities.md) - - [Universal Messaging & Multi-Channel](./06-gbdialog/universal-messaging.md) - - [BASIC vs n8n/Zapier/Make](./06-gbdialog/basic-vs-automation-tools.md) - - [Template Variables](./06-gbdialog/template-variables.md) - - [Template Examples](./06-gbdialog/templates.md) - - [start.bas](./06-gbdialog/templates/start.md) - - [enrollment.bas](./06-gbdialog/templates/enrollment.md) - - [auth.bas](./06-gbdialog/templates/auth.md) - - [ai-search.bas](./06-gbdialog/templates/ai-search.md) - - [analytics-dashboard.bas](./06-gbdialog/templates/analytics-dashboard.md) - - [announcements.bas](./06-gbdialog/templates/announcements.md) - - [backup.bas](./06-gbdialog/templates/backup.md) - - [bank.bas](./06-gbdialog/templates/bank.md) - - [broadcast.bas](./06-gbdialog/templates/broadcast.md) - - [default.bas](./06-gbdialog/templates/default.md) - - [edu.bas](./06-gbdialog/templates/edu.md) - - [employees.bas](./06-gbdialog/templates/employees.md) - - [erp.bas](./06-gbdialog/templates/erp.md) - - [helpdesk.bas](./06-gbdialog/templates/helpdesk.md) - - [privacy.bas](./06-gbdialog/templates/privacy.md) - - [sales-pipeline.bas](./06-gbdialog/templates/sales-pipeline.md) - - [store.bas](./06-gbdialog/templates/store.md) - - [talk-to-data.bas](./06-gbdialog/templates/talk-to-data.md) - - [whatsapp.bas](./06-gbdialog/templates/whatsapp.md) - - [Webhook Integrations and Jobs](./06-gbdialog/examples-consolidated.md) - - [Data Sync Tools](./06-gbdialog/tools-data-sync.md) - - [Keywords Reference](./06-gbdialog/keywords.md) - - [TALK](./06-gbdialog/keyword-talk.md) - - [HEAR](./06-gbdialog/keyword-hear.md) - - [SET CONTEXT](./06-gbdialog/keyword-set-context.md) - - [GET BOT MEMORY](./06-gbdialog/keyword-get-bot-memory.md) - - [SET BOT MEMORY](./06-gbdialog/keyword-set-bot-memory.md) - - [GET USER MEMORY](./06-gbdialog/keyword-get-user-memory.md) - - [SET USER MEMORY](./06-gbdialog/keyword-set-user-memory.md) - - [REMEMBER / RECALL](./06-gbdialog/keyword-remember.md) - - [BOOK / BOOK_MEETING](./06-gbdialog/keyword-book.md) - - [WEATHER / FORECAST](./06-gbdialog/keyword-weather.md) - - [ADD BOT](./06-gbdialog/keyword-add-bot.md) - - [ADD MEMBER](./06-gbdialog/keyword-add-member.md) - - [ADD SUGGESTION](./06-gbdialog/keyword-add-suggestion.md) - - [MODEL ROUTE](./06-gbdialog/keyword-model-route.md) - - [SEND TEMPLATE](./06-gbdialog/keyword-send-template.md) - - [SET USER](./06-gbdialog/keyword-set-user.md) - - [USE MODEL](./06-gbdialog/keyword-use-model.md) - - [DELEGATE TO BOT](./06-gbdialog/keyword-delegate-to-bot.md) - - [BOT REFLECTION](./06-gbdialog/keyword-bot-reflection.md) - - [RUN PYTHON / JAVASCRIPT / BASH](./06-gbdialog/keyword-run-code.md) - - [USE KB](./06-gbdialog/keyword-use-kb.md) - - [USE ACCOUNT](./06-gbdialog/keyword-use-account.md) - - [CLEAR KB](./06-gbdialog/keyword-clear-kb.md) - - [USE WEBSITE](./06-gbdialog/keyword-use-website.md) - - [USE TOOL](./06-gbdialog/keyword-use-tool.md) - - [CLEAR TOOLS](./06-gbdialog/keyword-clear-tools.md) - - [GET](./06-gbdialog/keyword-get.md) - - [SET](./06-gbdialog/keyword-set.md) - - [ON](./06-gbdialog/keyword-on.md) - - [ON EMAIL](./06-gbdialog/keyword-on-email.md) - - [ON CHANGE](./06-gbdialog/keyword-on-change.md) - - [SET SCHEDULE](./06-gbdialog/keyword-set-schedule.md) - - [CREATE SITE](./06-gbdialog/keyword-create-site.md) - - [CREATE DRAFT](./06-gbdialog/keyword-create-draft.md) - - [CREATE TASK](./06-gbdialog/keyword-create-task.md) - - [PRINT](./06-gbdialog/keyword-print.md) - - [WAIT](./06-gbdialog/keyword-wait.md) - - [FORMAT](./06-gbdialog/keyword-format.md) - - [FIRST](./06-gbdialog/keyword-first.md) - - [LAST](./06-gbdialog/keyword-last.md) - - [FOR EACH](./06-gbdialog/keyword-for-each.md) - - [EXIT FOR](./06-gbdialog/keyword-exit-for.md) - - [SEND MAIL](./06-gbdialog/keyword-send-mail.md) - - [FIND](./06-gbdialog/keyword-find.md) - - [INSTR](./06-gbdialog/keyword-instr.md) - - [IS NUMERIC](./06-gbdialog/keyword-is-numeric.md) - - [SWITCH](./06-gbdialog/keyword-switch.md) - - [WEBHOOK](./06-gbdialog/keyword-webhook.md) - - [TABLE](./06-gbdialog/keyword-table.md) - - [KB Statistics Keywords](./06-gbdialog/keywords-kb-statistics.md) - - [KB STATISTICS](./06-gbdialog/keyword-kb-statistics.md) - - [KB COLLECTION STATS](./06-gbdialog/keyword-kb-collection-stats.md) - - [KB DOCUMENTS COUNT](./06-gbdialog/keyword-kb-documents-count.md) - - [KB DOCUMENTS ADDED SINCE](./06-gbdialog/keyword-kb-documents-added-since.md) - - [KB LIST COLLECTIONS](./06-gbdialog/keyword-kb-list-collections.md) - - [KB STORAGE SIZE](./06-gbdialog/keyword-kb-storage-size.md) - - [Multi-Agent Keywords](./06-gbdialog/keywords-multi-agent.md) - - [Social Media Keywords](./06-gbdialog/keywords-social-media.md) - - [Lead Scoring Keywords](./06-gbdialog/keywords-lead-scoring.md) - - [HTTP & API Operations](./06-gbdialog/keywords-http.md) - - [POST](./06-gbdialog/keyword-post.md) - - [PUT](./06-gbdialog/keyword-put.md) - - [PATCH](./06-gbdialog/keyword-patch.md) - - [DELETE HTTP](./06-gbdialog/keyword-delete-http.md) - - [SET HEADER](./06-gbdialog/keyword-set-header.md) - - [GRAPHQL](./06-gbdialog/keyword-graphql.md) - - [SOAP](./06-gbdialog/keyword-soap.md) - - [Data Operations](./06-gbdialog/keywords-data.md) - - [SAVE](./06-gbdialog/keyword-save.md) - - [INSERT](./06-gbdialog/keyword-insert.md) - - [UPDATE](./06-gbdialog/keyword-update.md) - - [DELETE](./06-gbdialog/keyword-delete.md) - - [MERGE](./06-gbdialog/keyword-merge.md) - - [FILL](./06-gbdialog/keyword-fill.md) - - [MAP](./06-gbdialog/keyword-map.md) - - [FILTER](./06-gbdialog/keyword-filter.md) - - [AGGREGATE](./06-gbdialog/keyword-aggregate.md) - - [JOIN](./06-gbdialog/keyword-join.md) - - [PIVOT](./06-gbdialog/keyword-pivot.md) - - [GROUP BY](./06-gbdialog/keyword-group-by.md) - - [Media & Messaging](./06-gbdialog/keywords-media.md) - - [PLAY](./06-gbdialog/keyword-play.md) - - [QR CODE](./06-gbdialog/keyword-qrcode.md) - - [SEND SMS](./06-gbdialog/keyword-sms.md) - - [START MEET / JOIN MEET](./06-gbdialog/keyword-start-meet.md) - - [GPIO & IoT Keywords](./06-gbdialog/keywords-gpio.md) - - [File Operations](./06-gbdialog/keywords-file.md) - - [READ](./06-gbdialog/keyword-read.md) - - [WRITE](./06-gbdialog/keyword-write.md) - - [DELETE FILE](./06-gbdialog/keyword-delete-file.md) - - [COPY](./06-gbdialog/keyword-copy.md) - - [MOVE](./06-gbdialog/keyword-move.md) - - [LIST](./06-gbdialog/keyword-list.md) - - [COMPRESS](./06-gbdialog/keyword-compress.md) - - [EXTRACT](./06-gbdialog/keyword-extract.md) - - [UPLOAD](./06-gbdialog/keyword-upload.md) - - [DOWNLOAD](./06-gbdialog/keyword-download.md) - - [GENERATE PDF](./06-gbdialog/keyword-generate-pdf.md) - - [MERGE PDF](./06-gbdialog/keyword-merge-pdf.md) +- [Chapter 4: BASIC Scripting](./04-basic-scripting/README.md) + - [BASIC Basics](./04-basic-scripting/basics.md) + - [API Possibilities](./04-basic-scripting/api-possibilities.md) + - [Universal Messaging](./04-basic-scripting/universal-messaging.md) + - [BASIC vs n8n/Zapier/Make](./04-basic-scripting/basic-vs-automation-tools.md) + - [Template Variables](./04-basic-scripting/template-variables.md) + - [TALK](./04-basic-scripting/keyword-talk.md) + - [HEAR](./04-basic-scripting/keyword-hear.md) + - [SET CONTEXT](./04-basic-scripting/keyword-set-context.md) + - [GET BOT MEMORY](./04-basic-scripting/keyword-get-bot-memory.md) + - [SET BOT MEMORY](./04-basic-scripting/keyword-set-bot-memory.md) + - [GET USER MEMORY](./04-basic-scripting/keyword-get-user-memory.md) + - [SET USER MEMORY](./04-basic-scripting/keyword-set-user-memory.md) + - [REMEMBER / RECALL](./04-basic-scripting/keyword-remember.md) + - [BOOK / BOOK_MEETING](./04-basic-scripting/keyword-book.md) + - [WEATHER / FORECAST](./04-basic-scripting/keyword-weather.md) + - [ADD BOT](./04-basic-scripting/keyword-add-bot.md) + - [USE MODEL](./04-basic-scripting/keyword-use-model.md) + - [DELEGATE TO BOT](./04-basic-scripting/keyword-delegate-to-bot.md) + - [RUN CODE](./04-basic-scripting/keyword-run-code.md) + - [USE KB](./04-basic-scripting/keyword-use-kb.md) + - [GET](./04-basic-scripting/keyword-get.md) + - [SET](./04-basic-scripting/keyword-set.md) + - [ON](./04-basic-scripting/keyword-on.md) + - [SET SCHEDULE](./04-basic-scripting/keyword-set-schedule.md) + - [CREATE TASK](./04-basic-scripting/keyword-create-task.md) + - [FOR EACH](./04-basic-scripting/keyword-for-each.md) + - [SWITCH](./04-basic-scripting/keyword-switch.md) + - [SAVE](./04-basic-scripting/keyword-save.md) + - [INSERT](./04-basic-scripting/keyword-insert.md) + - [UPDATE](./04-basic-scripting/keyword-update.md) + - [DELETE](./04-basic-scripting/keyword-delete.md) + - [FIND](./04-basic-scripting/keyword-find.md) + - [FILTER](./04-basic-scripting/keyword-filter.md) + - [MAP](./04-basic-scripting/keyword-map.md) + - [AGGREGATE](./04-basic-scripting/keyword-aggregate.md) + - [POST](./04-basic-scripting/keyword-post.md) + - [GRAPHQL](./04-basic-scripting/keyword-graphql.md) + - [WEBHOOK](./04-basic-scripting/keyword-webhook.md) + - [PLAY](./04-basic-scripting/keyword-play.md) + - [SEND MAIL](./04-basic-scripting/keyword-send-mail.md) + - [SEND SMS](./04-basic-scripting/keyword-sms.md) + - [READ](./04-basic-scripting/keyword-read.md) + - [WRITE](./04-basic-scripting/keyword-write.md) + - [UPLOAD](./04-basic-scripting/keyword-upload.md) + - [DOWNLOAD](./04-basic-scripting/keyword-download.md) + - [GENERATE PDF](./04-basic-scripting/keyword-generate-pdf.md) + - [start.bas](./04-basic-scripting/templates/start.md) + - [default.bas](./04-basic-scripting/templates/default.md) + - [auth.bas](./04-basic-scripting/templates/auth.md) + - [enrollment.bas](./04-basic-scripting/templates/enrollment.md) + - [sales-pipeline.bas](./04-basic-scripting/templates/sales-pipeline.md) -# Part VII - Extending General Bots +--- -- [Chapter 07: gbapp Architecture Reference](./07-gbapp/README.md) - - [Architecture Overview](./07-gbapp/architecture.md) - - [Building from Source](./07-gbapp/building.md) - - [Cargo Tools Reference](./07-gbapp/cargo-tools.md) - - [Container Deployment (LXC)](./07-gbapp/containers.md) - - [Docker Deployment](./07-gbapp/docker-deployment.md) - - [Scaling and Load Balancing](./07-gbapp/scaling.md) - - [Infrastructure Design](./07-gbapp/infrastructure.md) - - [Observability](./07-gbapp/observability.md) - - [Autonomous Task AI](./07-gbapp/autonomous-tasks.md) - - [Philosophy](./07-gbapp/philosophy.md) - - [Example gbapp](./07-gbapp/example-gbapp.md) - - [Module Structure](./07-gbapp/crates.md) - - [Service Layer](./07-gbapp/services.md) - - [Creating Custom Keywords](./07-gbapp/custom-keywords.md) - - [Adding Dependencies](./07-gbapp/dependencies.md) - - [Testing & Safety Tooling](./07-gbapp/testing-safety.md) +# Part V: Orchestration -# Part VIII - Bot Configuration +- [Chapter 5: Multi-Agent Orchestration](./05-multi-agent/README.md) + - [Task Workflow](./05-multi-agent/workflow.md) + - [App Generation](./05-multi-agent/app-generation.md) + - [Data Model](./05-multi-agent/data-model.md) + - [Designer](./05-multi-agent/designer.md) + - [Agent Workspaces](./05-multi-agent/agent-workspaces.md) -- [Chapter 08: gbot Reference](./08-config/README.md) - - [config.csv Format](./08-config/config-csv.md) - - [Bot Parameters](./08-config/parameters.md) - - [LLM Configuration](./08-config/llm-config.md) - - [Context Configuration](./08-config/context-config.md) - - [Drive Integration](./08-config/drive.md) - - [Multimodal Configuration](./08-config/multimodal.md) - - [Secrets Management](./08-config/secrets-management.md) - - [System Limits](./08-config/system-limits.md) - - [Sources Sync Strategy](./08-config/sources-sync-strategy.md) +--- -# Part IX - Tools and Integration +# Part VI: Connectivity -- [Chapter 09: LLM Tools](./09-tools/README.md) - - [Tool Definition](./09-tools/tool-definition.md) - - [PARAM Declaration](./09-tools/param-declaration.md) - - [Tool Compilation](./09-tools/compilation.md) - - [MCP Format](./09-tools/mcp-format.md) - - [Tool Format](./09-tools/openai-format.md) - - [GET Keyword Integration](./09-tools/get-integration.md) - - [External APIs](./09-tools/external-apis.md) - - [LLM REST Server](./09-tools/llm-rest-server.md) - - [NVIDIA GPU Setup for LXC](./09-tools/nvidia-gpu-setup.md) +- [Chapter 6: Channels & Connectivity](./06-channels/README.md) + - [Channel Integrations](./06-channels/channels.md) + - [Service Catalog](./06-channels/catalog.md) + - [WhatsApp Quick Start](./06-channels/whatsapp-quick-start.md) + - [WhatsApp Webhooks](./06-channels/whatsapp-webhooks.md) + - [Teams Channel](./06-channels/teams-channel.md) + - [SMS Providers](./06-channels/sms-providers.md) + - [Attendance Queue](./06-channels/attendance-queue.md) + - [LLM Providers](./06-channels/llm-providers.md) + - [Storage Services](./06-channels/storage.md) + - [Directory Services](./06-channels/directory.md) -- [Chapter 10: REST Endpoints](./10-rest/README.md) - - [Files API](./10-rest/files-api.md) - - [Document Processing API](./10-rest/document-processing.md) - - [Users API](./10-rest/users-api.md) - - [User Security API](./10-rest/user-security.md) - - [Groups API](./10-rest/groups-api.md) - - [Group Membership API](./10-rest/group-membership.md) - - [Conversations API](./10-rest/conversations-api.md) - - [Calls API](./10-rest/calls-api.md) - - [Whiteboard API](./10-rest/whiteboard-api.md) - - [Email API](./10-rest/email-api.md) - - [Notifications API](./10-rest/notifications-api.md) - - [Calendar API](./10-rest/calendar-api.md) - - [Tasks API](./10-rest/tasks-api.md) - - [Storage API](./10-rest/storage-api.md) - - [Backup API](./10-rest/backup-api.md) - - [Analytics API](./10-rest/analytics-api.md) - - [Reports API](./10-rest/reports-api.md) - - [Admin API](./10-rest/admin-api.md) - - [Monitoring API](./10-rest/monitoring-api.md) - - [AI API](./10-rest/ai-api.md) - - [ML API](./10-rest/ml-api.md) - - [Security API](./10-rest/security-api.md) - - [Compliance API](./10-rest/compliance-api.md) - - [Example Integrations](./10-rest/examples.md) +--- -# Part X - Feature Deep Dive +# Part VII: User Interface -- [Feature System & Dependency Tree](./features.md) -- [Chapter 11: Feature Reference](./11-features/README.md) - - [Feature Editions](./11-features/editions.md) - - [Core Features](./11-features/core-features.md) - - [Cargo Feature Map](./11-features/feature-map.md) - - [Conversation Management](./11-features/conversation.md) - - [AI and LLM](./11-features/ai-llm.md) - - [Knowledge Base](./11-features/knowledge-base.md) - - [Automation](./11-features/automation.md) - - [Email Integration](./11-features/email.md) - - [Storage and Data](./11-features/storage.md) - - [Multi-Channel Support](./11-features/channels.md) - - [Drive Monitor](./11-features/drive-monitor.md) - - [Platform Capabilities](./11-features/platform-comparison.md) - - [Enterprise Platform Migration](./11-features/m365-comparison.md) - - [Projects](./11-features/projects.md) - - [Multi-Agent Office Suite Design](./11-features/multi-agent-design.md) - - [What's New: Multi-Agent Features](./11-features/whats-new.md) - - [Multi-Agent Orchestration](./11-features/multi-agent-orchestration.md) - - [Memory Management](./11-features/memory-management.md) - - [Hybrid RAG Search](./11-features/hybrid-search.md) - - [Transfer to Human](./11-features/transfer-to-human.md) - - [LLM-Assisted Attendant](./11-features/attendant-llm-assist.md) - - [Attendance Suite](./attendance.md) +- [Chapter 7: User Interface](./07-user-interface/README.md) + - [Suite User Manual](./07-user-interface/suite-manual.md) + - [Admin vs User Views](./07-user-interface/admin-user-views.md) + - [UI Structure](./07-user-interface/ui-structure.md) + - [single.gbui - Simple Chat](./07-user-interface/single-gbui.md) + - [Console Mode](./07-user-interface/console-mode.md) + - [Monitoring Dashboard](./07-user-interface/monitoring.md) + - [HTMX Architecture](./07-user-interface/htmx-architecture.md) + - [Suite - Full Desktop](./07-user-interface/apps/suite.md) + - [Chat - AI Assistant](./07-user-interface/apps/chat.md) + - [Drive - File Management](./07-user-interface/apps/drive.md) + - [Tasks](./07-user-interface/apps/tasks.md) + - [Mail - Email Client](./07-user-interface/apps/mail.md) + - [Calendar - Scheduling](./07-user-interface/apps/calendar.md) + - [Meet - Video Calls](./07-user-interface/apps/meet.md) + - [CRM - Sales Pipeline](./07-user-interface/apps/crm.md) + - [Billing - Invoices](./07-user-interface/apps/billing.md) + - [Tickets - Support Cases](./07-user-interface/apps/tickets.md) + - [Analytics - Dashboards](./07-user-interface/apps/analytics.md) + - [Designer - Visual Builder](./07-user-interface/apps/designer.md) + - [Create Your First Bot](./07-user-interface/how-to/create-first-bot.md) + - [Write Your First Dialog](./07-user-interface/how-to/write-first-dialog.md) + - [Add Documents to Knowledge Base](./07-user-interface/how-to/add-kb-documents.md) + - [Connect WhatsApp](./07-user-interface/how-to/connect-whatsapp.md) + - [Theme Structure](./07-user-interface/structure.md) + - [CSS Customization](./07-user-interface/css.md) -# Part XI - Security +--- -- [Chapter 12: Authentication & Permissions](./12-auth/README.md) - - [Initial Setup & Bootstrap](./12-auth/initial-setup.md) - - [User Authentication](./12-auth/user-auth.md) - - [Password Security](./12-auth/password-security.md) - - [API Endpoints](./12-auth/api-endpoints.md) - - [Bot Authentication](./12-auth/bot-auth.md) - - [Security Features](./12-auth/security-features.md) - - [Security Policy](./12-auth/security-policy.md) - - [Compliance Requirements](./12-auth/compliance-requirements.md) - - [RBAC Overview](./12-auth/rbac-overview.md) - - [Permissions Matrix](./12-auth/permissions-matrix.md) - - [Permissions Reference](./12-auth/permissions-reference.md) - - [User Context vs System Context](./12-auth/user-system-context.md) - - [System Limits & Rate Limiting](./12-auth/system-limits.md) - - [Security Checklist for SaaS](./12-auth/security-checklist.md) +# Part VIII: Integration -- [Chapter 23: Advanced Security](./23-security/README.md) - - [RBAC & Security Design](./23-security/rbac-design.md) - - [RBAC Configuration Guide](./23-security/rbac-configuration.md) - - [Organization Multi-Tenancy](./23-security/organizations.md) - - [Knowledge Base Permissions](./23-security/kb-permissions.md) - - [Knowledge Base Security](./23-security/kb-security.md) - - [Protection Tools](./23-security/protection-tools.md) - - [SOC 2 Compliance](./23-security/soc2-compliance.md) - - [Security Matrix Reference](./23-security/security-matrix.md) - - [Endpoint Security Checklist](./23-security/endpoint-checklist.md) +- [Chapter 8: REST API & Tools](./08-rest-api-tools/README.md) + - [Files API](./08-rest-api-tools/files-api.md) + - [Users API](./08-rest-api-tools/users-api.md) + - [Groups API](./08-rest-api-tools/groups-api.md) + - [Conversations API](./08-rest-api-tools/conversations-api.md) + - [Email API](./08-rest-api-tools/email-api.md) + - [Calendar API](./08-rest-api-tools/calendar-api.md) + - [Tasks API](./08-rest-api-tools/tasks-api.md) + - [Storage API](./08-rest-api-tools/storage-api.md) + - [Analytics API](./08-rest-api-tools/analytics-api.md) + - [Admin API](./08-rest-api-tools/admin-api.md) + - [AI API](./08-rest-api-tools/ai-api.md) + - [Tool Definition](./08-rest-api-tools/tool-definition.md) + - [PARAM Declaration](./08-rest-api-tools/param-declaration.md) + - [Tool Compilation](./08-rest-api-tools/compilation.md) + - [MCP Format](./08-rest-api-tools/mcp-format.md) + - [Tool Format](./08-rest-api-tools/openai-format.md) + - [External APIs](./08-rest-api-tools/external-apis.md) + - [LLM REST Server](./08-rest-api-tools/llm-rest-server.md) -# Part XII - Device & Offline Deployment +--- -- [Chapter 13: Hardware & Device Deployment](./13-hardware-devices/README.md) - - [Buying Guide for Beginners](./13-hardware-devices/buying-guide.md) - - [Mobile (Android & HarmonyOS)](./13-hardware-devices/mobile.md) - - [Supported Hardware (SBCs)](./13-hardware-devices/hardware.md) - - [Desktop & Server Hardware](./13-hardware-devices/desktop-hardware.md) - - [Quick Start](./13-hardware-devices/quick-start.md) - - [Local LLM with llama.cpp](./13-hardware-devices/local-llm.md) +# Part IX: Security -# Part XIII - Community +- [Chapter 9: Security](./09-security/README.md) + - [Initial Setup & Bootstrap](./09-security/initial-setup.md) + - [User Authentication](./09-security/user-auth.md) + - [Password Security](./09-security/password-security.md) + - [API Endpoints](./09-security/api-endpoints.md) + - [Bot Authentication](./09-security/bot-auth.md) + - [Security Features](./09-security/security-features.md) + - [Security Policy](./09-security/security-policy.md) + - [Compliance Requirements](./09-security/compliance-requirements.md) + - [RBAC Overview](./09-security/rbac-overview.md) + - [Permissions Matrix](./09-security/permissions-matrix.md) + - [RBAC Configuration Guide](./09-security/rbac-configuration.md) + - [Organization Multi-Tenancy](./09-security/organizations.md) + - [Knowledge Base Permissions](./09-security/kb-permissions.md) + - [SOC 2 Compliance](./09-security/soc2-compliance.md) + - [Security Matrix Reference](./09-security/security-matrix.md) + - [Endpoint Security Checklist](./09-security/endpoint-checklist.md) -- [Chapter 14: Contributing](./13-community/README.md) - - [Development Setup](./13-community/setup.md) - - [Testing Guide](./13-community/testing.md) - - [Documentation](./13-community/documentation.md) - - [Pull Requests](./13-community/pull-requests.md) - - [Community Guidelines](./13-community/community.md) - - [IDEs](./13-community/ide-extensions.md) +--- -# Part XIV - Migration +# Part X: Deployment -- [Chapter 15: Migration Guide](./14-migration/README.md) - - [Migration Overview](./14-migration/overview.md) - - [Platform Comparison Matrix](./14-migration/comparison-matrix.md) - - [Migration Resources](./14-migration/resources.md) - - [Common Concepts](./14-migration/common-concepts.md) - - [Knowledge Base Migration](./14-migration/kb-migration.md) - - [Cloud Productivity Migration](./14-migration/google-workspace.md) - - [Enterprise Platform Migration](./14-migration/microsoft-365.md) - - [n8n Migration](./14-migration/n8n.md) - - [Notion Migration](./14-migration/notion.md) - - [Perplexity Migration](./14-migration/perplexity.md) - - [Zapier and Make Migration](./14-migration/zapier-make.md) - - [Intercom Migration](./14-migration/intercom.md) - - [Dialogflow Migration](./14-migration/dialogflow.md) - - [Botpress Migration](./14-migration/botpress.md) - - [Automation Migration](./14-migration/automation.md) - - [Validation and Testing](./14-migration/validation.md) +- [Chapter 10: Configuration & Deployment](./10-configuration-deployment/README.md) + - [config.csv Format](./10-configuration-deployment/config-csv.md) + - [Bot Parameters](./10-configuration-deployment/parameters.md) + - [LLM Configuration](./10-configuration-deployment/llm-config.md) + - [Context Configuration](./10-configuration-deployment/context-config.md) + - [Drive Integration](./10-configuration-deployment/drive.md) + - [Multimodal Configuration](./10-configuration-deployment/multimodal.md) + - [Secrets Management](./10-configuration-deployment/secrets-management.md) + - [System Limits](./10-configuration-deployment/system-limits.md) + - [MinIO Storage](./10-configuration-deployment/minio.md) -# Part XV - Testing +--- -- [Chapter 16: Testing](./17-testing/README.md) - - [End-to-End Testing](./17-testing/e2e-testing.md) - - [Testing Architecture](./17-testing/architecture.md) - - [Performance Testing](./17-testing/performance.md) - - [Best Practices](./17-testing/best-practices.md) - - [CI/CD Integration](./17-testing/ci-cd.md) +# Part XI: Hardware & Scale -# Part XVI - Autonomous Tasks +- [Chapter 11: Hardware & Scaling](./11-hardware-scaling/README.md) + - [Buying Guide for Beginners](./11-hardware-scaling/buying-guide.md) + - [Mobile (Android & HarmonyOS)](./11-hardware-scaling/mobile.md) + - [Supported Hardware (SBCs)](./11-hardware-scaling/hardware.md) + - [Desktop & Server Hardware](./11-hardware-scaling/desktop-hardware.md) + - [Local LLM with llama.cpp](./11-hardware-scaling/local-llm.md) + - [Sharding Architecture](./11-hardware-scaling/sharding.md) + - [Database Optimization](./11-hardware-scaling/database-optimization.md) -- [Chapter 17: Autonomous Tasks](./17-autonomous-tasks/README.md) - - [Task Workflow](./17-autonomous-tasks/workflow.md) - - [App Generation](./17-autonomous-tasks/app-generation.md) - - [Data Model](./17-autonomous-tasks/data-model.md) - - [Examples](./17-autonomous-tasks/examples.md) - - [Designer](./17-autonomous-tasks/designer.md) - - [Agent Workspaces](./17-autonomous-tasks/agent-workspaces.md) +--- -# Part XVII - Scale +# Part XII: Ecosystem -- [Chapter 18: Scale](./21-scale/README.md) - - [Sharding Architecture](./21-scale/sharding.md) - - [Database Optimization](./21-scale/database-optimization.md) - -# Part XVIII - White Label - -- [Chapter 19: White Label](./22-white-label/README.md) - -# Appendices - -- [Appendix A: Database Model](./15-appendix/README.md) - - [Schema Overview](./15-appendix/schema.md) - - [Tables](./15-appendix/tables.md) - - [Relationships](./15-appendix/relationships.md) - -- [Appendix B: External Services](./18-appendix-external-services/README.md) - - [Service Catalog](./18-appendix-external-services/catalog.md) - - [LLM Providers](./18-appendix-external-services/llm-providers.md) - - [Weather API](./18-appendix-external-services/weather.md) - - [Channel Integrations](./18-appendix-external-services/channels.md) - - [Quick Start Guide](./18-appendix-external-services/whatsapp-quick-start.md) - - [Webhook Configuration](./18-appendix-external-services/whatsapp-webhooks.md) - - [Code Examples](./18-appendix-external-services/whatsapp-examples.md) - - [Troubleshooting](./18-appendix-external-services/whatsapp-troubleshooting.md) - - [Quick Reference](./18-appendix-external-services/whatsapp-quick-reference.md) - - [Storage Services](./18-appendix-external-services/storage.md) - - [Directory Services](./18-appendix-external-services/directory.md) - - [Attendance Queue](./18-appendix-external-services/attendance-queue.md) - - [Hosting, DNS, and MDA](./18-appendix-external-services/hosting-dns.md) - - [Time-Series Database](./18-appendix-external-services/timeseries.md) - - [NVIDIA GPU](./18-appendix-external-services/nvidia.md) - - [Multimodal](./18-appendix-external-services/multimodal.md) - - [Console (XtreeUI)](./18-appendix-external-services/console.md) - -- [Appendix C: Maintenance](./19-maintenance/README.md) - - [CLI Reference](./19-maintenance/cli-reference.md) - - [Updating Components](./19-maintenance/updating-components.md) - - [Component Reference](./19-maintenance/component-reference.md) - - [Security Auditing](./19-maintenance/security-auditing.md) - - [Backup and Recovery](./19-maintenance/backup-recovery.md) - - [Troubleshooting](./19-maintenance/troubleshooting.md) - - [LXC Migration](./19-maintenance/lxc-migration.md) - - - - -[Glossary](./glossary.md) -[Contact](./contact/README.md) +- [Chapter 12: Ecosystem & Reference](./12-ecosystem-reference/README.md) + - [Migration Overview](./12-ecosystem-reference/overview.md) + - [Platform Comparison Matrix](./12-ecosystem-reference/comparison-matrix.md) + - [Knowledge Base Migration](./12-ecosystem-reference/kb-migration.md) + - [Cloud Productivity Migration](./12-ecosystem-reference/google-workspace.md) + - [Enterprise Platform Migration](./12-ecosystem-reference/microsoft-365.md) + - [n8n Migration](./12-ecosystem-reference/n8n.md) + - [Notion Migration](./12-ecosystem-reference/notion.md) + - [Zapier and Make Migration](./12-ecosystem-reference/zapier-make.md) + - [CLI Reference](./12-ecosystem-reference/cli-reference.md) + - [Updating Components](./12-ecosystem-reference/updating-components.md) + - [Component Reference](./12-ecosystem-reference/component-reference.md) + - [Security Auditing](./12-ecosystem-reference/security-auditing.md) + - [Backup and Recovery](./12-ecosystem-reference/backup-recovery.md) + - [Troubleshooting](./12-ecosystem-reference/troubleshooting.md) + - [Testing Strategy](./12-ecosystem-reference/architecture.md) + - [End-to-End Testing](./12-ecosystem-reference/e2e-testing.md) + - [Performance Testing](./12-ecosystem-reference/performance.md) + - [CI/CD Integration](./12-ecosystem-reference/ci-cd.md) + - [Contributing Overview](./12-ecosystem-reference/setup.md) + - [Local Development](./12-ecosystem-reference/local-development.md) + - [Pull Requests](./12-ecosystem-reference/pull-requests.md) + - [Community Guidelines](./12-ecosystem-reference/community.md) + - [Schema Overview](./12-ecosystem-reference/schema.md) + - [Tables](./12-ecosystem-reference/tables.md) + - [Relationships](./12-ecosystem-reference/relationships.md) + - [Glossary](./glossary.md) + - [Contact](./contact/README.md) + - [Features](./features.md) + - [Attendance](./attendance.md) diff --git a/src/assets/chapter-01/bootstrap-process.svg b/src/assets/01-getting-started/bootstrap-process.svg similarity index 100% rename from src/assets/chapter-01/bootstrap-process.svg rename to src/assets/01-getting-started/bootstrap-process.svg diff --git a/src/assets/chapter-01/quick-start-bootstrap-wide.svg b/src/assets/01-getting-started/quick-start-bootstrap-wide.svg similarity index 100% rename from src/assets/chapter-01/quick-start-bootstrap-wide.svg rename to src/assets/01-getting-started/quick-start-bootstrap-wide.svg diff --git a/src/assets/chapter-01/quick-start-bootstrap.svg b/src/assets/01-getting-started/quick-start-bootstrap.svg similarity index 100% rename from src/assets/chapter-01/quick-start-bootstrap.svg rename to src/assets/01-getting-started/quick-start-bootstrap.svg diff --git a/src/assets/chapter-01/session-manager.svg b/src/assets/01-getting-started/session-manager.svg similarity index 100% rename from src/assets/chapter-01/session-manager.svg rename to src/assets/01-getting-started/session-manager.svg diff --git a/src/assets/chapter-01/session-states.svg b/src/assets/01-getting-started/session-states.svg similarity index 100% rename from src/assets/chapter-01/session-states.svg rename to src/assets/01-getting-started/session-states.svg diff --git a/src/assets/chapter-01/tool-execution-flow.svg b/src/assets/01-getting-started/tool-execution-flow.svg similarity index 100% rename from src/assets/chapter-01/tool-execution-flow.svg rename to src/assets/01-getting-started/tool-execution-flow.svg diff --git a/src/assets/chapter-07/autonomous-task-flow.svg b/src/assets/02-architecture-packages/chapter-07/autonomous-task-flow.svg similarity index 100% rename from src/assets/chapter-07/autonomous-task-flow.svg rename to src/assets/02-architecture-packages/chapter-07/autonomous-task-flow.svg diff --git a/src/assets/chapter-07/data-flow.svg b/src/assets/02-architecture-packages/chapter-07/data-flow.svg similarity index 100% rename from src/assets/chapter-07/data-flow.svg rename to src/assets/02-architecture-packages/chapter-07/data-flow.svg diff --git a/src/assets/chapter-07/data-traceability.svg b/src/assets/02-architecture-packages/chapter-07/data-traceability.svg similarity index 100% rename from src/assets/chapter-07/data-traceability.svg rename to src/assets/02-architecture-packages/chapter-07/data-traceability.svg diff --git a/src/assets/chapter-07/module-data-flow.svg b/src/assets/02-architecture-packages/chapter-07/module-data-flow.svg similarity index 100% rename from src/assets/chapter-07/module-data-flow.svg rename to src/assets/02-architecture-packages/chapter-07/module-data-flow.svg diff --git a/src/assets/chapter-07/module-dependency.svg b/src/assets/02-architecture-packages/chapter-07/module-dependency.svg similarity index 100% rename from src/assets/chapter-07/module-dependency.svg rename to src/assets/02-architecture-packages/chapter-07/module-dependency.svg diff --git a/src/assets/chapter-07/system-architecture.svg b/src/assets/02-architecture-packages/chapter-07/system-architecture.svg similarity index 100% rename from src/assets/chapter-07/system-architecture.svg rename to src/assets/02-architecture-packages/chapter-07/system-architecture.svg diff --git a/src/assets/chapter-02/package-structure.svg b/src/assets/02-architecture-packages/package-structure.svg similarity index 100% rename from src/assets/chapter-02/package-structure.svg rename to src/assets/02-architecture-packages/package-structure.svg diff --git a/src/assets/chapter-02/template-deployment-flow.svg b/src/assets/02-architecture-packages/template-deployment-flow.svg similarity index 100% rename from src/assets/chapter-02/template-deployment-flow.svg rename to src/assets/02-architecture-packages/template-deployment-flow.svg diff --git a/src/assets/chapter-03/caching-architecture.svg b/src/assets/03-knowledge-ai/caching-architecture.svg similarity index 100% rename from src/assets/chapter-03/caching-architecture.svg rename to src/assets/03-knowledge-ai/caching-architecture.svg diff --git a/src/assets/chapter-03/context-window.svg b/src/assets/03-knowledge-ai/context-window.svg similarity index 100% rename from src/assets/chapter-03/context-window.svg rename to src/assets/03-knowledge-ai/context-window.svg diff --git a/src/assets/chapter-03/kb-architecture-pipeline.svg b/src/assets/03-knowledge-ai/kb-architecture-pipeline.svg similarity index 100% rename from src/assets/chapter-03/kb-architecture-pipeline.svg rename to src/assets/03-knowledge-ai/kb-architecture-pipeline.svg diff --git a/src/assets/chapter-03/search-pipeline.svg b/src/assets/03-knowledge-ai/search-pipeline.svg similarity index 100% rename from src/assets/chapter-03/search-pipeline.svg rename to src/assets/03-knowledge-ai/search-pipeline.svg diff --git a/src/assets/chapter-03/storage-breakdown.svg b/src/assets/03-knowledge-ai/storage-breakdown.svg similarity index 100% rename from src/assets/chapter-03/storage-breakdown.svg rename to src/assets/03-knowledge-ai/storage-breakdown.svg diff --git a/src/assets/chapter-03/storage-multiplication.svg b/src/assets/03-knowledge-ai/storage-multiplication.svg similarity index 100% rename from src/assets/chapter-03/storage-multiplication.svg rename to src/assets/03-knowledge-ai/storage-multiplication.svg diff --git a/src/assets/chapter-03/technical-specs.svg b/src/assets/03-knowledge-ai/technical-specs.svg similarity index 100% rename from src/assets/chapter-03/technical-specs.svg rename to src/assets/03-knowledge-ai/technical-specs.svg diff --git a/src/assets/chapter-06/basic-execution-flow.svg b/src/assets/04-basic-scripting/basic-execution-flow.svg similarity index 100% rename from src/assets/chapter-06/basic-execution-flow.svg rename to src/assets/04-basic-scripting/basic-execution-flow.svg diff --git a/src/assets/chapter-17/app-generation-flow.svg b/src/assets/05-multi-agent/app-generation-flow.svg similarity index 100% rename from src/assets/chapter-17/app-generation-flow.svg rename to src/assets/05-multi-agent/app-generation-flow.svg diff --git a/src/assets/chapter-17/autotask-architecture.svg b/src/assets/05-multi-agent/autotask-architecture.svg similarity index 100% rename from src/assets/chapter-17/autotask-architecture.svg rename to src/assets/05-multi-agent/autotask-architecture.svg diff --git a/src/assets/chapter-17/bot-database-architecture.svg b/src/assets/05-multi-agent/bot-database-architecture.svg similarity index 100% rename from src/assets/chapter-17/bot-database-architecture.svg rename to src/assets/05-multi-agent/bot-database-architecture.svg diff --git a/src/assets/chapter-17/data-model-flow.svg b/src/assets/05-multi-agent/data-model-flow.svg similarity index 100% rename from src/assets/chapter-17/data-model-flow.svg rename to src/assets/05-multi-agent/data-model-flow.svg diff --git a/src/assets/chapter-17/designer-workflow.svg b/src/assets/05-multi-agent/designer-workflow.svg similarity index 100% rename from src/assets/chapter-17/designer-workflow.svg rename to src/assets/05-multi-agent/designer-workflow.svg diff --git a/src/assets/chapter-17/task-workflow.svg b/src/assets/05-multi-agent/task-workflow.svg similarity index 100% rename from src/assets/chapter-17/task-workflow.svg rename to src/assets/05-multi-agent/task-workflow.svg diff --git a/src/assets/chapter-04/analytics-interface.svg b/src/assets/07-user-interface/analytics-interface.svg similarity index 100% rename from src/assets/chapter-04/analytics-interface.svg rename to src/assets/07-user-interface/analytics-interface.svg diff --git a/src/assets/chapter-04/autotask-interface.svg b/src/assets/07-user-interface/autotask-interface.svg similarity index 100% rename from src/assets/chapter-04/autotask-interface.svg rename to src/assets/07-user-interface/autotask-interface.svg diff --git a/src/assets/chapter-04/calendar-interface.svg b/src/assets/07-user-interface/calendar-interface.svg similarity index 100% rename from src/assets/chapter-04/calendar-interface.svg rename to src/assets/07-user-interface/calendar-interface.svg diff --git a/src/assets/chapter-04/compliance-interface.svg b/src/assets/07-user-interface/compliance-interface.svg similarity index 100% rename from src/assets/chapter-04/compliance-interface.svg rename to src/assets/07-user-interface/compliance-interface.svg diff --git a/src/assets/chapter-04/designer-interface.svg b/src/assets/07-user-interface/designer-interface.svg similarity index 100% rename from src/assets/chapter-04/designer-interface.svg rename to src/assets/07-user-interface/designer-interface.svg diff --git a/src/assets/chapter-04/drive-interface.svg b/src/assets/07-user-interface/drive-interface.svg similarity index 100% rename from src/assets/chapter-04/drive-interface.svg rename to src/assets/07-user-interface/drive-interface.svg diff --git a/src/assets/chapter-04/kb-semantic-search-flow.svg b/src/assets/07-user-interface/kb-semantic-search-flow.svg similarity index 100% rename from src/assets/chapter-04/kb-semantic-search-flow.svg rename to src/assets/07-user-interface/kb-semantic-search-flow.svg diff --git a/src/assets/chapter-04/mail-interface.svg b/src/assets/07-user-interface/mail-interface.svg similarity index 100% rename from src/assets/chapter-04/mail-interface.svg rename to src/assets/07-user-interface/mail-interface.svg diff --git a/src/assets/chapter-04/meet-interface.svg b/src/assets/07-user-interface/meet-interface.svg similarity index 100% rename from src/assets/chapter-04/meet-interface.svg rename to src/assets/07-user-interface/meet-interface.svg diff --git a/src/assets/chapter-04/paper-interface.svg b/src/assets/07-user-interface/paper-interface.svg similarity index 100% rename from src/assets/chapter-04/paper-interface.svg rename to src/assets/07-user-interface/paper-interface.svg diff --git a/src/assets/chapter-04/research-interface.svg b/src/assets/07-user-interface/research-interface.svg similarity index 100% rename from src/assets/chapter-04/research-interface.svg rename to src/assets/07-user-interface/research-interface.svg diff --git a/src/assets/chapter-04/sources-interface.svg b/src/assets/07-user-interface/sources-interface.svg similarity index 100% rename from src/assets/chapter-04/sources-interface.svg rename to src/assets/07-user-interface/sources-interface.svg diff --git a/src/assets/chapter-04/step-flow-4-steps.svg b/src/assets/07-user-interface/step-flow-4-steps.svg similarity index 100% rename from src/assets/chapter-04/step-flow-4-steps.svg rename to src/assets/07-user-interface/step-flow-4-steps.svg diff --git a/src/assets/chapter-04/suite-main-layout.svg b/src/assets/07-user-interface/suite-main-layout.svg similarity index 100% rename from src/assets/chapter-04/suite-main-layout.svg rename to src/assets/07-user-interface/suite-main-layout.svg diff --git a/src/assets/chapter-04/tasks-interface.svg b/src/assets/07-user-interface/tasks-interface.svg similarity index 100% rename from src/assets/chapter-04/tasks-interface.svg rename to src/assets/07-user-interface/tasks-interface.svg diff --git a/src/assets/chapter-04/whatsapp-integration-flow.svg b/src/assets/07-user-interface/whatsapp-integration-flow.svg similarity index 100% rename from src/assets/chapter-04/whatsapp-integration-flow.svg rename to src/assets/07-user-interface/whatsapp-integration-flow.svg diff --git a/src/assets/chapter-10/api-architecture.svg b/src/assets/08-rest-api-tools/api-architecture.svg similarity index 100% rename from src/assets/chapter-10/api-architecture.svg rename to src/assets/08-rest-api-tools/api-architecture.svg diff --git a/src/assets/chapter-10/api-request-flow.svg b/src/assets/08-rest-api-tools/api-request-flow.svg similarity index 100% rename from src/assets/chapter-10/api-request-flow.svg rename to src/assets/08-rest-api-tools/api-request-flow.svg diff --git a/src/assets/chapter-13/botdevice-architecture.svg b/src/assets/11-hardware-scaling/botdevice-architecture.svg similarity index 100% rename from src/assets/chapter-13/botdevice-architecture.svg rename to src/assets/11-hardware-scaling/botdevice-architecture.svg diff --git a/src/assets/chapter-13/budget-decision-tree.svg b/src/assets/11-hardware-scaling/budget-decision-tree.svg similarity index 100% rename from src/assets/chapter-13/budget-decision-tree.svg rename to src/assets/11-hardware-scaling/budget-decision-tree.svg diff --git a/src/assets/chapter-13/embedded-architecture.svg b/src/assets/11-hardware-scaling/embedded-architecture.svg similarity index 100% rename from src/assets/chapter-13/embedded-architecture.svg rename to src/assets/11-hardware-scaling/embedded-architecture.svg diff --git a/src/assets/chapter-13/gpio-button-interface.svg b/src/assets/11-hardware-scaling/gpio-button-interface.svg similarity index 100% rename from src/assets/chapter-13/gpio-button-interface.svg rename to src/assets/11-hardware-scaling/gpio-button-interface.svg diff --git a/src/assets/chapter-13/local-llm-architecture.svg b/src/assets/11-hardware-scaling/local-llm-architecture.svg similarity index 100% rename from src/assets/chapter-13/local-llm-architecture.svg rename to src/assets/11-hardware-scaling/local-llm-architecture.svg diff --git a/src/assets/chapter-13/orange-pi-5-specs.svg b/src/assets/11-hardware-scaling/orange-pi-5-specs.svg similarity index 100% rename from src/assets/chapter-13/orange-pi-5-specs.svg rename to src/assets/11-hardware-scaling/orange-pi-5-specs.svg diff --git a/src/assets/roadmap-complete.md b/src/assets/roadmap-complete.md index 8d4947dd..1531f6f6 100644 --- a/src/assets/roadmap-complete.md +++ b/src/assets/roadmap-complete.md @@ -29,7 +29,7 @@ This table merges the proposed timeline with all features documented in botbook/ | 1 | Package System (.gbai/.gbot/.gbkb/.gbdialog/.gbtheme) | Your list + botbook | 02-templates/ | | 2 | TALK / HEAR Keywords | Your list + botbook | 06-gbdialog/keyword-talk.md | | 3 | NLP / BERT Intent Recognition | Your list | 06-gbdialog/ | -| 4 | GPT-3.5 Integration | Your list | 08-config/llm-config.md | +| 4 | GPT-3.5 Integration | Your list | 10-configuration-deployment/llm-config.md | | 5 | QR CODE Keyword | Your list + botbook | 06-gbdialog/keyword-qrcode.md | | 6 | SET SCHEDULE Keyword | Your list + botbook | 06-gbdialog/keyword-set-schedule.md | | 7 | LLM Keyword | Your list + botbook | 06-gbdialog/ | @@ -45,14 +45,14 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| -| 1 | Migration v5 → v6 | Your list | 14-migration/ | +| 1 | Migration v5 → v6 | Your list | 12-ecosystem-reference/ | | 2 | Node.js → Rust Rewrite | Your list + botbook | 07-gbapp/architecture.md | | 3 | New Rust Architecture | Your list + botbook | 07-gbapp/crates.md | | 4 | Minimal Flow MVP | Your list | 07-gbapp/ | -| 5 | PostgreSQL + Diesel ORM | botbook | 15-appendix/schema.md | +| 5 | PostgreSQL + Diesel ORM | botbook | 12-ecosystem-reference/schema.md | | 6 | Auto-Bootstrap System | botbook | 01-introduction/ | -| 7 | Vault Secrets Management | botbook | 08-config/secrets-management.md | -| 8 | Basic HTMX UI | botbook | 04-gbui/htmx-architecture.md | +| 7 | Vault Secrets Management | botbook | 10-configuration-deployment/secrets-management.md | +| 8 | Basic HTMX UI | botbook | 07-user-interface/htmx-architecture.md | --- @@ -61,15 +61,15 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| | 1 | BASIC Engine (70+ keywords) | Your list + botbook | 06-gbdialog/keywords.md | -| 2 | System Automation (cron) | Your list + botbook | 11-features/automation.md | -| 3 | Web Chat Channel | Your list + botbook | 04-gbui/apps/chat.md | -| 4 | LLM Integration (multi-provider) | Your list + botbook | 08-config/llm-config.md | +| 2 | System Automation (cron) | Your list + botbook | 03-knowledge-ai/automation.md | +| 3 | Web Chat Channel | Your list + botbook | 07-user-interface/apps/chat.md | +| 4 | LLM Integration (multi-provider) | Your list + botbook | 10-configuration-deployment/llm-config.md | | 5 | Drive Storage (S3) | Your list + botbook | 02-templates/gbdrive.md | -| 6 | Email System (IMAP/SMTP) | Your list + botbook | 11-features/email.md | -| 7 | REST API | Your list + botbook | 10-rest/ | -| 8 | **Telegram Channel** | botbook | 11-features/channels.md | +| 6 | Email System (IMAP/SMTP) | Your list + botbook | 03-knowledge-ai/email.md | +| 7 | REST API | Your list + botbook | 08-rest-api-tools/ | +| 8 | **Telegram Channel** | botbook | 03-knowledge-ai/channels.md | | 9 | **PDF Generation** | botbook | 06-gbdialog/keyword-generate-pdf.md | -| 10 | **WhatsApp Channel** | botbook | 11-features/channels.md | +| 10 | **WhatsApp Channel** | botbook | 03-knowledge-ai/channels.md | --- @@ -80,13 +80,13 @@ This table merges the proposed timeline with all features documented in botbook/ | 1 | Tasks AI Autonomous (AUTOTASK) | Your list + botbook | 07-gbapp/autonomous-tasks.md | | 2 | Knowledge Base (Vector) | Your list + botbook | 03-knowledge-base/ | | 3 | Vector Database (Qdrant) | Your list + botbook | 03-knowledge-base/vector-collections.md | -| 4 | Tools System (MCP) | Your list + botbook | 09-tools/ | -| 5 | UI Minimal Suite | Your list + botbook | 04-gbui/ | +| 4 | Tools System (MCP) | Your list + botbook | 08-rest-api-tools/ | +| 5 | UI Minimal Suite | Your list + botbook | 07-user-interface/ | | 6 | APP Generator | Your list + botbook | 07-gbapp/autonomous-tasks.md | | 7 | **BOT Generator** | botbook | 07-gbapp/autonomous-tasks.md | | 8 | **SITE Generator** | botbook | 06-gbdialog/keyword-create-site.md | | 9 | **LANDPAGE Generator** | botbook | 07-gbapp/autonomous-tasks.md | -| 10 | **Analytics Dashboard** | botbook | 04-gbui/apps/analytics.md | +| 10 | **Analytics Dashboard** | botbook | 07-user-interface/apps/analytics.md | --- @@ -95,17 +95,17 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| | 1 | **Tasks AI GO** ⭐ | Your list + botbook | 07-gbapp/autonomous-tasks.md | -| 2 | Gmail Integration | Your list | 10-rest/email-api.md | -| 3 | Outlook/Hotmail | Your list | 10-rest/email-api.md | -| 4 | Google Drive | Your list | 08-config/drive.md | -| 5 | OneDrive | Your list | 08-config/drive.md | -| 6 | Google Calendar | Your list | 10-rest/calendar-api.md | -| 7 | Outlook Calendar | Your list | 10-rest/calendar-api.md | -| 8 | Speech to Text | Your list | 08-config/multimodal.md | -| 9 | Image Generation | Your list | 08-config/multimodal.md | -| 10 | Vision Analysis | Your list | 08-config/multimodal.md | -| 11 | **MS Teams Channel** | Your list + botbook | 11-features/channels.md | -| 12 | **Multi-Agent System** | Your list + botbook | 11-features/multi-agent-orchestration.md | +| 2 | Gmail Integration | Your list | 08-rest-api-tools/email-api.md | +| 3 | Outlook/Hotmail | Your list | 08-rest-api-tools/email-api.md | +| 4 | Google Drive | Your list | 10-configuration-deployment/drive.md | +| 5 | OneDrive | Your list | 10-configuration-deployment/drive.md | +| 6 | Google Calendar | Your list | 08-rest-api-tools/calendar-api.md | +| 7 | Outlook Calendar | Your list | 08-rest-api-tools/calendar-api.md | +| 8 | Speech to Text | Your list | 10-configuration-deployment/multimodal.md | +| 9 | Image Generation | Your list | 10-configuration-deployment/multimodal.md | +| 10 | Vision Analysis | Your list | 10-configuration-deployment/multimodal.md | +| 11 | **MS Teams Channel** | Your list + botbook | 03-knowledge-ai/channels.md | +| 12 | **Multi-Agent System** | Your list + botbook | 03-knowledge-ai/multi-agent-orchestration.md | --- @@ -113,20 +113,20 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| -| 1 | **Paper App (AI Writing)** | botbook | 04-gbui/apps/paper.md | -| 2 | **Research App (AI Search)** | botbook | 04-gbui/apps/research.md | -| 3 | **Transfer to Human** | botbook | 11-features/transfer-to-human.md | -| 4 | **LLM-Assisted Attendant** (AI Copilot for Agents) | botbook | 11-features/attendant-llm-assist.md | +| 1 | **Paper App (AI Writing)** | botbook | 07-user-interface/apps/paper.md | +| 2 | **Research App (AI Search)** | botbook | 07-user-interface/apps/research.md | +| 3 | **Transfer to Human** | botbook | 03-knowledge-ai/transfer-to-human.md | +| 4 | **LLM-Assisted Attendant** (AI Copilot for Agents) | botbook | 03-knowledge-ai/attendant-llm-assist.md | | 5 | Bot Marketplace | Your list | Future | -| 6 | Compliance Suite | Your list + botbook | 04-gbui/apps/compliance.md | -| 7 | Analytics Reports | Your list + botbook | 10-rest/analytics-api.md | -| 8 | **Slack Channel** | botbook | 11-features/channels.md | -| 9 | **Discord Channel** | botbook | 11-features/channels.md | +| 6 | Compliance Suite | Your list + botbook | 07-user-interface/apps/compliance.md | +| 7 | Analytics Reports | Your list + botbook | 08-rest-api-tools/analytics-api.md | +| 8 | **Slack Channel** | botbook | 03-knowledge-ai/channels.md | +| 9 | **Discord Channel** | botbook | 03-knowledge-ai/channels.md | | 10 | **Google Sheets** | botbook | Future | | 11 | **Excel Online** | botbook | Future | -| 12 | **Whiteboard Collaboration** | botbook | 10-rest/whiteboard-api.md | -| 13 | **Player App (Media)** | botbook | 04-gbui/apps/player.md | -| 14 | **Sources App (Prompts)** | botbook | 04-gbui/apps/sources.md | +| 12 | **Whiteboard Collaboration** | botbook | 08-rest-api-tools/whiteboard-api.md | +| 13 | **Player App (Media)** | botbook | 07-user-interface/apps/player.md | +| 14 | **Sources App (Prompts)** | botbook | 07-user-interface/apps/sources.md | --- @@ -134,11 +134,11 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| -| 1 | Workflow Designer | Your list + botbook | 04-gbui/apps/designer.md | +| 1 | Workflow Designer | Your list + botbook | 07-user-interface/apps/designer.md | | 2 | CRM Integration | Your list | 02-templates/template-crm.md | -| 3 | **Voice Synthesis (TTS)** | botbook | 08-config/multimodal.md | +| 3 | **Voice Synthesis (TTS)** | botbook | 10-configuration-deployment/multimodal.md | | 4 | **ERP Integration** | botbook | 02-templates/template-erp.md | -| 5 | **Instagram Channel** | botbook | 11-features/channels.md | +| 5 | **Instagram Channel** | botbook | 03-knowledge-ai/channels.md | | 6 | **SMS Channel** | botbook | 06-gbdialog/keyword-sms.md | --- @@ -148,12 +148,12 @@ This table merges the proposed timeline with all features documented in botbook/ | # | Feature | Source | Documentation | |---|---------|--------|---------------| | 1 | Mobile Apps (iOS/Android) | Your list + botbook | 13-devices/mobile.md | -| 2 | Enterprise SSO (SAML/OIDC) | Your list + botbook | 12-auth/ | -| 3 | **Backup & Restore** | botbook | 10-rest/backup-api.md | -| 4 | **NVIDIA GPU Support** | botbook | 09-tools/nvidia-gpu-setup.md | +| 2 | Enterprise SSO (SAML/OIDC) | Your list + botbook | 09-security/ | +| 3 | **Backup & Restore** | botbook | 08-rest-api-tools/backup-api.md | +| 4 | **NVIDIA GPU Support** | botbook | 08-rest-api-tools/nvidia-gpu-setup.md | | 5 | **Docker Deployment** | botbook | 07-gbapp/docker-deployment.md | | 6 | **LXC Containers** | botbook | 07-gbapp/containers.md | -| 7 | **Advanced Monitoring** | botbook | 10-rest/monitoring-api.md | +| 7 | **Advanced Monitoring** | botbook | 08-rest-api-tools/monitoring-api.md | --- @@ -161,19 +161,19 @@ This table merges the proposed timeline with all features documented in botbook/ | App | Category | Timeline | Documentation | |-----|----------|----------|---------------| -| Chat | Core | 2025 H1 ✅ | 04-gbui/apps/chat.md | -| Drive | Storage | 2025 H1 ✅ | 04-gbui/apps/drive.md | -| Tasks | Productivity | 2025 H2 ✅ | 04-gbui/apps/tasks.md | -| Mail | Communication | 2025 H1 ✅ | 04-gbui/apps/mail.md | -| Calendar | Scheduling | 2026 Q1 📋 | 04-gbui/apps/calendar.md | -| Meet | Video | 2026 Q2 📋 | 04-gbui/apps/meet.md | -| Paper | AI Writing | 2026 Q2 📋 | 04-gbui/apps/paper.md | -| Research | AI Search | 2026 Q2 📋 | 04-gbui/apps/research.md | -| Analytics | Reports | 2025 H2 ✅ | 04-gbui/apps/analytics.md | -| Designer | Visual | 2026 Q3 📋 | 04-gbui/apps/designer.md | -| Sources | Prompts | 2026 Q2 📋 | 04-gbui/apps/sources.md | -| Compliance | Security | 2026 Q2 📋 | 04-gbui/apps/compliance.md | -| Player | Media | 2026 Q2 📋 | 04-gbui/apps/player.md | +| Chat | Core | 2025 H1 ✅ | 07-user-interface/apps/chat.md | +| Drive | Storage | 2025 H1 ✅ | 07-user-interface/apps/drive.md | +| Tasks | Productivity | 2025 H2 ✅ | 07-user-interface/apps/tasks.md | +| Mail | Communication | 2025 H1 ✅ | 07-user-interface/apps/mail.md | +| Calendar | Scheduling | 2026 Q1 📋 | 07-user-interface/apps/calendar.md | +| Meet | Video | 2026 Q2 📋 | 07-user-interface/apps/meet.md | +| Paper | AI Writing | 2026 Q2 📋 | 07-user-interface/apps/paper.md | +| Research | AI Search | 2026 Q2 📋 | 07-user-interface/apps/research.md | +| Analytics | Reports | 2025 H2 ✅ | 07-user-interface/apps/analytics.md | +| Designer | Visual | 2026 Q3 📋 | 07-user-interface/apps/designer.md | +| Sources | Prompts | 2026 Q2 📋 | 07-user-interface/apps/sources.md | +| Compliance | Security | 2026 Q2 📋 | 07-user-interface/apps/compliance.md | +| Player | Media | 2026 Q2 📋 | 07-user-interface/apps/player.md | --- @@ -181,13 +181,13 @@ This table merges the proposed timeline with all features documented in botbook/ | Channel | Timeline | Documentation | |---------|----------|---------------| -| Web Chat | 2025 H1 ✅ | 04-gbui/apps/chat.md | -| WhatsApp | 2025 H1 ✅ | 11-features/channels.md | -| Telegram | 2025 H1 ✅ | 11-features/channels.md | -| MS Teams | 2026 Q1 📋 | 11-features/channels.md | -| Slack | 2026 Q2 📋 | 11-features/channels.md | -| Discord | 2026 Q2 📋 | 11-features/channels.md | -| Instagram | 2026 Q3 📋 | 11-features/channels.md | +| Web Chat | 2025 H1 ✅ | 07-user-interface/apps/chat.md | +| WhatsApp | 2025 H1 ✅ | 03-knowledge-ai/channels.md | +| Telegram | 2025 H1 ✅ | 03-knowledge-ai/channels.md | +| MS Teams | 2026 Q1 📋 | 03-knowledge-ai/channels.md | +| Slack | 2026 Q2 📋 | 03-knowledge-ai/channels.md | +| Discord | 2026 Q2 📋 | 03-knowledge-ai/channels.md | +| Instagram | 2026 Q3 📋 | 03-knowledge-ai/channels.md | | SMS | 2026 Q3 📋 | 06-gbdialog/keyword-sms.md | --- @@ -204,12 +204,12 @@ This table merges the proposed timeline with all features documented in botbook/ | Feature | Timeline | Documentation | |---------|----------|---------------| -| PostgreSQL | 2024 ✅ | 15-appendix/schema.md | +| PostgreSQL | 2024 ✅ | 12-ecosystem-reference/schema.md | | Redis Cache | 2024 ✅ | 07-gbapp/architecture.md | -| MinIO/S3 | 2024 ✅ | 08-config/drive.md | +| MinIO/S3 | 2024 ✅ | 10-configuration-deployment/drive.md | | Qdrant Vector | 2025 H2 ✅ | 03-knowledge-base/ | -| Vault Secrets | 2024 ✅ | 08-config/secrets-management.md | -| NVIDIA GPU | 2026 Q4 📋 | 09-tools/nvidia-gpu-setup.md | +| Vault Secrets | 2024 ✅ | 10-configuration-deployment/secrets-management.md | +| NVIDIA GPU | 2026 Q4 📋 | 08-rest-api-tools/nvidia-gpu-setup.md | | Docker | 2026 Q4 📋 | 07-gbapp/docker-deployment.md | | LXC | 2026 Q4 📋 | 07-gbapp/containers.md | diff --git a/src/attendance.md b/src/attendance.md index 1031c835..81fc5a6d 100644 --- a/src/attendance.md +++ b/src/attendance.md @@ -2369,7 +2369,7 @@ O plano atual cobre **~70% das features enterprise-grade**: ## 14. Arquivo de Referência Ver também: -- [Transfer to Human](11-features/transfer-to-human.md) -- [LLM Assist](11-features/attendant-llm-assist.md) -- [Attendance Queue](18-appendix-external-services/attendance-queue.md) -- [WhatsApp Setup](chapter-04-gbui/how-to/connect-whatsapp.md) +- [Transfer to Human](03-knowledge-ai/transfer-to-human.md) +- [LLM Assist](03-knowledge-ai/attendant-llm-assist.md) +- [Attendance Queue](06-channels/attendance-queue.md) +- [WhatsApp Setup](07-user-interface/how-to/connect-whatsapp.md) diff --git a/src/executive-vision.md b/src/executive-vision.md index a817328a..de1e3795 100644 --- a/src/executive-vision.md +++ b/src/executive-vision.md @@ -274,15 +274,15 @@ Pragmatismo develops General Bots as an open-source platform for enterprise AI a Ready to see it in action? Skip to the hands-on guide: -**[⚡ Quick Start: Run Your First Bot in 5 Minutes →](./chapter-01/quick-start.md)** +**[⚡ Quick Start: Run Your First Bot in 5 Minutes →](./01-getting-started/quick-start.md)** Or continue reading for the full journey: | Path | Time | Best For | |------|------|----------| -| [Quick Start](./chapter-01/quick-start.md) | 5 min | Developers who want to dive in immediately | +| [Quick Start](./01-getting-started/quick-start.md) | 5 min | Developers who want to dive in immediately | | [Introduction](./introduction.md) | 10 min | Understanding the "No Forms" philosophy | -| [Chapter 01](./chapter-01/README.md) | 15 min | Complete installation and first conversation | +| [Chapter 01](./01-getting-started/README.md) | 15 min | Complete installation and first conversation | --- @@ -306,4 +306,4 @@ Or continue reading for the full journey: -[Chapter 01: Run and Talk →](./chapter-01/README.md) \ No newline at end of file +[Chapter 01: Run and Talk →](./01-getting-started/README.md) \ No newline at end of file diff --git a/src/introduction.md b/src/introduction.md index 2e9688de..88e5a09b 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -1,15 +1,15 @@ # Introduction to General Bots -> **⚡ Want to skip ahead?** [Quick Start →](./chapter-01/quick-start.md) gets you running in 5 minutes. +> **⚡ Want to skip ahead?** [Quick Start →](./01-getting-started/quick-start.md) gets you running in 5 minutes. -**Build conversational AI bots in minutes, not months.** General Bots lets you create intelligent chatbots by writing simple [BASIC scripts](./chapter-06-gbdialog/basics.md) and dropping in your [documents](./chapter-02/gbkb.md). No complex frameworks, no cloud dependencies, no AI expertise required. +**Build conversational AI bots in minutes, not months.** General Bots lets you create intelligent chatbots by writing simple [BASIC scripts](./04-basic-scripting/basics.md) and dropping in your [documents](./02-architecture-packages/gbkb.md). No complex frameworks, no cloud dependencies, no AI expertise required. | Your Goal | Go To | |-----------|-------| -| Run a bot NOW | [Quick Start](./chapter-01/quick-start.md) | +| Run a bot NOW | [Quick Start](./01-getting-started/quick-start.md) | | Understand the vision | Keep reading below | -| Write your first script | [Chapter 06: BASIC Dialogs](./chapter-06-gbdialog/README.md) | -| Add documents to bot | [Chapter 02: Packages](./chapter-02/README.md) | +| Write your first script | [Chapter 06: BASIC Dialogs](./04-basic-scripting/README.md) | +| Add documents to bot | [Chapter 02: Packages](./02-architecture-packages/README.md) | ## The No Forms Movement @@ -134,14 +134,14 @@ This is why General Bots focuses on: Want a student enrollment bot? Here's all you need: -1. **Drop your documents** in a [`.gbkb` folder](./chapter-02/gbkb.md): +1. **Drop your documents** in a [`.gbkb` folder](./02-architecture-packages/gbkb.md): ``` edu.gbkb/ enrollment-policy.pdf course-catalog.pdf ``` -2. **Write a simple [tool](./chapter-03/kb-and-tools.md)** (optional): +2. **Write a simple [tool](./03-knowledge-ai/kb-and-tools.md)** (optional): ```basic ' enrollment.bas PARAM name, email, course @@ -165,10 +165,10 @@ No form. No UI. Just conversation. ```bash ./botserver ``` -That's it. No Kubernetes, no cloud accounts. The [bootstrap process](./chapter-01/installation.md) installs everything locally in 2-5 minutes. PostgreSQL, vector database, object storage, cache - all configured automatically with secure credentials stored in Vault. +That's it. No Kubernetes, no cloud accounts. The [bootstrap process](./01-getting-started/installation.md) installs everything locally in 2-5 minutes. PostgreSQL, vector database, object storage, cache - all configured automatically with secure credentials stored in Vault. ### Real BASIC, Real Simple -We brought BASIC back for conversational AI. See our [complete keyword reference](./chapter-06-gbdialog/keywords.md): +We brought BASIC back for conversational AI. See our [complete keyword reference](./04-basic-scripting/keywords.md): ```basic ' save-note.bas - A simple tool PARAM topic, content @@ -291,10 +291,10 @@ The default bot is ready. Ask it anything. Modify `templates/default.gbai/` to c ## What's Next? -- **[Chapter 01](./chapter-01/README.md)** - Install and run your first bot -- **[Chapter 02](./chapter-02/README.md)** - Understanding packages -- **[Chapter 06](./chapter-06-gbdialog/README.md)** - Writing BASIC dialogs -- **[Templates](./chapter-02/templates.md)** - Explore example bots +- **[Chapter 01](./01-getting-started/README.md)** - Install and run your first bot +- **[Chapter 02](./02-architecture-packages/README.md)** - Understanding packages +- **[Chapter 06](./04-basic-scripting/README.md)** - Writing BASIC dialogs +- **[Templates](./02-architecture-packages/templates.md)** - Explore example bots ## Community @@ -304,7 +304,7 @@ General Bots is open source (AGPL-3.0) developed by Pragmatismo.com.br and contr - **Version**: 6.1.0 - **Status**: Production Ready -Ready to build your bot? Turn to [Chapter 01](./chapter-01/README.md) and let's go! +Ready to build your bot? Turn to [Chapter 01](./01-getting-started/README.md) and let's go! ---