docs: Document Windows terminal encoding support & troubleshooting#249
docs: Document Windows terminal encoding support & troubleshooting#249MervinPraison wants to merge 1 commit intomainfrom
Conversation
…ixes #244) - Add Windows encoding note to installation.mdx Windows tab - Create comprehensive troubleshooting guide in docs/features/windows-terminal-encoding.mdx - Include Mermaid decision diagram with AGENTS.md color scheme - Cover automatic mitigation, manual UTF-8 setup, and best practices - Register new page in docs.json under Features > Advanced Features 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 2 minutes and 27 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ 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 introduces documentation for Windows Terminal Encoding, detailing how PraisonAI handles legacy code pages and providing setup instructions for UTF-8. The review feedback suggests replacing version placeholders with specific version numbers, correcting language labels in code blocks where CMD syntax was labeled as bash, and addressing invalid comments in JSON examples to ensure compatibility with documentation tools.
|
|
||
| <Steps> | ||
| <Step title="Automatic Handling"> | ||
| PraisonAI ≥ v0.0.x automatically detects legacy Windows code pages and renders ASCII-safe output: |
There was a problem hiding this comment.
The version placeholder v0.0.x should be replaced with the specific version where automatic encoding detection was introduced to provide accurate guidance to users.
| ```bash | ||
| # Temporary fix | ||
| set PYTHONIOENCODING=utf-8 | ||
| praisonai --help | ||
|
|
||
| # Or upgrade to latest version | ||
| pip install --upgrade praisonai | ||
| ``` |
There was a problem hiding this comment.
The code block is labeled as bash, but it contains Windows CMD syntax (set) and shell-style comments (#). For clarity and correctness in a Windows-focused guide, the label should be changed to cmd and the comments should use REM or ::.
| ```json | ||
| // Windows Terminal settings.json | ||
| { | ||
| "profiles": { | ||
| "defaults": { | ||
| "font": { | ||
| "face": "Cascadia Code" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
The JSON code block contains a comment (//), which is not valid in standard JSON. While Windows Terminal's settings.json supports JSONC (JSON with Comments), some documentation tools or strict parsers might fail. It is recommended to remove the comment from the block or use the jsonc language identifier if supported by the documentation framework.
Fixes #244
This PR adds comprehensive documentation for Windows terminal encoding support and troubleshooting, addressing the automatic UnicodeEncodeError fixes from PraisonAI PR #1545.
Changes
Updated docs/installation.mdx
Created docs/features/windows-terminal-encoding.mdx
Updated docs.json
Acceptance Criteria Met
✅ docs/installation.mdx Windows tab includes encoding note
✅ Comprehensive troubleshooting page with Mermaid diagram
✅ Page registered in Features group (not Concepts)
✅ docs.json is valid JSON
✅ Searchable for UnicodeEncodeError/PYTHONIOENCODING
✅ Follows AGENTS.md style guidelines
Generated with Claude Code