docs: enhance case studies page with helper text and setup guide#818
docs: enhance case studies page with helper text and setup guide#818ncrispino merged 4 commits intodev/v0.1.44from
Conversation
|
Warning Rate limit exceeded
⌛ 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. 📝 WalkthroughWalkthroughAdded two "Try it yourself" collapsible CTA sections to the case studies page, added a terminal configuration doc with a MassGen YAML snippet, moved/updated the Video Tutorials block on the homepage, and updated two README video links. All edits are static documentation changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
- Add helper text prompting users to compare with single-agent baselines - Add 'Try it yourself' section with setup instructions and quick start guide - Move Video Tutorials section higher in index.rst (after Quick Start) - Create terminal_config.txt with example configuration for case study - Link to video tutorials setup guide for first-time users Note: These improvements enhance user experience and make it easier to reproduce the case study results. Performance comparisons are based on current API behavior and may vary if backend APIs change over time.
398a173 to
5a80ef3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/source/case_studies/index.html`:
- Around line 401-415: Update the yellow note paragraph that begins with
"<strong>Note:</strong>" to explicitly anchor the statement with the date "as of
January 2026" (e.g., change "Performance might differ if there is any change in
API backends over time." to include "as of January 2026" or similar wording).
Locate the <p> element containing the note in the case studies section (the
paragraph with background `#fff3cd` and border-left `#ffc107`) and edit its text to
mention "as of January 2026" so the comparison timeframe is clear.
Description
uv run massgen --web)terminal_config.txtwith example YAML configuration for reproducing the case studyMotivation
Users visiting the case studies page need clear guidance on:
Note
Performance comparisons shown are based on current API behavior as of January 2026. Results may vary if backend APIs change over time. This PR includes only documentation changes - no backend code modifications.
Type of change
fix:) - Non-breaking change which fixes an issuefeat:) - Non-breaking change which adds functionalitybreaking:) - Fix or feature that would cause existing functionality to not work as expecteddocs:) - Documentation updatesrefactor:) - Code changes that neither fix a bug nor add a featuretest:) - Adding missing tests or correcting existing testschore:) - Maintenance tasks, dependency updates, etc.perf:) - Code changes that improve performancestyle:) - Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc.)ci:) - Changes to CI/CD configuration files and scriptsChecklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.