Skip to content

docs: update Televiz getting-started page#711

Open
jsepulveda-nvidia wants to merge 1 commit into
mainfrom
jsepulveda/docmods
Open

docs: update Televiz getting-started page#711
jsepulveda-nvidia wants to merge 1 commit into
mainfrom
jsepulveda/docmods

Conversation

@jsepulveda-nvidia

@jsepulveda-nvidia jsepulveda-nvidia commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Description

Small changes to the documentation after the first time user point of view.

Type of change

  • Documentation update

Testing

Built with the established make command, "make current-docs".

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

  • Documentation
    • Updated Televiz getting-started examples for clearer, more consistent session configuration naming.
    • Refined the quick-start and XR-sharing snippets without changing the setup steps or behavior.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated the Televiz getting-started examples to use consistent configuration variable names. The offscreen quick start snippet now uses viz_cfg, and the XR session sharing example now uses viz_cfg for VizSessionConfig and tlop_cfg for TeleopSessionConfig, while keeping the same session wiring.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the documentation update to the Televiz getting-started page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jsepulveda/docmods

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

@jsepulveda-nvidia jsepulveda-nvidia self-assigned this Jun 26, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between c344ab9 and 736fc7f.

📒 Files selected for processing (1)
  • docs/source/getting_started/televiz.rst

Comment thread docs/source/getting_started/televiz.rst
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