Skip to content

docs(reference): fix remote GPU command links#4727

Merged
cv merged 1 commit into
mainfrom
fix/docs-broken-remote-gpu-links
Jun 3, 2026
Merged

docs(reference): fix remote GPU command links#4727
cv merged 1 commit into
mainfrom
fix/docs-broken-remote-gpu-links

Conversation

@cv

@cv cv commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes the broken remote GPU documentation links that caused the Nightly docs-validation E2E job to fail. The command references now point at the existing Fern MDX page instead of a non-existent Markdown file.

Changes

  • Updated docs/reference/commands.mdx to link to ../deployment/deploy-to-remote-gpu.mdx.
  • Updated docs/reference/commands-nemohermes.mdx to link to the same existing MDX page.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

Confirmed the failing path from https://github.com/NVIDIA/NemoClaw/actions/runs/26914255345/job/79399985216 with CHECK_DOC_LINKS_REMOTE=0 bash test/e2e/test-docs-validation.sh.

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Carlos Villela cvillela@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Corrected internal documentation links across remote deployment and configuration reference pages.

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
@cv cv self-assigned this Jun 3, 2026
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1f4604e9-e5a1-4bfa-ad35-4cb7ad3b3290

📥 Commits

Reviewing files that changed from the base of the PR and between 1ada907 and 7e0cc22.

📒 Files selected for processing (2)
  • docs/reference/commands-nemohermes.mdx
  • docs/reference/commands.mdx

📝 Walkthrough

Walkthrough

Two documentation reference files update internal cross-references to consistently target the .mdx extension format. The "Deploy to Remote GPU" guide links in the NemoHermes command reference and main command reference documentation are updated from .md to .mdx to ensure links target the correct documentation file variant.

Changes

Documentation Link Format Updates

Layer / File(s) Summary
Reference documentation link updates
docs/reference/commands-nemohermes.mdx, docs/reference/commands.mdx
Two command reference files update the "Deploy to Remote GPU" link target from .md to .mdx extension in the Remote Deployment environment-variable and how-to sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4166: Introduced the "Deploy to Remote GPU" guide that these link updates reference.
  • NVIDIA/NemoClaw#4665: Previously updated documentation link targets in the same command reference files for consistency.

Suggested labels

documentation, area: docs

Poem

🐇 Links dance between .md and .mdx
A rabbit hops through docs to fix them quick,
Two tiny tweaks, extensions align,
Now readers find their way down the line! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing broken remote GPU command documentation links by updating file references from .md to .mdx format.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-broken-remote-gpu-links

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

@cv cv requested a review from miyoungc June 3, 2026 21:59
@cv cv enabled auto-merge (squash) June 3, 2026 21:59
@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

E2E Advisor Recommendation

Required E2E: None
Optional E2E: None

Workflow run

Full advisor summary

E2E Recommendation Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E

  • None. Docs-only link target correction in reference pages. This cannot affect runtime behavior or real user flows, so no E2E jobs are recommended.

Optional E2E

  • None.

New E2E recommendations

  • None.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

E2E Scenario Advisor Recommendation

Required scenario E2E: None
Optional scenario E2E: None

Workflow run

Full scenario advisor summary

E2E Scenario Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required scenario E2E

  • None. Docs-only changes outside test/e2e-scenario and scenario workflow files cannot affect scenario E2E behavior.

Optional scenario E2E

  • None.

Relevant changed files

  • None.

@github-actions

github-actions Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor

Findings: 0 needs attention, 0 worth checking, 0 nice ideas
Top item: No actionable findings

Workflow run details

This is an automated advisory review. A human maintainer must make the final merge decision.

@cv cv merged commit 19a17ea into main Jun 3, 2026
32 checks passed
@cv cv deleted the fix/docs-broken-remote-gpu-links branch June 3, 2026 22:08
@wscurran wscurran added the chore Build, CI, dependency, or tooling maintenance label Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants