Skip to content

docs: fix stale links and skill listing - #5460

Closed
glenn-agent wants to merge 1 commit into
NVIDIA:mainfrom
glenn-agent:docs/fix-doc-links-and-examples
Closed

docs: fix stale links and skill listing#5460
glenn-agent wants to merge 1 commit into
NVIDIA:mainfrom
glenn-agent:docs/fix-doc-links-and-examples

Conversation

@glenn-agent

@glenn-agent glenn-agent commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Fix several low-risk documentation navigation and discoverability issues reported by doc validation:

  • Fix stale links and version placeholders in the commands reference.
  • Point architecture and release-note links at the existing Sandbox Hardening, Windows preparation, and Hermes quickstart pages.
  • Add the missing running-sandbox prerequisite to the sub-agent setup guide.
  • List nemoclaw-user-agent-skills in the agent skills page and add an example question for it.
  • Fix broken Windows and Hermes links in troubleshooting.

Fixes #5445
Fixes #5089
Fixes #5079
Fixes #5077
Fixes #5083
Fixes #5076

Testing

  • npm run docs:sync-agent-variants
  • npm run docs:strict — passed with 0 errors and 2 Fern upgrade warnings
  • git diff --check
  • npm run docs:check-agent-variants
  • git verify-commit HEAD

Signed-off-by: Glenn-Agent glenn_agent@163.com

Summary by CodeRabbit

Documentation

  • Fixed internal documentation links across setup and reference guides for improved navigation accuracy
  • Updated version placeholders in command examples to use generic format for broader compatibility
  • Added prerequisite requirements and context to sub-agent setup instructions for clarity
  • Expanded skill documentation to include the NemoClaw user agent skills feature with example usage

Signed-off-by: Glenn-Agent <glenn_agent@163.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 15, 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 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Fixes broken internal documentation links across six pages (how-it-works, release-notes, troubleshooting, commands reference), replaces hardcoded agent version strings with generic vX.Y.Z placeholders in command reference examples, adds prerequisite guidance to the sub-agent setup page, and adds the missing nemoclaw-user-agent-skills entry to the agent skills reference.

Changes

Documentation Link Fixes, Version Placeholders, and Content Additions

Layer / File(s) Summary
Internal link corrections
docs/about/how-it-works.mdx, docs/about/release-notes.mdx, docs/reference/troubleshooting.mdx, docs/reference/commands.mdx
Corrects broken or stale relative link targets: sandbox-hardening and Hermes quickstart in how-it-works, Windows bootstrap and Hermes quickstart in release-notes, Windows preparation (×2) and Hermes quickstart (×2) in troubleshooting, and OpenClaw plugin install page in commands.
Version string generalization
docs/reference/commands.mdx, docs/reference/commands-nemohermes.mdx
Replaces pinned version strings (v2026.5.27, v2026.5.16) in expected-output code blocks with generic vX.Y.Z placeholders for both OpenClaw and Hermes.
Prerequisite note and new skill entry
docs/inference/set-up-sub-agent.mdx, docs/resources/agent-skills.mdx
Inserts a prerequisite section before the Docker exec commands in set-up-sub-agent.mdx, and adds nemoclaw-user-agent-skills to the Available Skills table and example questions mapping in agent-skills.mdx.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#5247: Modifies the same "Update the Sandbox Config" section in docs/inference/set-up-sub-agent.mdx — directly overlaps with this PR's prerequisite addition in that section.
  • NVIDIA/NemoClaw#5358: Updates link targets in docs/about/release-notes.mdx for Hermes and Windows paths, the same links corrected here.

Suggested labels

area: docs, area: skills

Suggested reviewers

  • cv
  • prekshivyas

Poem

🐇 Hoppity-hop through the docs I go,
Fixing the links that led to "404 no!"
Version strings swapped to vX.Y.Z,
A skill was lost — now found for thee!
The prereqs are clear, the paths are right,
This bunny fixed docs in the moonlight. ✨

🚥 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 stale links and skill listing' accurately summarizes the main changes—fixing broken documentation links and adding missing skill entries—making it clear and directly related to the changeset.
Linked Issues check ✅ Passed All six linked issues are fully addressed: hardcoded versions and broken plugin link fixed (#5445), sandbox-hardening and hermes quickstart paths corrected (#5089), Windows and Hermes links updated in release notes (#5079), prerequisite added to sub-agents setup (#5077), nemoclaw-user-agent-skills added to skills page (#5083), and troubleshooting links fixed (#5076).
Out of Scope Changes check ✅ Passed All changes are documentation-only and directly address the six linked issues; no unrelated modifications or scope creep detected in the changeset.
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.

@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.

🧹 Nitpick comments (1)
docs/inference/set-up-sub-agent.mdx (1)

55-55: ⚡ Quick win

Use active voice here.

Line 55 reads passively. As per coding guidelines, use active voice and second person in docs.

🤖 Prompt for 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.

In `@docs/inference/set-up-sub-agent.mdx` at line 55, Rewrite line 55 in
docs/inference/set-up-sub-agent.mdx to use active voice and second person
perspective instead of passive voice. The current sentence uses passive
constructions like "must be running" and "must be discoverable". Convert it to
direct, imperative instructions that address the reader directly using "you" and
"your", such as by making it clear what actions the reader must take to ensure
the sandbox is properly configured and discoverable.

Source: Coding guidelines

🤖 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.

Nitpick comments:
In `@docs/inference/set-up-sub-agent.mdx`:
- Line 55: Rewrite line 55 in docs/inference/set-up-sub-agent.mdx to use active
voice and second person perspective instead of passive voice. The current
sentence uses passive constructions like "must be running" and "must be
discoverable". Convert it to direct, imperative instructions that address the
reader directly using "you" and "your", such as by making it clear what actions
the reader must take to ensure the sandbox is properly configured and
discoverable.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e0f9a93c-ca7b-4d58-bdaa-f600a823c596

📥 Commits

Reviewing files that changed from the base of the PR and between f4f3c58 and d809dbc.

📒 Files selected for processing (7)
  • docs/about/how-it-works.mdx
  • docs/about/release-notes.mdx
  • docs/inference/set-up-sub-agent.mdx
  • docs/reference/commands-nemohermes.mdx
  • docs/reference/commands.mdx
  • docs/reference/troubleshooting.mdx
  • docs/resources/agent-skills.mdx

@miyoungc

Copy link
Copy Markdown
Collaborator

Thanks for taking the time to work through these documentation findings.

We are closing this PR because the part that applies to #5083 has already been resolved and merged in #5522. main now includes the nemoclaw-user-agent-skills row in the Available Skills table and the matching example question, so there is nothing left from #5083 that this PR needs to carry.

The remaining link changes in this PR should not be merged as-is. Several of those QA findings came from resolving Fern docs links as raw filesystem paths, but NemoClaw's published docs use route-style links from docs/index.yml. Converting those links to source-file paths would risk breaking the published Fern routes.

Appreciate the contribution. If there is a separate unresolved docs issue, please open a fresh focused PR against that specific issue.

@miyoungc miyoungc closed this Jun 16, 2026
cv added a commit that referenced this pull request Jul 7, 2026
…ion (#5445) (#6385)

## Summary

The OpenClaw commands reference page linked to the Install OpenClaw
Plugins page using its **source directory**
(`../deployment/install-openclaw-plugins`), but Fern publishes that page
under the **`manage-sandboxes`** nav section. The link therefore 404s on
the live site even though the source file exists on disk. This restores
the published-route link and adds a route-level regression guard so the
drift cannot recur.

## Related Issue

Fixes #5445

## Changes

- `docs/reference/commands.mdx`: link `Install OpenClaw Plugins` via its
published nav section (`../manage-sandboxes/install-openclaw-plugins`)
instead of its source directory
(`../deployment/install-openclaw-plugins`).
- `scripts/check-docs-published-routes.ts`: new checker that derives the
published route map from `docs/index.yml` (variant + section slugs) and
resolves the commands page's relative links **route-relative, the way
Fern serves them**, failing if any resolves to a route that is not
published. Scoped to the commands reference page, which has regressed
repeatedly (#5445, #6290, #5465, #5460).
- `package.json`: add `docs:check-routes` and wire it into `npm run
docs:strict`, so a source-path-valid but published-route-broken link
fails docs validation.
- `test/repro-5445-docs-published-route.test.ts`: Vitest regression that
derives the route from `docs/index.yml`, asserts the commands link
resolves to
`/user-guide/openclaw/manage-sandboxes/install-openclaw-plugins` and
**not** `/user-guide/openclaw/deployment/install-openclaw-plugins`, plus
resolver/extractor robustness cases.

## Root cause

PR #6290, tasked with fixing this link, reasoned from the source file
path (`docs/deployment/install-openclaw-plugins.mdx`) and "corrected" a
previously-working `manage-sandboxes` link back to `deployment`. `fern
check` and source-path checks both pass on the broken form because the
source file exists — the missing validation was published-route
resolution.

## Type of Change

- [x] Code change with doc updates

## Quality Gates
- [x] Tests added or updated for changed behavior
- [ ] Docs updated for user-facing behavior changes
- [x] Docs not applicable — justification: the changed page is the doc;
the link target and its content are unchanged, only the route it points
to is corrected.

## Verification
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run check:diff` passed when hooks were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set —
command/result: `npx vitest run
test/repro-5445-docs-published-route.test.ts` (8 passed; fails on
upstream/main pre-fix, passes post-fix); `npm run docs:strict` (0
errors).
- [x] No secrets, API keys, or credentials committed
- [x] `npm run docs` builds without warnings (doc changes only)

### Route-level reporter-workflow evidence

Ground truth from Fern's own link resolver (`fern docs broken-links`),
the same resolution the reader navigates:

- **Before (upstream/main):** 26 broken links, including the commands
page → `/user-guide/openclaw/deployment/install-openclaw-plugins` (404).
- **After (this branch):** 24 broken links — the commands-page
install-plugins error is gone, and **none added**. The remaining 24 are
pre-existing, unrelated broken links (nested-page relative links,
hermes-variant structural gaps) outside this issue's scope.

`fern check` alone does not catch this (it passed in #6290); the new
`docs:check-routes` gate does.

---
Signed-off-by: Yimo Jiang <yimoj@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Corrected a documentation link to point to the published “Install
OpenClaw Plugins” page under the correct route.
* Improved doc link validation to ensure links resolve to published
routes (including correct route selection).

* **Tests**
* Added/expanded regression coverage for the plugin installation link,
published-route mapping, and robust markdown link resolution.

* **Chores**
* Enhanced the strict documentation checks to also verify
published-route correctness and route mappings.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Yimo Jiang <yimoj@nvidia.com>
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026
…ion (NVIDIA#5445) (NVIDIA#6385)

## Summary

The OpenClaw commands reference page linked to the Install OpenClaw
Plugins page using its **source directory**
(`../deployment/install-openclaw-plugins`), but Fern publishes that page
under the **`manage-sandboxes`** nav section. The link therefore 404s on
the live site even though the source file exists on disk. This restores
the published-route link and adds a route-level regression guard so the
drift cannot recur.

## Related Issue

Fixes NVIDIA#5445

## Changes

- `docs/reference/commands.mdx`: link `Install OpenClaw Plugins` via its
published nav section (`../manage-sandboxes/install-openclaw-plugins`)
instead of its source directory
(`../deployment/install-openclaw-plugins`).
- `scripts/check-docs-published-routes.ts`: new checker that derives the
published route map from `docs/index.yml` (variant + section slugs) and
resolves the commands page's relative links **route-relative, the way
Fern serves them**, failing if any resolves to a route that is not
published. Scoped to the commands reference page, which has regressed
repeatedly (NVIDIA#5445, NVIDIA#6290, NVIDIA#5465, NVIDIA#5460).
- `package.json`: add `docs:check-routes` and wire it into `npm run
docs:strict`, so a source-path-valid but published-route-broken link
fails docs validation.
- `test/repro-5445-docs-published-route.test.ts`: Vitest regression that
derives the route from `docs/index.yml`, asserts the commands link
resolves to
`/user-guide/openclaw/manage-sandboxes/install-openclaw-plugins` and
**not** `/user-guide/openclaw/deployment/install-openclaw-plugins`, plus
resolver/extractor robustness cases.

## Root cause

PR NVIDIA#6290, tasked with fixing this link, reasoned from the source file
path (`docs/deployment/install-openclaw-plugins.mdx`) and "corrected" a
previously-working `manage-sandboxes` link back to `deployment`. `fern
check` and source-path checks both pass on the broken form because the
source file exists — the missing validation was published-route
resolution.

## Type of Change

- [x] Code change with doc updates

## Quality Gates
- [x] Tests added or updated for changed behavior
- [ ] Docs updated for user-facing behavior changes
- [x] Docs not applicable — justification: the changed page is the doc;
the link target and its content are unchanged, only the route it points
to is corrected.

## Verification
- [x] PR description includes the DCO sign-off declaration and every
commit appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run check:diff` passed when hooks were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set —
command/result: `npx vitest run
test/repro-5445-docs-published-route.test.ts` (8 passed; fails on
upstream/main pre-fix, passes post-fix); `npm run docs:strict` (0
errors).
- [x] No secrets, API keys, or credentials committed
- [x] `npm run docs` builds without warnings (doc changes only)

### Route-level reporter-workflow evidence

Ground truth from Fern's own link resolver (`fern docs broken-links`),
the same resolution the reader navigates:

- **Before (upstream/main):** 26 broken links, including the commands
page → `/user-guide/openclaw/deployment/install-openclaw-plugins` (404).
- **After (this branch):** 24 broken links — the commands-page
install-plugins error is gone, and **none added**. The remaining 24 are
pre-existing, unrelated broken links (nested-page relative links,
hermes-variant structural gaps) outside this issue's scope.

`fern check` alone does not catch this (it passed in NVIDIA#6290); the new
`docs:check-routes` gate does.

---
Signed-off-by: Yimo Jiang <yimoj@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Corrected a documentation link to point to the published “Install
OpenClaw Plugins” page under the correct route.
* Improved doc link validation to ensure links resolve to published
routes (including correct route selection).

* **Tests**
* Added/expanded regression coverage for the plugin installation link,
published-route mapping, and robust markdown link resolution.

* **Chores**
* Enhanced the strict documentation checks to also verify
published-route correctness and route mappings.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Yimo Jiang <yimoj@nvidia.com>
Signed-off-by: Carlos Villela <cvillela@nvidia.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment