Commit graph

339 commits

Author SHA1 Message Date
da1b634eef docs: add ON EMAIL and ON CHANGE keyword documentation
- Add keyword-on-email.md (236 lines)
- Add keyword-on-change.md (300 lines)
- Update SUMMARY.md with new keywords
- Update PROMPT.md with weekly maintenance checklist
2025-12-18 16:18:04 -03:00
6ce6db62e9 Add rotate-secret documentation and security hardening guide 2025-12-18 11:20:45 -03:00
dd83b3e802 Add version command docs and security best practices 2025-12-18 11:06:29 -03:00
1fd5b13595 Add CLI reference documentation with vault commands 2025-12-18 10:59:17 -03:00
2c930a3316 docs: update 2025-12-17 17:44:07 -03:00
3629e948ef Disable auto-trigger CI - manual only via workflow_dispatch 2025-12-16 17:07:13 -03:00
ed36904c49 Revert "Disable CI - built via botserver-bundle"
This reverts commit db626c18c3.
2025-12-16 17:04:56 -03:00
db626c18c3 Disable CI - built via botserver-bundle 2025-12-16 17:02:20 -03:00
b681041046 Add Forgejo CI workflow for botbook - Build and deploy docs 2025-12-16 13:25:14 -03:00
de004aa82b Update PROMPT.md, SUMMARY.md and add ROADMAP 2025-12-15 16:36:25 -03:00
25355f7066 Add USE MCP documentation and update Sources docs
- New keyword-use-mcp.md: Complete docs for USE MCP keyword and mcp.csv
- Updated sources.md: MCP Servers section with mcp.csv configuration
- CSV format examples and connection type documentation
- Authentication configuration (api_key, bearer)
- Integration with Tasks and BASIC examples
2025-12-13 00:27:17 -03:00
89eef18cf6 Rename Auto Tasks to Tasks, fix SVG with proper PROMPT.md guidelines 2025-12-12 23:34:30 -03:00
d1dec9fe29 Lowercase botserver/botbook references, add bottemplates repo, update autonomous tasks docs 2025-12-12 23:18:36 -03:00
7de665d2c8 Redesign humanoid guide: event-driven architecture, robot-as-server concept
- Replace loops with ON events (ON CV, ON HEAR, ON IMU, ON BATTERY)
- Tools with PARAM DESCRIPTION for LLM integration
- Explain why robots need LLM orchestrator like GB
- Robot runs full stack: botserver, llama.cpp, botmodels, even email
- Same .gbai packages work on humanoids
- Add practical comparison table: traditional vs GB-powered
- Event handlers for person/cat/gesture detection
- Complete reception robot example with package structure
- Offline operation with local LLM models
2025-12-12 21:00:44 -03:00
43f66ff1e6 Add humanoid.md to SUMMARY.md 2025-12-12 20:45:06 -03:00
91a6710c52 Add humanoid robotics guide, SVG diagrams, and NO ASCII rule
- Add comprehensive humanoid robotics guide (humanoid.md) with:
  - Supported robot kits (Unitree, UBTECH, Poppy, InMoov, ROBOTIS)
  - BASIC keywords for servo/movement control
  - Computer vision integration (face, object, gesture detection)
  - LLM-driven conversational movement
  - Build guides for beginner to advanced
  - Safety considerations and complete reception robot example

- Create humanoid-architecture.svg with theme transparency

- Update PROMPT.md with NO ASCII DIAGRAMS rule

- Update devices README to include humanoid robotics section

- SVG diagrams for chapter 13 devices

- Update documentation style guide with theme transparency
2025-12-12 20:36:34 -03:00
0f803a2c7f docs: Add GOTO keyword documentation with migration guidance to ON patterns 2025-12-12 16:26:58 -03:00
aec5ca5883 fix: Restore README.md content that was accidentally deleted 2025-12-12 16:26:52 -03:00
27e26daccf Add hardware ↔ keyword compatibility table to GPIO documentation
- Added comprehensive table mapping hardware components to BASIC keywords
- Includes displays, sensors, actuators, ADC/DAC, expansion modules
- Shows interface type (I2C, SPI, GPIO) and typical addresses
- Added quick reference table by keyword
2025-12-12 14:29:45 -03:00
42f97de134 Add GPIO keywords, buying guide, embedded templates, and update to BotDevice
- Add GPIO & IoT Keywords documentation (keywords-gpio.md)
  - GPIO MODE, SET, GET, PWM, SERVO
  - I2C SCAN, READ, WRITE
  - SPI OPEN, TRANSFER, CLOSE
  - Sensor keywords: READ TEMPERATURE, HUMIDITY, DISTANCE, MOTION, LIGHT
  - Display keywords: LCD INIT/PRINT/CLEAR, OLED INIT/PRINT/DRAW/CLEAR
  - Relay and buzzer control
  - Complete examples: doorbell, thermostat, light automation

- Add Beginner's Buying Guide (13-devices/buying-guide.md)
  - What is an SBC explained for beginners
  - Recommended starter kits by budget
  - Sample shopping lists for projects
  - Where to buy by region
  - First-time setup guide
  - Common beginner mistakes

- Add Embedded Device Templates (02-templates/template-embedded.md)
  - thermostat.bas - Smart thermostat with AI
  - doorbell.bas - Smart doorbell with notifications
  - light-control.bas - Voice-controlled lights
  - security.bas - Motion alarm system
  - plant-monitor.bas - Automatic plant watering
  - kiosk.bas - Information display

- Add SVG architecture diagram (embedded-architecture.svg)

- Update mobile.md to use BotDevice branding (renamed from BotOS)

- Update SUMMARY.md with new sections
2025-12-12 14:14:53 -03:00
d3bc28fac6 Add Chapter 13: Device & Offline Deployment documentation
- Add mobile deployment guide for Android & HarmonyOS (BotOS)
- Add hardware guide for SBCs (Raspberry Pi, Orange Pi, etc.)
- Add quick start guide for 5-minute deployment
- Add local LLM guide with llama.cpp for offline AI
- Update SUMMARY.md to place chapter after Security (Part XII)
- Include bloatware removal, Magisk module, GSI instructions
- Cover NPU acceleration on Orange Pi 5 with rkllm
2025-12-12 14:00:38 -03:00
ff5d2ac12c Add Chapter 20: Embedded & Offline Deployment - Complete guide for Raspberry Pi, Orange Pi with local LLM 2025-12-12 13:51:39 -03:00
3fdeeedf73 docs: Update user docs - Tasks, Apps index, API Possibilities
- tasks.md: Simplified for end users (no code, no HTMX)
- README.md (apps): Clean user-friendly app guide
- api-possibilities.md: New chapter for bot builders with API integration examples
- SUMMARY.md: Added API Possibilities link
2025-12-12 12:34:56 -03:00
b6563ba39e Update SMS documentation with priority support 6.1.0
- Add priority parameter (low, normal, high, urgent) to SEND SMS keyword
- Document priority behavior for each provider (Twilio, AWS SNS, Vonage, MessageBird)
- Add sms-default-priority configuration option
- Update examples with priority-based routing
- Fix configuration parameter names to match implementation
2025-12-10 18:22:37 -03:00
be661f7cf2 Add Chapter 19: Maintenance and Updates documentation
- Create maintenance chapter with component update guides
- Add updating-components.md with step-by-step procedures for all stack components
- Add component-reference.md with versions, URLs, checksums, and alternatives for each service
- Add security-auditing.md with cargo audit, CVE monitoring, Trivy/Grype scanning
- Add backup-recovery.md with full backup/restore procedures
- Add troubleshooting.md for common issues and solutions
- Update SUMMARY.md with new chapter entry
2025-12-10 12:55:05 -03:00
ebe7e19ab7 docs: add local domains configuration guide
- Add new section 'Configuring Local Development Access' after Quick Start
- Document IP-based access as default (zero configuration)
- Document optional hostname access via hosts file or CoreDNS
- Use standardized component names: tables, drive, cache, vectordb
- Include code examples for Python, Node.js, and Rust mTLS
- Add troubleshooting and certificate trust instructions
2025-12-07 10:41:22 -03:00
7123f881c6 docs: Update SUMMARY and add cargo-tools documentation 2025-12-07 09:57:27 -03:00
b54d8e84dd docs: update UI documentation and add testing chapters
- Update suite.md and ui-structure.md
- Add testing best-practices, ci-cd, and performance docs
2025-12-07 02:14:20 -03:00
de8282f0a2 Add testing chapter (17) to botbook
- Created src/17-testing/ chapter with complete testing documentation
- Added README.md - testing overview and structure
- Added e2e-testing.md - comprehensive E2E testing guide (447 lines)
- Added architecture.md - testing architecture and patterns (410 lines)
- Updated SUMMARY.md to include Part XIV - Testing
- All E2E testing documentation now centralized in botbook
- Developers refer to botbook and test PROMPT.md, not scattered files
2025-12-06 11:25:37 -03:00
c26fb1e3a2 Update: General project updates 2025-12-06 11:09:12 -03:00
e5fd4bd3fc docs: Update model names to latest (GPT-5, Claude 4.5, DeepSeek-R3)
- Update all model references across 14+ documentation files
- GPT-4.1 → GPT-5, GPT-5 mini
- Claude Sonnet/Opus → Claude Sonnet 4.5, Claude Opus 4.5
- DeepSeek-R1 → DeepSeek-R3
- Add Template: Attendance CRM to SUMMARY.md
- Update attendant.csv docs with multi-channel columns
- Update TASKS.md with completed model updates
2025-12-05 14:54:59 -03:00
80f1041263 docs: Add LLM-assisted attendant documentation
New Documentation:
- chapter-11-features/attendant-llm-assist.md - Full guide for AI copilot features
- chapter-11-features/transfer-to-human.md - Human handoff and needs_human flag

Updated Documentation:
- executive-vision.md - Added investor highlights, competitive advantages, LLM assist overview
- SUMMARY.md - Added new chapters
- appendix-external-services/README.md - Added CRM/attendant config options
- appendix-external-services/llm-providers.md - Updated model names to current/generic
- chapter-02/gbai.md - Updated model name examples

Features Documented:
- needs_human flag and how it routes messages
- WhatsApp attendant commands (/queue, /tips, /polish, etc.)
- All 5 LLM assist features with config.csv options
- Analytics and insights APIs
- Troubleshooting guide
2025-12-05 13:50:28 -03:00
c4d209352d docs: comprehensive keyword documentation update
Completed stub files:
- keyword-soap.md - SOAP web service integration
- keyword-merge-pdf.md - PDF merging (MERGE PDF with spaces)
- keyword-kb-statistics.md - KB statistics overview
- keyword-kb-collection-stats.md - Per-collection stats
- keyword-kb-documents-count.md - Document counting
- keyword-kb-documents-added-since.md - Recent document tracking
- keyword-kb-list-collections.md - Collection listing
- keyword-kb-storage-size.md - Storage monitoring

Updated documentation:
- keyword-generate-pdf.md - Updated to GENERATE PDF (spaces)
- keyword-delete.md - Rewritten for unified DELETE
- keyword-delete-http.md - Redirects to unified DELETE
- keyword-delete-file.md - Redirects to unified DELETE
- All keyword docs updated to use spaces not underscores

PROMPT.md updates:
- Added keyword naming rules (NO underscores)
- Added keyword mapping table
- Added quick reference for all keywords
- Added error handling examples

TASKS.md created:
- Comprehensive discrepancy report
- Model name update tracking (17 files)
- Config parameter documentation
- Architecture notes

