Skip to content

docs: enhance case studies page with helper text and setup guide#818

Merged
ncrispino merged 4 commits intodev/v0.1.44from
case-studies-ux-improvements
Jan 28, 2026
Merged

docs: enhance case studies page with helper text and setup guide#818
ncrispino merged 4 commits intodev/v0.1.44from
case-studies-ux-improvements

Conversation

@franklinnwren
Copy link
Collaborator

@franklinnwren franklinnwren commented Jan 28, 2026

Description

  • Add helper text prompting users to compare MassGen with single-agent baselines
  • Add 'Try it yourself' section with:
    • Link to video tutorials setup guide for first-time users
    • Quick start command (uv run massgen --web)
    • Model selection guidance (Claude 4.5 Opus, Gemini 3 Pro, GPT 5.2)
    • Terminal config file example for CLI users
  • Move Video Tutorials section higher in index.rst (after Quick Start for better discoverability)
  • Create terminal_config.txt with example YAML configuration for reproducing the case study

Motivation

Users visiting the case studies page need clear guidance on:

  1. How to interpret the comparisons (helper text added)
  2. How to reproduce the results themselves (setup guide added)
  3. Where to get started if they're new (video tutorial links)

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

  • Bug fix (fix:) - Non-breaking change which fixes an issue
  • New feature (feat:) - Non-breaking change which adds functionality
  • Breaking change (breaking:) - Fix or feature that would cause existing functionality to not work as expected
  • Documentation (docs:) - Documentation updates
  • Code refactoring (refactor:) - Code changes that neither fix a bug nor add a feature
  • Tests (test:) - Adding missing tests or correcting existing tests
  • Chore (chore:) - Maintenance tasks, dependency updates, etc.
  • Performance improvement (perf:) - Code changes that improve performance
  • Code style (style:) - Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc.)
  • CI/CD (ci:) - Changes to CI/CD configuration files and scripts

Checklist

  • I have run pre-commit on my changed files and all checks pass
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Added two interactive "Try it yourself" collapsible sections (setup guide, run command, quick-start models, terminal-config link) placed in two locations to surface the call-to-action.
    • Added a contextual note inviting comparison with single-agent baselines.
    • Added a standalone terminal/configuration example for quick-start reference.
    • Introduced a Video Tutorials section (removed a later duplicate) and updated embedded tutorial links.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

Warning

Rate limit exceeded

@franklinnwren has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📝 Walkthrough

Walkthrough

Added 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

Cohort / File(s) Summary
Case Studies page
docs/source/case_studies/index.html
Inserted two collapsible "Try it yourself" CTA sections (header, collapsible content, setup guide link, run command, quick-start models, terminal config link). Placed after MassGen Answer visualization and after Iterative Refinement/Agent C group.
Terminal config doc
docs/source/case_studies/terminal_config.txt
Added new file with a massgen_config.yaml example defining three agents (agent_a, agent_b, agent_c), orchestrator settings (storage, workspaces, timeouts, multimodal tools, coordination), UI note, and a run hint.
Homepage / Video Tutorials
docs/source/index.rst
Added a Video Tutorials section after Quick Start with two centered links and descriptions; removed the duplicate Video Tutorials block that was under Supported Models.
README video links
README.md, README_PYPI.md
Updated YouTube link from https://www.youtube.com/watch?v=Dp2oldJJImw to https://www.youtube.com/watch?v=5JofXWf_Ok8 in both files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • sonichi
  • ncrispino
  • Henry-811
🚥 Pre-merge checks | ✅ 4 | ❌ 2
❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Documentation Updated ⚠️ Warning PR modifies README.md and README_PYPI.md on feature branch targeting main, violating policy requiring these files to be updated only in release PRs. Remove README.md and README_PYPI.md changes from this PR or defer to a release PR using a dev/v0.1.X branch.
Capabilities Registry Check ⚠️ Warning Backend and model changes present in PR contradict PR description's claim of no backend code changes; 9 new models lack pricing entries in token_manager.py. Add ModelPricing entries to token_manager.py for all 9 missing models and update PR description to reflect backend modifications.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: enhancing the case studies page with helper text and a setup guide, which aligns with the primary focus of adding helper text, 'Try it yourself' section, and moving the Video Tutorials section.
Description check ✅ Passed The description follows the required template structure, includes all essential sections (Description, Motivation, Type of change, and Checklist), and provides clear details about the documentation changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Config Parameter Sync ✅ Passed PR is a documentation-only change adding terminal_config.txt example. All YAML parameters already exist in codebase and are properly listed in required exclusion functions.

✏️ 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@franklinnwren franklinnwren changed the title Enhance case studies page with helper text and setup guide docs: enhance case studies page with helper text and setup guide Jan 28, 2026
- 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.
@franklinnwren franklinnwren force-pushed the case-studies-ux-improvements branch from 398a173 to 5a80ef3 Compare January 28, 2026 06:40
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ncrispino ncrispino changed the base branch from main to dev/v0.1.44 January 28, 2026 15:45
@ncrispino ncrispino merged commit c5bf10d into dev/v0.1.44 Jan 28, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants