GeneralBots/botserver
2
1
Fork 0
Code Issues Pull requests Projects Releases 323 Packages Wiki Activity Actions
botserver/docs/src/SUMMARY.md

199 lines
8.4 KiB
Markdown
Raw Normal View History

Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Summary
[Introduction](./introduction.md)
# Part I - Getting Started
- [Chapter 01: Run and Talk](./chapter-01/README.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [Overview](./chapter-01/overview.md)
- [Quick Start](./chapter-01/quick-start.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Installation](./chapter-01/installation.md)
- [First Conversation](./chapter-01/first-conversation.md)
- [Understanding Sessions](./chapter-01/sessions.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [NVIDIA GPU Setup for LXC](./chapter-01/nvidia-gpu-setup.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part II - Package System
- [Chapter 02: About Packages](./chapter-02/README.md)
- [.gbai Architecture](./chapter-02/gbai.md)
- [.gbdialog Dialogs](./chapter-02/gbdialog.md)
- [.gbkb Knowledge Base](./chapter-02/gbkb.md)
- [.gbot Bot Configuration](./chapter-02/gbot.md)
- [.gbtheme UI Theming](./chapter-02/gbtheme.md)
- [.gbdrive File Storage](./chapter-02/gbdrive.md)
- New docds.
2025-11-22 16:12:32 -03:00
- [Bot Templates](./chapter-02/templates.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part III - Knowledge Base
- [Chapter 03: gbkb Reference](./chapter-03/README.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [KB and Tools System](./chapter-03/kb-and-tools.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Vector Collections](./chapter-03/vector-collections.md)
- [Document Indexing](./chapter-03/indexing.md)
- [Qdrant Integration](./chapter-03/qdrant.md)
- [Semantic Search](./chapter-03/semantic-search.md)
- [Context Compaction](./chapter-03/context-compaction.md)
- [Semantic Caching](./chapter-03/caching.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [Semantic Cache with Valkey](./chapter-03/semantic-cache.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part IV - Themes and UI
- [Chapter 04: gbtheme Reference](./chapter-04/README.md)
- [Theme Structure](./chapter-04/structure.md)
- [Web Interface](./chapter-04/web-interface.md)
- [CSS Customization](./chapter-04/css.md)
- [HTML Templates](./chapter-04/html.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [Desktop Mode](./chapter-04/desktop-mode.md)
- [Console Mode](./chapter-04/console-mode.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part V - BASIC Dialogs
- [Chapter 05: gbdialog Reference](./chapter-05/README.md)
- [Dialog Basics](./chapter-05/basics.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [Universal Messaging & Multi-Channel](./chapter-05/universal-messaging.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Template Examples](./chapter-05/templates.md)
- [start.bas](./chapter-05/template-start.md)
- [generate-summary.bas](./chapter-05/template-summary.md)
- [enrollment Tool Example](./chapter-05/template-enrollment.md)
- [Keyword Reference](./chapter-05/keywords.md)
- [TALK](./chapter-05/keyword-talk.md)
- [HEAR](./chapter-05/keyword-hear.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [SET USER](./chapter-05/keyword-set-user.md)
- [SET CONTEXT](./chapter-05/keyword-set-context.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [LLM](./chapter-05/keyword-llm.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [GET BOT MEMORY](./chapter-05/keyword-get-bot-memory.md)
- [SET BOT MEMORY](./chapter-05/keyword-set-bot-memory.md)
- [USE KB](./chapter-05/keyword-use-kb.md)
- [CLEAR KB](./chapter-05/keyword-clear-kb.md)
- [ADD WEBSITE](./chapter-05/keyword-add-website.md)
- [USE TOOL](./chapter-05/keyword-use-tool.md)
- [CLEAR TOOLS](./chapter-05/keyword-clear-tools.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [GET](./chapter-05/keyword-get.md)
- [SET](./chapter-05/keyword-set.md)
- [ON](./chapter-05/keyword-on.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [SET SCHEDULE](./chapter-05/keyword-set-schedule.md)
- [CREATE SITE](./chapter-05/keyword-create-site.md)
- [CREATE DRAFT](./chapter-05/keyword-create-draft.md)
- [CREATE TASK](./chapter-05/keyword-create-task.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [PRINT](./chapter-05/keyword-print.md)
- [WAIT](./chapter-05/keyword-wait.md)
- [FORMAT](./chapter-05/keyword-format.md)
- [FIRST](./chapter-05/keyword-first.md)
- [LAST](./chapter-05/keyword-last.md)
- [FOR EACH](./chapter-05/keyword-for-each.md)
- [EXIT FOR](./chapter-05/keyword-exit-for.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [ADD MEMBER](./chapter-05/keyword-add-member.md)
- [ADD SUGGESTION](./chapter-05/keyword-add-suggestion.md)
- [CLEAR SUGGESTIONS](./chapter-05/keyword-clear-suggestions.md)
- New docds.
2025-11-22 16:12:32 -03:00
- [BOOK](./chapter-05/keyword-book.md)
- [REMEMBER](./chapter-05/keyword-remember.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [SAVE FROM UNSTRUCTURED](./chapter-05/keyword-save-from-unstructured.md)
- [SEND MAIL](./chapter-05/keyword-send-mail.md)
- New docds.
2025-11-22 16:12:32 -03:00
- [WEATHER](./chapter-05/keyword-weather.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [FIND](./chapter-05/keyword-find.md)
- [CHANGE THEME](./chapter-05/keyword-change-theme.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part VI - Extending BotServer
- New keywords.
2025-11-21 10:44:29 -03:00
- [Chapter 06: Rust Architecture Reference](./chapter-06/README.md)
- [Architecture Overview](./chapter-06/architecture.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Building from Source](./chapter-06/building.md)
WPP.
2025-11-21 12:13:48 -03:00
- [Container Deployment (LXC)](./chapter-06/containers.md)
- New keywords.
2025-11-21 10:44:29 -03:00
- [Module Structure](./chapter-06/crates.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Service Layer](./chapter-06/services.md)
- [Creating Custom Keywords](./chapter-06/custom-keywords.md)
- [Adding Dependencies](./chapter-06/dependencies.md)
- New docds.
2025-11-22 16:12:32 -03:00
- [Prompt Manager](./chapter-06/prompt-manager.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part VII - Bot Configuration
- [Chapter 07: gbot Reference](./chapter-07/README.md)
- [config.csv Format](./chapter-07/config-csv.md)
- [Bot Parameters](./chapter-07/parameters.md)
- [LLM Configuration](./chapter-07/llm-config.md)
- [Context Configuration](./chapter-07/context-config.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [Drive Integration](./chapter-07/minio.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Part VIII - Tools and Integration
- [Chapter 08: Tooling](./chapter-08/README.md)
- [Tool Definition](./chapter-08/tool-definition.md)
- [PARAM Declaration](./chapter-08/param-declaration.md)
- [Tool Compilation](./chapter-08/compilation.md)
- [MCP Format](./chapter-08/mcp-format.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [Tool Format](./chapter-08/openai-format.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [GET Keyword Integration](./chapter-08/get-integration.md)
- [External APIs](./chapter-08/external-apis.md)
# Part IX - Feature Reference
- [Chapter 09: Feature Matrix](./chapter-09/README.md)
- [Core Features](./chapter-09/core-features.md)
- [Conversation Management](./chapter-09/conversation.md)
- [AI and LLM](./chapter-09/ai-llm.md)
- [Knowledge Base](./chapter-09/knowledge-base.md)
- [Automation](./chapter-09/automation.md)
- [Email Integration](./chapter-09/email.md)
- [Web Automation](./chapter-09/web-automation.md)
- [Storage and Data](./chapter-09/storage.md)
- [Multi-Channel Support](./chapter-09/channels.md)
# Part X - Community
- [Chapter 10: Contributing](./chapter-10/README.md)
- [Development Setup](./chapter-10/setup.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [Contributing Guidelines](./chapter-10/contributing-guidelines.md)
- [Code of Conduct](./chapter-10/code-of-conduct.md)
- [Código de Conduta (Português)](./chapter-10/code-of-conduct-pt-br.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
- [Code Standards](./chapter-10/standards.md)
- [Testing](./chapter-10/testing.md)
- [Pull Requests](./chapter-10/pull-requests.md)
- [Documentation](./chapter-10/documentation.md)
- More general docs.
2025-11-23 13:46:55 -03:00
- [IDE Extensions](./chapter-10/ide-extensions.md)
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
docs: expand session management and add authentication section Enhanced Chapter 1 documentation with detailed session architecture, storage layers, and API endpoints. Added new Part XI on authentication and security to SUMMARY.md, introducing chapters on user and bot authentication, password security, and API endpoints. Improves clarity and coverage of system interaction and security concepts.
2025-11-03 20:42:38 -03:00
# Part XI - Authentication and Security
- [Chapter 11: Authentication](./chapter-11/README.md)
- [User Authentication](./chapter-11/user-auth.md)
- [Password Security](./chapter-11/password-security.md)
- [API Endpoints](./chapter-11/api-endpoints.md)
- [Bot Authentication](./chapter-11/bot-auth.md)
- New security features and compliance checklist.
2025-11-22 13:24:53 -03:00
- [Security Features](./chapter-11/security-features.md)
- [Security Policy](./chapter-11/security-policy.md)
- [Compliance Requirements](./chapter-11/compliance-requirements.md)
# Part XII - REST API Reference
- [Chapter 12: REST API Reference](./chapter-12/README.md)
- [Files API](./chapter-12/files-api.md)
- [Document Processing API](./chapter-12/document-processing.md)
- [Users API](./chapter-12/users-api.md)
- [User Security API](./chapter-12/user-security.md)
- [Groups API](./chapter-12/groups-api.md)
- [Group Membership API](./chapter-12/group-membership.md)
- [Conversations API](./chapter-12/conversations-api.md)
- [Calls API](./chapter-12/calls-api.md)
- [Whiteboard API](./chapter-12/whiteboard-api.md)
- [Email API](./chapter-12/email-api.md)
- [Notifications API](./chapter-12/notifications-api.md)
- [Calendar API](./chapter-12/calendar-api.md)
- [Tasks API](./chapter-12/tasks-api.md)
- [Storage API](./chapter-12/storage-api.md)
- [Backup API](./chapter-12/backup-api.md)
- [Analytics API](./chapter-12/analytics-api.md)
- [Reports API](./chapter-12/reports-api.md)
- [Admin API](./chapter-12/admin-api.md)
- [Monitoring API](./chapter-12/monitoring-api.md)
- [AI API](./chapter-12/ai-api.md)
- [ML API](./chapter-12/ml-api.md)
- [Security API](./chapter-12/security-api.md)
- [Compliance API](./chapter-12/compliance-api.md)
- [Example Integrations](./chapter-12/examples.md)
docs: expand session management and add authentication section Enhanced Chapter 1 documentation with detailed session architecture, storage layers, and API endpoints. Added new Part XI on authentication and security to SUMMARY.md, introducing chapters on user and bot authentication, password security, and API endpoints. Improves clarity and coverage of system interaction and security concepts.
2025-11-03 20:42:38 -03:00
Add comprehensive documentation for GeneralBots, including keyword references, templates, and user guides - Created detailed markdown files for keywords such as HEAR, TALK, and SET_USER. - Added examples and usage notes for each keyword to enhance user understanding. - Developed templates for common tasks like enrollment and authentication. - Structured documentation into chapters covering various aspects of the GeneralBots platform, including gbapp, gbkb, and gbtheme. - Introduced a glossary for key terms and concepts related to GeneralBots. - Implemented a user-friendly table of contents for easy navigation.
2025-10-25 14:50:14 -03:00
# Appendices
- [Appendix I: Database Model](./appendix-i/README.md)
- [Schema Overview](./appendix-i/schema.md)
- [Tables](./appendix-i/tables.md)
- [Relationships](./appendix-i/relationships.md)
- More general docs.
2025-11-23 13:46:55 -03:00
[Glossary](./glossary.md)
Reference in a new issue Copy permalink