151 lines
No EOL
5.8 KiB
Markdown
151 lines
No EOL
5.8 KiB
Markdown
# Documentation Fixes Summary
|
|
|
|
## Date: 2024
|
|
|
|
This document summarizes all the fixes made to the BotServer documentation as per the requested changes.
|
|
|
|
## 1. Diagram Height Fix (Chapter 6.1)
|
|
|
|
**File:** `docs/src/chapter-06-gbdialog/assets/basic-execution-flow.svg`
|
|
- Fixed SVG height from 600px to 500px
|
|
- Adjusted all internal elements proportionally to fit the new height
|
|
- Maintained readability and visual hierarchy
|
|
|
|
## 2. Removed Non-Existent Keywords and Constructs
|
|
|
|
### TRY/CATCH Blocks Removed
|
|
**Files affected:**
|
|
- `docs/src/chapter-06-gbdialog/keyword-send-mail.md`
|
|
- `docs/src/chapter-10-features/email.md`
|
|
|
|
**Changes:**
|
|
- Removed all TRY/CATCH/END TRY blocks
|
|
- Replaced with proper IF/THEN/ELSE error handling
|
|
- Example:
|
|
```basic
|
|
' OLD (INCORRECT):
|
|
TRY
|
|
SEND MAIL recipient, subject, body
|
|
CATCH "error"
|
|
TALK "Error occurred"
|
|
END TRY
|
|
|
|
' NEW (CORRECT):
|
|
status = SEND MAIL recipient, subject, body
|
|
IF status = "sent" THEN
|
|
TALK "Email sent successfully"
|
|
ELSE
|
|
TALK "Failed to send email: " + status
|
|
END IF
|
|
```
|
|
|
|
### FUNCTION/END FUNCTION Removed
|
|
**File:** `docs/src/chapter-06-gbdialog/keyword-send-mail.md`
|
|
- Removed FUNCTION/END FUNCTION declarations
|
|
- Replaced with inline logic using IF/THEN/ELSE
|
|
|
|
### VALIDATE_EMAIL Removed
|
|
**File:** `docs/src/chapter-06-gbdialog/keyword-send-mail.md`
|
|
- Removed references to non-existent VALIDATE_EMAIL keyword
|
|
- Replaced with manual email validation using CONTAINS and SPLIT
|
|
|
|
### ON ERROR Removed
|
|
**File:** `docs/src/chapter-06-gbdialog/keyword-send-mail.md`
|
|
- Removed ON ERROR/END ON blocks
|
|
- Replaced with standard IF/THEN error checking
|
|
|
|
### ATTACH_FILE Removed
|
|
**File:** `docs/src/chapter-06-gbdialog/keyword-create-task.md`
|
|
- Removed references to non-existent ATTACH_FILE keyword
|
|
- Added comment to use document sharing systems instead
|
|
|
|
## 3. Fixed Keyword Formatting (Removed Underscores)
|
|
|
|
### Keywords Changed from WORD_WORD to WORD WORD Format:
|
|
|
|
| Old Format | New Format | Files Affected |
|
|
|------------|------------|----------------|
|
|
| `CREATE_SITE` | `CREATE SITE` | keyword-create-site.md, chapter-09-api/README.md |
|
|
| `CREATE_TASK` | `CREATE TASK` | keyword-create-task.md, email.md |
|
|
| `CREATE_DRAFT` | `CREATE DRAFT` | keyword-create-draft.md |
|
|
| `SET_SCHEDULE` | `SET SCHEDULE` | Multiple files including keyword-set-schedule.md, automation.md, template-summary.md |
|
|
| `SEND_MAIL` | `SEND MAIL` | keyword-send-mail.md, email.md, email-api.md |
|
|
| `USE_KB` | `USE KB` | Multiple files including README.md, kb-and-tools.md, knowledge-base.md |
|
|
| `CLEAR_KB` | `CLEAR KB` | Multiple files including README.md, kb-and-tools.md |
|
|
| `SET_KB` | `SET KB` | chapter-09-api/README.md, docs-summary.md |
|
|
| `ADD_WEBSITE` | `ADD WEBSITE` | keyword-add-website.md, summary.md, README.md |
|
|
| `USE_TOOL` | `USE TOOL` | Multiple files including README.md, tool-definition.md |
|
|
| `CLEAR_TOOLS` | `CLEAR TOOLS` | keyword-clear-tools.md, README.md, kb-and-tools.md |
|
|
| `REMOVE_TOOL` | `REMOVE TOOL` | tool-definition.md, chapter-09-api/README.md |
|
|
| `LIST_TOOLS` | `LIST TOOLS` | tool-definition.md, chapter-09-api/README.md |
|
|
| `ADD_MEMBER` | `ADD MEMBER` | keyword-create-task.md |
|
|
|
|
## 4. Removed Timezone Support from SET SCHEDULE
|
|
|
|
**File:** `docs/src/chapter-06-gbdialog/keyword-set-schedule.md`
|
|
- Removed the "Time Zone Support" section
|
|
- Removed TIMEZONE parameter documentation
|
|
- Updated to indicate that server's local time is used
|
|
|
|
## 5. Files Modified (Summary)
|
|
|
|
### Documentation Root
|
|
- `botserver/README.md`
|
|
|
|
### Chapter 6 - gbdialog
|
|
- `docs/src/chapter-06-gbdialog/assets/basic-execution-flow.svg`
|
|
- `docs/src/chapter-06-gbdialog/keyword-create-site.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-create-task.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-send-mail.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-set-schedule.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-add-website.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-clear-tools.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-create-draft.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-set-context.md`
|
|
- `docs/src/chapter-06-gbdialog/keyword-wait.md`
|
|
- `docs/src/chapter-06-gbdialog/template-summary.md`
|
|
|
|
### Chapter 3 - Knowledge Base
|
|
- `docs/src/chapter-03/kb-and-tools.md`
|
|
- `docs/src/chapter-03/summary.md`
|
|
|
|
### Chapter 7 - gbapp
|
|
- `docs/src/chapter-07-gbapp/custom-keywords.md`
|
|
|
|
### Chapter 9 - API
|
|
- `docs/src/chapter-09-api/README.md`
|
|
- `docs/src/chapter-09-api/compilation.md`
|
|
- `docs/src/chapter-09-api/tool-definition.md`
|
|
|
|
### Chapter 10 - Features
|
|
- `docs/src/chapter-10-features/README.md`
|
|
- `docs/src/chapter-10-features/automation.md`
|
|
- `docs/src/chapter-10-features/email.md`
|
|
- `docs/src/chapter-10-features/core-features.md`
|
|
- `docs/src/chapter-10-features/knowledge-base.md`
|
|
|
|
### Chapter 13 - API
|
|
- `docs/src/chapter-13-api/email-api.md`
|
|
|
|
### Prompts
|
|
- `prompts/dev/docs/docs-summary.md`
|
|
|
|
## 6. Validation Notes
|
|
|
|
All changes maintain backward compatibility at the documentation level while accurately reflecting the actual BotServer implementation. The keyword format changes (removing underscores) make the BASIC dialect more natural and readable, following English-like syntax patterns.
|
|
|
|
## 7. Recommendations for Future Updates
|
|
|
|
1. **Consistency Check**: Ensure all new documentation follows the WORD WORD format for multi-word keywords
|
|
2. **Error Handling**: Use IF/THEN/ELSE patterns for error handling, not TRY/CATCH
|
|
3. **Validation**: Use manual validation logic rather than non-existent validation keywords
|
|
4. **Scheduling**: Document that SET SCHEDULE uses server local time only
|
|
|
|
## 8. Impact Assessment
|
|
|
|
- **Breaking Changes**: None at the code level (documentation only)
|
|
- **User Impact**: Improved accuracy and clarity in documentation
|
|
- **Developer Impact**: Clear guidance on actual available keywords and constructs
|
|
- **Learning Curve**: Simplified by removing non-existent features
|
|
|
|
This completes the documentation fixes as requested. |