docs: Document Gateway Telegram Unicode-safe error handling (PR #1754)#453
docs: Document Gateway Telegram Unicode-safe error handling (PR #1754)#453MervinPraison wants to merge 1 commit into
Conversation
- Add Windows charmap error troubleshooting section to gateway troubleshooting guide - Add Unicode-safe error handling notes to bot gateway documentation - Update Telegram tool documentation with new user-facing error messages - Create comprehensive gateway error handling feature page following AGENTS.md standards - Include Mermaid diagrams, proper component usage, and agent-centric examples - Update docs.json to include new page in Integration & Infrastructure section 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
|
Warning Review limit reached
More reviews will be available in 42 minutes and 31 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for Gateway Error Handling, introducing Unicode-safe error handling for Gateway bot replies to prevent encoding crashes (such as 'charmap' codec errors on Windows). It includes a new feature guide, troubleshooting steps, and updates to the Telegram tool documentation. Feedback on the documentation includes enclosing Mermaid flowchart node labels with emojis/spaces in double quotes to prevent parsing errors, and correcting the smart quotes table row to use actual curly smart quotes instead of straight double quotes.
| Exception[⚠️ Exception] --> Extract[🔍 Extract Root Cause] | ||
| Extract --> Sanitize[🔧 Sanitize to ASCII] | ||
| Sanitize --> Reply[💬 User Reply] | ||
| Exception --> Log[📝 Full Unicode Log] |
There was a problem hiding this comment.
In Mermaid flowcharts, node labels containing special characters (such as emojis like ⚠️, 🔍, 🔧, 💬, 📝) and spaces should be enclosed in double quotes (e.g., Node["text"]) to prevent rendering or parsing errors across different Markdown parsers.
Exception["⚠️ Exception"] --> Extract["🔍 Extract Root Cause"]
Extract --> Sanitize["🔧 Sanitize to ASCII"]
Sanitize --> Reply["💬 User Reply"]
Exception --> Log["📝 Full Unicode Log"]
| | `✗` | `X` | Cross mark | | ||
| | `→` | `->` | Right arrow | | ||
| | `…` | `...` | Ellipsis | | ||
| | `"` `"` | `"` | Smart quotes | |
There was a problem hiding this comment.
The table row for smart quotes uses straight double quotes (") in the Unicode column instead of actual curly smart quotes (“ and ”). This defeats the purpose of demonstrating the replacement of smart quotes with straight quotes.
| `“` `”` | `"` | Smart quotes |
Fixes #446
Summary
Documents the Gateway Telegram Unicode-safe error handling feature from PraisonAI PR #1754, which fixed Windows charmap crashes when error messages contained Unicode characters.
Changes Made
Documentation Standards Compliance
✅ Follows AGENTS.md template structure
✅ Uses required Mintlify components (Steps, AccordionGroup, CardGroup)
✅ Includes hero Mermaid diagram with standard colors (#8B0000, #189AB4, #10B981, #F59E0B, #6366F1)
✅ Agent-centric code examples with correct imports
✅ Copy-paste runnable code blocks
✅ Concise writing style with one-sentence section intros
✅ Cross-links between related documentation pages
Test Plan
🤖 Generated with Claude Code