Skip to content

docs: fix broken internal links to Windows Prerequisites and Hermes Quickstart#5392

Closed
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:docs/fix-5076-links
Closed

docs: fix broken internal links to Windows Prerequisites and Hermes Quickstart#5392
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:docs/fix-5076-links

Conversation

@harjothkhara

@harjothkhara harjothkhara commented Jun 13, 2026

Copy link
Copy Markdown

Summary

Several internal documentation links pointed at paths that do not exist as Fern source files, so they 404 (or resolve to the wrong page) in the rendered docs. Fern resolves relative [](…) links by source-file path, so this points each link at its real source file.

Related Issue

Fixes #5076

Changes

  • docs/reference/troubleshooting.mdx
    • Windows Prerequisites: ../get-started/prerequisites/windows-preparation../get-started/windows-preparation (the page is docs/get-started/windows-preparation.mdx; prerequisites/ is the nav slug, not a directory).
    • Hermes Quickstart: ../../hermes/get-started/quickstart (escapes the docs/ tree) and a "Quickstart with Hermes" link that pointed at the OpenClaw quickstart → ../get-started/quickstart-hermes.
  • docs/get-started/prerequisites.mdx: prerequisites/windows-preparationwindows-preparation.
  • docs/about/overview.mdx: the variant="hermes" "Quickstart with Hermes" link ../get-started/quickstart../get-started/quickstart-hermes.
  • Left the correct OpenClaw quickstart links untouched.
  • Added test/repro-5076-docs-links.test.ts asserting the corrected targets (mirrors test/repro-5088-best-practices-layers.test.ts).

This matches the file-path convention established by #5099, which linked Sandbox Hardening through its real deployment/ path rather than its nav slug.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications) — plus a regression test under test/
  • Doc only (includes code sample changes)

Verification

  • 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)

Verified locally: every corrected link's target source file exists; scripts/docs-to-skills.py docs/ .agents/skills/ skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run succeeds; and the new regression test's assertions pass. The full prek / npm test / npm run docs suite was not run locally; leaving those for CI.


Signed-off-by: harjoth harjoth.khara@gmail.com

Summary by CodeRabbit

  • Documentation

    • Corrected internal navigation links across documentation guides, including Windows setup prerequisites and Hermes quickstart references, ensuring users are properly directed between related pages.
  • Tests

    • Added regression tests to verify that internal documentation cross-references resolve to valid source files, preventing future link breakage.

…uickstart

Fern resolves relative markdown links by source-file path, so several links resolved to missing or wrong pages:

- Windows Prerequisites links used the nav slug path
  (../get-started/prerequisites/windows-preparation); the source file is
  docs/get-started/windows-preparation.mdx.
- Hermes Quickstart links used an out-of-tree path
  (../../hermes/get-started/quickstart) or pointed at the OpenClaw quickstart
  in a "Quickstart with Hermes" context; the source file is
  docs/get-started/quickstart-hermes.mdx.

Point each link at its real source file (matching the file-path convention
from NVIDIA#5099) and add a regression test covering the corrected targets.

Fixes NVIDIA#5076

Signed-off-by: harjoth <harjoth.khara@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 13, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 13, 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: 50d7b831-1aa0-4592-92a7-11894f275ad2

📥 Commits

Reviewing files that changed from the base of the PR and between 720bee9 and 02b7d00.

📒 Files selected for processing (4)
  • docs/about/overview.mdx
  • docs/get-started/prerequisites.mdx
  • docs/reference/troubleshooting.mdx
  • test/repro-5076-docs-links.test.ts

📝 Walkthrough

Walkthrough

This PR fixes broken internal documentation links in the NemoClaw docs that were identified in issue #5076. It corrects Windows preparation paths from ../get-started/prerequisites/windows-preparation to ../get-started/windows-preparation and Hermes quickstart paths from ../../hermes/get-started/quickstart to ../get-started/quickstart-hermes across multiple MDX files, then adds a regression test to prevent future link breakage.

Changes

Documentation Link Fixes

Layer / File(s) Summary
Fix internal documentation links across doc pages
docs/get-started/prerequisites.mdx, docs/reference/troubleshooting.mdx, docs/about/overview.mdx
Windows preparation links are corrected from prerequisites/windows-preparation path to the correct windows-preparation location. Hermes quickstart links are updated from the non-existent ../../hermes/get-started/quickstart path to the correct ../get-started/quickstart-hermes across all documentation entry points.
Add regression test for issue #5076
test/repro-5076-docs-links.test.ts
New Vitest suite validates that corrected documentation links to Windows preparation and Hermes quickstart pages resolve to real MDX source files in the docs/ directory, covering assertions across troubleshooting, prerequisites, and overview pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#5185: Extends Vitest coverage for validating internal documentation Markdown links by migrating docs link validation into E2E test suite.

Suggested labels

area: docs, bug-fix

Suggested reviewers

  • miyoungc
  • cv

Poem

🐰 A rabbit fixed the broken paths,
Links now lead where docs reside,
Windows prep and Hermes quests,
No more 404s in the night—
Tests stand guard, so paths stay right! 🔗

🚥 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 PR title accurately describes the primary change: fixing broken internal links to Windows Prerequisites and Hermes Quickstart pages in the documentation.
Linked Issues check ✅ Passed The PR successfully addresses all coding requirements from issue #5076: correcting broken internal links in docs/reference/troubleshooting.mdx, docs/get-started/prerequisites.mdx, docs/about/overview.mdx, and adding regression tests in test/repro-5076-docs-links.test.ts.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing the broken links identified in issue #5076 and adding related regression tests; no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@harjothkhara

Copy link
Copy Markdown
Author

Closing this. The underlying issue #5076 was closed as not-planned (a docs-link validation false positive): NemoClaw Fern docs use route-style links resolved via the nav slugs in docs/index.yml, not source-file paths (see the "Route-Style Links" section in docs/CONTRIBUTING.md), so these links resolve correctly on the live site and rewriting them to file paths is the change the guide advises against. The maintainer-side equivalent link-fix PR (#5460) was also closed unmerged with the note that the remaining link changes should not be merged as-is. Closing rather than leaving this open against a declined issue.

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.

[All Platforms][Docs] Broken internal links in Troubleshooting page (Windows preparation and Hermes quickstart)

1 participant