Added usage documentation#29
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughA new documentation file was added to provide user guidance on running the project. The "Usage Guide" includes a "Running the Project" section with instructions for executing three Python module commands related to baseline generation, regression testing, and benchmarking. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
| ```bash | ||
| python -m chuck generate-baselines | ||
| python -m chuck regress | ||
| python -m chuck bench |
There was a problem hiding this comment.
the doc is just too short for a user to understand anything
| Run the following commands: | ||
|
|
||
| ```bash | ||
| python -m chuck generate-baselines |
There was a problem hiding this comment.
Please add demo screenshots of your changes too
|
Please add Fixes #Issue-Number in your PR description to link the issue to the PR. |
Summary by CodeRabbit