Rodrigo Rodriguez (Pragmatismo) 3bb19a3b4c 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

9.9 KiB

Raw Blame History

continue this style: generate a docusaurs using mdBook for the application in a point of view of the user, a BASIC person basic knowledge wwkring with LLM.

GeneralBots User Documentation (mdBook) Code only use real keywords generate a docusaurs using mdBook for the application in a point of view of the user, a BASIC person basic knowledge wwkring with LLM. do not talk a line of rust outside .gbapp chapter!!! you are doing gretae do not invent anything. enhance that wil more text by your analysis of source code enterily Table of Contents Chapter 01 - Run and Talk Chapter 02 - About Packages Chapter 03 - gbkb Reference (each colletion is a vectordb collectoin that can be choosen to participate in conversation context - compacted and with cache) Chapter 04 - gbtheme Reference (change Ui themes with css and html (web/index.html) Chapter 05 - gbdialog Reference (basic tools found in @/templates..... .bas files as REAL EXAMPLES) + keywords.rs mod keywords... Chapter 06 - gbapp Reference (now here, you teach how to build the botserver rust and extend new crates... RUST ONLY APPEARS HERE) Chapter 07 - gbot Reference (show @src/shard/models/ bot_config) user can put in drive .gbot with config.csv and configure various bot params. like anserMode, bot descrptoion, eec.) Chapter 08 - Tooling (Talke about the BASIC AND HOW GET keyword call call external tools integratis features. Chapter 09 - Feature-Matrix (List categories all features of this source code) Chapter 10 - Contributing ( Apendix I - Database Model Glossary the only keywords that exists are in @/src/basic/keywords/on.rs for .gbdialog!!!! FUCK; the only thikg .gbkb does is to store collections that can be use in the way ADD_KB keyword like @/templates/announcements.gbai/announcements.gbdialog scripts!!! FUCK.. .gbot will contain a config.csv that mimic the @/src/shared/models.rs bot_config so people can edit it from their DRIVE (minio bot bucket) that contains .gbkb, .gbdialog, .gbot, .gbdrive, .gbtheme!

gbapp are folder extensions within the GeneralBots package type, responsible for GeneralBots services in a back-end development environment. A General Bot App comprises four components: dialogs, models, services, and tests.
The .gbui extension pertains to the GeneralBots front-end development environment. Angular, Riot, React, and HTML enable dynamic functionality for GeneralBots services.
The .gtheme extension is utilized by GeneralBots designers using CSS and PS technologies. A theme consists of CSS files and images.
.gbDialog is an extension responsible for GeneralBots' communication with end-users through bot services. .gbkb is a package for executing various types of media.
The .gbot extension refers to the GeneralBots service product.
.gbai denotes the architecture construction of the GeneralBots application.

GeneralBots User Documentation I'll create a comprehensive mdBook documentation based on the actual source code, using only real keywords and features.

GeneralBots Documentation (mdBook) Code do not write any BASIC example more than templates folder start.bas auth.bas and generate-summary.bas, and include a ingle example of TOOL: PARAM name AS string LIKE "Abreu Silva" DESCRIPTION "Required full name of the individual." PARAM birthday AS date LIKE "23/09/2001" DESCRIPTION "Required birth date of the individual in DD/MM/YYYY format." PARAM email AS string LIKE "abreu.silva@example.com" DESCRIPTION "Required email address for contact purposes." PARAM personalid AS integer LIKE "12345678900" DESCRIPTION "Required Personal ID number of the individual (only numbers)." PARAM address AS string LIKE "Rua das Flores, 123 - SP" DESCRIPTION "Required full address of the individual." DESCRIPTION "This is a the enrollment process, called when the user wants to enrol. Once all information is collected, confirm the details and inform them that their enrollment request has been successfully submitted. Provide a polite and professional tone throughout the interaction." SAVE "enrollments.csv", id, name, birthday, email, personalid, address that is in termos of basic samples, but show all keywords with one with independant page. inside .gbdialog section, more text

I'll create a comprehensive mdBook documentation focusing on the actual templates and all real keywords from the source code.