docs: improve beginner onboarding and native windows support (#4008) #4211
+257
−87
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…4008) - Adds quickstart.ps1 for native Windows setup - Exposes --mock flag in CLI for no-API-key exploration - Improves README and CONTRIBUTING with Windows-specific troubleshooting - Enhances MockLLMProvider to prevent stalling and simulate set_output
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solve Issue #4008: Improve Beginner Onboarding & Windows Native Support
This contribution addresses friction for new Windows developers and improves the "First 5 Minutes" experience.
✨ Added quickstart.ps1: A native PowerShell equivalent to the Bash quickstart, enabling seamless setup on Windows.
🛠️ Exposed --mock in CLI: Allows developers to explore the Agent TUI and graph logic without needing API keys.
📄 README & CONTRIBUTING updates: Clarified Windows setup paths and added a "uv not found" troubleshooting FAQ.
🐛 MockLLMProvider Fix: Added a call counter and simulated
set_output
calls to prevent graph stalling in Mock Mode.
cd core && pytest tests/)cd core && ruff check .)Checklist
Screenshots (if applicable)
Add screenshots to demonstrate UI changes.