Skip to content

docs: headless doc cleanup#6108

Open
AntoineRichard wants to merge 1 commit into
isaac-sim:developfrom
AntoineRichard:antoiner/docs-headless-review-followups
Open

docs: headless doc cleanup#6108
AntoineRichard wants to merge 1 commit into
isaac-sim:developfrom
AntoineRichard:antoiner/docs-headless-review-followups

Conversation

@AntoineRichard

Copy link
Copy Markdown
Collaborator

Description

Follow-up to merged PR #6102. This addresses review comments that landed after the original documentation cleanup was merged:

  • Removes dangling trailing backslashes from three Hover policy shell snippets.
  • Rewords stale headless mode prose in the Hydra docs to say the command runs without selecting a visualizer.
  • Rewords the OVPhysX zero-agent rollout prose to avoid implying --headless is required.
  • Rewords the camera-output example comment from headless mode to no visualizer.

No new dependencies.

Fixes # N/A

Type of change

  • Documentation update

Screenshots

N/A.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings (docs build not run separately)
  • I have added tests that prove my fix is effective or that my feature works (N/A, documentation-only)
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package (N/A, no package source touched)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 10, 2026
@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This follow-up PR addresses review comments from the merged headless-cleanup PR (#6102) by fixing documentation wording and shell-snippet formatting across four .rst files.

  • Removes trailing backslashes from the final arguments of three multi-line shell commands in hover_policy.rst; a dangling backslash on the last line causes the shell to expect a continuation and can silently break copy-pasted commands.
  • Replaces "headless mode" / "headless" prose in hydra.rst, ovphysx/index.rst, and save_camera_output.rst with "without selecting a visualizer" / "no visualizer" to match the actual commands shown (none use --headless) and to avoid implying the flag is required.

Confidence Score: 5/5

All four files are documentation only — no runtime code, configuration, or test logic is touched. The rewording correctly matches the commands shown, and removing trailing backslashes from the last line of multi-line shell blocks is the right fix.

Every change is a straightforward documentation correction. The shell-snippet backslash removals and the prose rewords are all self-consistent and match the actual commands in context. There is nothing here that could regress behaviour.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/policy_deployment/00_hover/hover_policy.rst Removes dangling trailing backslashes from the last argument of three multi-line shell snippets (teacher training, student training, sim-to-real deployment commands).
docs/source/features/hydra.rst Rewords "in headless mode" to "without selecting a visualizer" for the Hydra training example, accurately reflecting that no --headless flag is present in the shown command.
docs/source/overview/core-concepts/physical-backends/ovphysx/index.rst Rewords "headless zero-action rollout" to "zero-action rollout without selecting a visualizer" to avoid implying --headless is required.
docs/source/how-to/save_camera_output.rst Updates inline shell comment from "in headless mode" to "(no visualizer)" to be consistent with the broader terminology cleanup.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR #6102 Headless Cleanup Merged] --> B[Review Comments Received]
    B --> C{Change Type}
    C --> D[hover_policy.rst\nRemove trailing backslashes\nfrom 3 shell snippets]
    C --> E[hydra.rst\nReword 'headless mode'\n→ 'without selecting a visualizer']
    C --> F[ovphysx/index.rst\nReword 'headless zero-action rollout'\n→ 'zero-action rollout without selecting a visualizer']
    C --> G[save_camera_output.rst\nReword comment\n'headless mode' → 'no visualizer']
Loading

Reviews (1): Last reviewed commit: "docs: Address headless cleanup review co..." | Re-trigger Greptile

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Documentation Review — PR #6108

Summary: This PR cleanly addresses the follow-up review comments from the headless cleanup effort. The changes are straightforward and correct.

✅ Trailing Backslash Fixes (hover_policy.rst)

All three dangling backslash removals are correct. The final argument in each multi-line shell command no longer carries a continuation character, which resolves potential copy-paste issues for users.

✅ Terminology Rewordings

The "headless mode" → "without selecting a visualizer" / "(no visualizer)" rewordings are consistent with the terminology direction established in the parent PR.

💬 Minor Observation

hydra.rst (line 51): The description says the command runs "without selecting a visualizer," but the example command itself (./isaaclab.sh train --rl_library sb3 --task=Isaac-Cartpole ...) does not explicitly pass a visualizer-related flag — it is simply the default behavior of isaaclab.sh train. Consider whether the phrasing could be simplified to just describe what the command demonstrates (Hydra overrides) without mentioning visualization at all, e.g.:

The above command will run training with the task Isaac-Cartpole and set the env.actions.joint_effort.scale parameter to 10.0 and the agent.seed parameter to 2024.

This avoids making any claim about visualizer behavior that depends on runtime context rather than the shown command.


Overall this is a clean follow-up. No RST formatting issues found, and no remaining stale headless references in the touched files. 🎉

@AntoineRichard AntoineRichard changed the title docs: Address headless cleanup review comments docs: headless doc cleanup Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant