docs: fix broken documentation links

[miyoungc]

Summary

Fix broken links reported by the docs link checker across the NemoClaw user-guide variants. The updates keep moved internal pages reachable, correct OpenClaw/Hermes variant links, and replace a stale external OpenClaw security docs URL.

Related Issue

None.

Changes

• Corrected internal links for Windows preparation, sandbox hardening, plugin installation, Hermes command reference, and sub-agent setup pages.
• Added an explicit set-up-sub-agent slug and Fern redirects from the old title-derived sub-agent URL.
• Replaced root-relative docs links that break under the /nemoclaw site base path.
• Updated the OpenClaw security docs link from /gateway/security/index to /gateway/security.

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

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

Additional verification run:

• npm run docs:sync-agent-variants && npm run docs passed.
• fern check --warnings passed with 0 errors and only the existing light-mode accent color contrast warning.
• git diff --check passed.

Summary by CodeRabbit

Release Notes

• Documentation
  • Updated documentation links across multiple guides to improve navigation consistency and accessibility throughout the platform
  • Reorganized sandbox hardening and plugin installation documentation references to align with current structure
  • Fixed outdated navigation paths in getting started, deployment, security, and troubleshooting sections for a better user experience

[copy-pr-bot]

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR reorganizes and standardizes internal documentation links across the NemoClaw docs. It migrates sandbox hardening and plugin installation references from deployment/ to manage-sandboxes/, restructures Windows prerequisites under a prerequisites/ subpath, converts root-absolute paths to relative paths for portability, and refactors the main index page to remove unused dynamic functions.

Changes

Documentation Link Reorganization

Layer / File(s)	Summary
Sandbox Hardening and Plugin Installation Path Migration docs/about/how-it-works.mdx, docs/security/best-practices.mdx, docs/reference/commands.mdx	Migrate sandbox hardening references from ../deployment/sandbox-hardening to ../manage-sandboxes/sandbox-hardening and update OpenClaw plugin installation documentation link from ../deployment/install-openclaw-plugins to ../manage-sandboxes/install-openclaw-plugins.
Windows Prerequisites Path Restructuring docs/get-started/prerequisites.mdx, docs/get-started/windows-preparation.mdx, docs/about/release-notes.mdx	Add prerequisites/ subpath to Windows preparation documentation links and update all quickstart references within Windows prerequisites docs and release notes to use consistent parent-relative (../) paths.
Deployment Documentation Relative Path Conversion docs/deployment/brev-web-ui.mdx, docs/deployment/deploy-to-remote-gpu.mdx, docs/deployment/install-openclaw-plugins.mdx	Convert root-absolute paths to relative paths across deployment documentation: updated Brev web UI deployment links, remote GPU inference references, and network policy links to use ../ relative paths.
Hermes and Quickstart Cross-Reference Updates docs/reference/troubleshooting.mdx, docs/manage-sandboxes/install-plugins-hermes.mdx	Update troubleshooting and Hermes plugin documentation to use relative paths for Windows setup, quickstart, Hermes quickstart, and network policy references.
Main Index Page and Navigation Updates docs/index.mdx, docs/index.yml, docs/security/openclaw-controls.mdx	Remove unused AgentOnly and guidePath imports, convert agent quickstart and user guide navigation links to relative paths, replace dynamic guidePath() calls with static resources/agent-skills path, add slug: set-up-sub-agent field to navigation configuration, and update external gateway security link from /gateway/security/index to /gateway/security.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• NVIDIA/NemoClaw#4169: Both PRs touch docs/reference/troubleshooting.mdx, with the related PR adding a new Hermes troubleshooting section while this PR adjusts Hermes-related troubleshooting cross-reference links.

Suggested labels

documentation

Suggested reviewers

• cv

Poem

📚 A rabbit hops through docs with care,
Paths reorganized everywhere—
From deployment to manage-sandboxes we go,
Windows in folders, links all aglow,
Relative paths make sharing more fair! 🐰

🚥 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 'docs: fix broken documentation links' directly and clearly describes the main change—it's a documentation-focused PR that fixes multiple broken links across various doc files.
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 docs/fix-links

---

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

[github-actions]

🌿 Preview your docs: https://nvidia-preview-pr-4665.docs.buildwithfern.com/nemoclaw

[github-actions]

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. No E2E is recommended because this PR is docs-only: it updates documentation cross-links, release-note references, and docs navigation metadata. There are no changes to runtime source, CLI behavior, installers, sandbox lifecycle code, credential handling, network policy assets, inference routing, deployment scripts, or real assistant workflows.

Optional E2E

• None.

New E2E recommendations

• None.

[github-actions]

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/catalog/runtime paths; no scenario E2E behavior is affected.

Optional scenario E2E

• None.

Relevant changed files

• None.

[github-actions]

PR Review Advisor

Findings: 1 needs attention, 1 worth checking, 0 nice ideas
Top item: Add the missing sub-agent Fern redirect

Review findings

🛠️ Needs attention

• Missing Fern redirect for the old sub-agent URL (fern/docs.yml:62): The PR body says it adds “Fern redirects from the old title-derived sub-agent URL,” but the diff does not modify `fern/docs.yml`, and the existing redirects do not include a sub-agent/title-derived route such as the prior auto-derived `set-up-task-specific-sub-agents` path. Adding `slug: set-up-sub-agent` makes the canonical route explicit, but it does not preserve old external/bookmarked URLs by itself.
  • Recommendation: Add explicit Fern redirects for the old title-derived sub-agent URL in `fern/docs.yml` for the relevant `/nemoclaw/latest/...` and non-versioned paths, or remove/clarify the PR acceptance claim if no redirect is intended.
  • Evidence: `docs/index.yml` adds `slug: set-up-sub-agent`, but `fern/docs.yml` was not changed and searching the redirects found no `set-up-task-specific` or sub-agent redirect entry.

🔎 Worth checking

• Source-of-truth review needed: Fern redirect compatibility for the sub-agent documentation URL: The advisor marked localized patch analysis as missing.
  • Recommendation: Identify the invalid state, source boundary, source-fix constraint, regression test, and removal condition before merging the localized behavior.
  • Evidence: `docs/index.yml` adds `slug: set-up-sub-agent`, but `fern/docs.yml` contains no matching old sub-agent URL redirect.

🌱 Nice ideas

• None.

Workflow run details

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

[coderabbitai]

Actionable comments posted: 5

🤖 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/about/release-notes.mdx`:
- Line 39: The link target "../get-started/prerequisites/windows-preparation" in
the release notes is pointing to a non-existent nested route; update the
markdown link target to the correct Windows preparation page path (e.g., the
canonical route used across the docs such as
"/get-started/prerequisites/windows-preparation" or the actual existing relative
path), by replacing the string
"../get-started/prerequisites/windows-preparation" with the verified correct
path and confirm the target page exists and resolves in the docs build.

In `@docs/deployment/install-openclaw-plugins.mdx`:
- Line 97: Update the Markdown link target for "Sandbox Hardening" in
docs/deployment/install-openclaw-plugins.mdx: replace the existing link target
`(sandbox-hardening)` with the migrated path
`../manage-sandboxes/sandbox-hardening` so the cross-reference points to the new
location; locate the text "[Sandbox Hardening](sandbox-hardening)" and update
only the link URL portion to the new relative path.

In `@docs/get-started/prerequisites.mdx`:
- Line 77: The relative link target "prerequisites/windows-preparation" used in
the Next Steps line (link text "[Prepare Windows for NemoClaw]") is broken;
update that link to point to the correct sibling page path (use the sibling page
slug for the Windows preparation doc instead of the nested path) so the
cross-reference resolves from docs/get-started/prerequisites.mdx to the actual
Windows preparation page; locate the link by searching for the "[Prepare Windows
for NemoClaw]" anchor and replace its href with the correct sibling path.

In `@docs/get-started/windows-preparation.mdx`:
- Around line 16-19: The markdown links "[Quickstart](../quickstart)" and
"[Quickstart with Hermes](../quickstart-hermes)" (and other occurrences that use
../ or ../../ in this document) are over-parented and likely broken; update
these to docs-local relative links (e.g., "./quickstart" or
"./quickstart-hermes" or the correct sibling paths) so they resolve from
docs/get-started/windows-preparation.mdx; search for other occurrences
referenced in the comment (the repeats around the 34-39, 166-169, 176 ranges)
and replace any "../" or "../../" link targets with the appropriate
local-relative targets consistent with the docs folder structure.

In `@docs/reference/troubleshooting.mdx`:
- Line 1277: The link "../get-started/prerequisites/windows-preparation" in
docs/reference/troubleshooting.mdx is resolving to a non-existent nested page;
replace both occurrences (the exact string
"../get-started/prerequisites/windows-preparation") with the direct Windows
preparation route "/get-started/prerequisites/windows-preparation" so the
cross-reference resolves correctly.

🪄 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: d192f2f5-5193-4f62-aa92-4db33795070f

📥 Commits

Reviewing files that changed from the base of the PR and between c8df6ae and 1e59114.

📒 Files selected for processing (14)

• docs/about/how-it-works.mdx
• docs/about/release-notes.mdx
• docs/deployment/brev-web-ui.mdx
• docs/deployment/deploy-to-remote-gpu.mdx
• docs/deployment/install-openclaw-plugins.mdx
• docs/get-started/prerequisites.mdx
• docs/get-started/windows-preparation.mdx
• docs/index.mdx
• docs/index.yml
• docs/manage-sandboxes/install-plugins-hermes.mdx
• docs/reference/commands.mdx
• docs/reference/troubleshooting.mdx
• docs/security/best-practices.mdx
• docs/security/openclaw-controls.mdx