Key clarifications:
- GENERATE FROM TEMPLATE = FILL keyword
- GENERATE WITH PROMPT = LLM keyword
- ON ERROR RESUME NEXT now implemented
- DELETE is unified (HTTP/DB/File auto-detect)
2025-12-05 09:55:38 -03:00
49eb6696ea Reorganize chapters and add admin/user views documentation
Chapter renames:
- chapter-09-api -> chapter-09-tools (LLM Tools)
- chapter-10-api -> chapter-10-rest (REST Endpoints)

New documentation:
- chapter-04-gbui/admin-user-views.md: Complete guide to User vs Admin interfaces
  - User Settings (/api/user/*): profile, security, notifications, storage
  - Admin Panel (/api/admin/*): users, groups, bots, DNS, audit
  - Permission levels: guest, user, manager, admin
  - Desktop sync considerations

Updated:
- Drive app docs with sync feature (rclone, desktop-only)
- All cross-references to renamed chapters
- SUMMARY.md with new structure and admin-user-views entry
2025-12-05 06:50:56 -03:00
fde61592ab docs: add email-read-pixel parameter and tracking API documentation
- Document email-read-pixel in parameters.md
- Add Email Read Tracking section to email-api.md
- Include all 4 tracking endpoints with examples
- Add database schema for sent_email_tracking
- Include privacy considerations (GDPR/LGPD)
2025-12-04 18:15:18 -03:00
4328bec2f9 Add PROMPT.md 2025-12-04 12:30:06 -03:00
bb9a3afa2e Restore original README.md 2025-12-04 09:56:15 -03:00
070d08d9f5 Add main README for General Bots organization
Complete overview of the platform architecture:
- Repository descriptions and links
- Architecture diagram
- Quick start guide
- Feature highlights
- Development setup
- Documentation links
2025-12-04 09:53:35 -03:00
2110995b7f Refactor: CRM automations, monitoring homepage, webhook examples, docs standards
- Environment Variables: Simplified to ONLY VAULT_* vars, everything else in config.csv
- Attendant Module: Added CRM automations (follow-ups, collections/cobranças, scheduling/agendamentos, sales/vendas)
- NEW: Hosting, DNS, MDA integration docs (Namecheap, Stalwart, LLM providers)
- Monitoring: Updated as live operations homepage with real data endpoints
- Examples: Renamed to 'Webhook Integrations and Jobs', removed loop-based examples 1 & 5, added lead nurturing, payment collection, appointment scheduling
- Documentation Standards: WhatsApp HTML style as canonical conversation format, SVG for interfaces
- Reading Flow: Improved Executive Vision → Quick Start → Chapter 01 transitions with navigation tables
2025-12-03 21:59:49 -03:00
292d6625b7 - Split from botserver. 2025-12-03 19:56:35 -03:00
ce0ed49700 new(all): New web params in gbot. 2024-11-30 11:57:52 -03:00
0cfc297068
Update chapter-06-gbapp-reference.md 2024-09-24 14:13:17 -03:00
Rodrigo Rodriguez
befc237dd4 Updated. 2024-09-18 18:45:31 -03:00
Rodrigo Rodriguez
f22e24349f Updated. 2024-09-13 16:13:22 -03:00
Rodrigo Rodriguez
31a1704db4 Updated. 2024-09-12 16:14:48 -03:00
Rodrigo Rodriguez
1b5eddf6ec Updated. 2024-09-09 17:05:42 -03:00
Rodrigo Rodriguez
ce2aa1e89c Updated. 2024-09-09 16:59:49 -03:00
Rodrigo Rodriguez
07efbabfa3 Updated. 2024-09-05 14:32:11 -03:00
Rodrigo Rodriguez
7616ab9718 Updated. 2024-09-05 01:24:58 -03:00
Rodrigo Rodriguez
b53aeb38c7 Updated. 2024-09-04 23:31:18 -03:00