Organize the Puzzletron documentation journey - #2354
Conversation
Signed-off-by: Johannes Rausch <jrausch@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughPuzzletron documentation now uses task-based routes for resumable pruning workflows. The guides clarify resume requirements, checkpoint evaluation, VLM customization, dry-run validation, and setup wizard selections. ChangesPuzzletron documentation workflow
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This update reorganizes Puzzletron guidance for task-based, resumable workflows without changing runtime behavior. No current merge-blocking risk is identified. 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## jrausch/puzzletron-clean-checkout-first-run-acceptance-v2 #2354 +/- ##
=============================================================================================
- Coverage 62.25% 62.25% -0.01%
=============================================================================================
Files 713 713
Lines 93993 93993
=============================================================================================
- Hits 58515 58511 -4
- Misses 35478 35482 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
What does this PR do?
Type of change: documentation.
Puzzletron's detailed guides did not provide a clear route from the maintained lifecycle smoke to model-specific campaigns, setup, evaluation, results, configuration, and recovery. The main README now keeps the smoke-first journey and adds a shallow task map so readers can reach the authoritative guide without choosing between competing instructions.
Testing
Checked links, anchors, and root navigation coverage across all Puzzletron Markdown guides. The edited files pass repository hooks and Markdown lint. Relevant CLI entry points load, the text smoke, VLM smoke, and VLM campaign compile in dry-run mode without submitting jobs, and the three focused plan-compilation tests pass. No scheduler or GPU jobs were run.
Before your PR is ready for review
Summary by CodeRabbit