docs: update Televiz getting-started page#711
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughUpdated the Televiz getting-started examples to use consistent configuration variable names. The offscreen quick start snippet now uses Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/source/getting_started/televiz.rst`:
- Around line 299-304: The Televiz XR example references an undefined trackers
name when calling DeviceIOSession.get_required_extensions, so the snippet is not
runnable as written. Update the example around VizSession.create and
get_required_extensions to either define the tracker list in the snippet or use
the concrete trackers collection already established earlier in the guide,
keeping the example self-contained and consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ec387c2c-7093-469a-9ef9-a180d5a7d520
📒 Files selected for processing (1)
docs/source/getting_started/televiz.rst
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
I'm going to squash and merge this now since Farbod has some incoming changes and I wanted to make his merge easier. If I have further changes I'll start a new feature branch. |
Description
Small changes to the documentation after the first time user point of view.
Type of change
Testing
Built with the established make command, "make current-docs".
Checklist
SKIP=check-copyright-year pre-commit run --all-filesgit commit -s) per the DCOSummary by CodeRabbit