docs(commands): fix broken plugin link and drop hardcoded agent versions by yimoj · Pull Request #6290 · NVIDIA/NemoClaw

yimoj · 2026-07-06T03:12:37Z

Summary

Fixes a broken internal link and stale hardcoded agent-version examples in the CLI commands reference. QA flagged that the OpenClaw plugin link 404s and that the status-output examples pin specific OpenClaw/Hermes versions that go stale on every pin bump.

Related Issue

Fixes #5445

Changes

Repoint the OpenClaw plugin link in docs/reference/commands.mdx from the non-existent ../manage-sandboxes/install-openclaw-plugins to ../deployment/install-openclaw-plugins (matches docs/index.yml nav and docs/about/release-notes.mdx).
Replace hardcoded example versions OpenClaw v2026.5.27 and Hermes v2026.5.16 with a v<version> placeholder consistent with the other <name>/<version> placeholders on the page.
Regenerate the derived docs/reference/commands-nemohermes.mdx via npm run docs:sync-agent-variants (generated from commands.mdx; not hand-edited).

Type of Change

Doc only (prose changes, no code sample modifications)

Quality Gates

Tests added or updated for changed behavior
Tests not applicable — justification: docs-only change (broken link + example text); no runtime behavior.
Docs updated for user-facing behavior changes
Docs not applicable

Verification

Reporter workflow is docs navigation (open the page, click the plugin link, read the status-output example) — not a CLI command. There is no nemoclaw/nemohermes runtime surface for a docs link/text change, so a worktree CLI transcript (./bin/nemoclaw.js ...) is not applicable; the equivalent reporter-workflow E2E for a docs internal link is the Fern link resolution check below (fern check fails on unresolved internal links). The docs-only-checks CI job on this PR is the named pipeline E2E for these changes.

PR description includes the DCO sign-off declaration and every commit appears as Verified in GitHub
Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
Targeted behavior tests pass for the current change set, or tests are marked not applicable above — justification: docs-only; ran the reporter-workflow docs checks below.
Quality Gates section completed with required justifications or waivers
No secrets, API keys, or credentials committed
npm run docs builds without warnings (doc changes only) — npm run docs:strict reported 0 errors; the 2 warnings are pre-existing and unrelated (unauthenticated redirect check skipped; light-mode accent contrast ratio).
Doc pages follow the style guide (doc changes only)

Reporter-workflow / pipeline E2E transcript (docs checks from this worktree):

$ rg -n "v2026\.5\.27|v2026\.5\.16" docs/ --glob '!**/_build/**'      # no matches (stale versions gone)
$ rg -n "manage-sandboxes/install-openclaw-plugins" docs/ --glob '!**/_build/**'   # no matches (broken link gone)
$ npm run docs:check-agent-variants   # commands-nemohermes.mdx in sync
$ npm run docs:strict                 # fern check: Found 0 errors and 2 warnings (validates internal link resolves)

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

The OpenClaw plugin link in commands.mdx pointed at ../manage-sandboxes/install-openclaw-plugins, which does not exist; the page lives at ../deployment/install-openclaw-plugins (matching about/release-notes.mdx and docs/index.yml). The status-output examples also hardcoded OpenClaw v2026.5.27 and Hermes v2026.5.16, which go stale on every pin bump. Replace them with a v<version> placeholder consistent with the other <name>/<version> placeholders on the page and regenerate the derived commands-nemohermes.mdx. Fixes #5445 Signed-off-by: Yimo Jiang <yimoj@nvidia.com>

coderabbitai · 2026-07-06T03:12:59Z

📝 Walkthrough

Walkthrough

Documentation updates to docs/reference/commands.mdx and docs/reference/commands-nemohermes.mdx replace hardcoded version strings (v2026.5.27, v2026.5.16) in example outputs with generic v<version> placeholders, and correct the "Install OpenClaw Plugins" link path from ../manage-sandboxes/ to ../deployment/.

Changes

Docs fixes

Layer / File(s)	Summary
Replace hardcoded version strings with placeholders `docs/reference/commands.mdx`, `docs/reference/commands-nemohermes.mdx`	Hermes and OpenClaw version-check example output lines now show `Agent: <Agent> v<version>` instead of pinned version numbers.
Fix broken plugin install link `docs/reference/commands.mdx`	The `$$nemoclaw <name> skill install` OpenClaw plugin link now points to `../deployment/install-openclaw-plugins` instead of the broken `../manage-sandboxes/` path.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

NVIDIA/NemoClaw#2587: Also updates the $$nemoclaw <name> skill install link in commands.mdx to point to ../deployment/.
NVIDIA/NemoClaw#3296: Also generalizes OpenClaw/Hermes version output to v<version> placeholders in the same command reference files.
NVIDIA/NemoClaw#4632: Also updates the same generated Hermes/OpenClaw CLI reference MDX examples.

Suggested labels: area: docs, area: cli

Suggested reviewers: cv, ericksoa

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The changes satisfy issue `#5445` by fixing the internal link and replacing the hardcoded OpenClaw and Hermes version strings with placeholders.
Out of Scope Changes check	✅ Passed	The updated nemohermes reference file is a direct regeneration of the touched commands docs and stays within the stated documentation scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main documentation fixes: the broken link and hardcoded version examples.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch fix/5445-docs-links-versions

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

github-actions · 2026-07-06T03:13:20Z

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

github-actions · 2026-07-06T03:13:24Z

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 changes cannot affect installer/onboarding, sandbox lifecycle, credentials, security boundaries, network policy, inference routing, deployment, or real assistant user flows.

Optional E2E

None.

New E2E recommendations

None.

github-actions · 2026-07-06T03:13:25Z

E2E Target Recommendation

Required E2E targets: None
Optional E2E targets: None

Workflow run

Full E2E target advisor summary

E2E Target Advisor

Base: origin/main
Head: HEAD
Confidence: high

Required E2E targets

None. Docs-only changes outside test/e2e and E2E workflow/target machinery cannot affect E2E target behavior.

Optional E2E targets

None.

Relevant changed files

None.

github-actions · 2026-07-06T03:14:11Z

PR Review Advisor (Nemotron Ultra) — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: Consider PRA-1: Broken documentation link fixed.
Open items: 0 required · 0 warnings · 1 suggestion · 0 test follow-ups
Since last review: 0 prior items resolved · 0 still apply · 0 new items found

Action checklist

PRA-1 In-scope improvement: Broken documentation link fixed in docs/reference/commands.mdx:1667

Findings index

ID	Severity	Category	Location	Required action
`PRA-1`	Improvement	docs	`docs/reference/commands.mdx:1667`	No action needed — fix is correct and verified. Merge as-is.

Review findings by urgency: 0 required fixes, 0 items to resolve/justify, 1 in-scope improvement

⚠️ Resolve or justify before merge

Investigate these in the current review; either fix them, explain why they are not applicable, or document the accepted risk.

None.

💡 In-scope improvements

These are lower-risk, not throwaway. Prefer fixing them in this PR when they are local to changed code; defer only with rationale or a linked follow-up.

`PRA-1` Improvement — Broken documentation link fixed

Location: docs/reference/commands.mdx:1667
Category: docs
Problem: Fixed broken internal link from `../manage-sandboxes/install-openclaw-plugins` to `../deployment/install-openclaw-plugins`. Target file `docs/deployment/install-openclaw-plugins.mdx` exists and is the correct documentation page for OpenClaw plugin installation.
Impact: Users following the link in the published docs would previously hit a 404. Now resolves to the correct plugin installation guide.
Suggested action: No action needed — fix is correct and verified. Merge as-is.
Expected follow-up: Prefer a current-PR fix when local to changed code; defer only with rationale or linked follow-up.
Verification: Verify `docs/deployment/install-openclaw-plugins.mdx` exists and `rg -n 'manage-sandboxes/install-openclaw-plugins' docs/` returns no matches.
Missing regression test: Not applicable — documentation link fix covered by existing `npm run docs:strict` link validation.
Done when: The local improvement is applied, or the PR notes why it should be deferred.
Evidence: PR diff shows link change at commands.mdx:1667; target file confirmed via `find` tool; `npm run docs:strict` reports 0 errors.

Since last review details

Current findings, using the urgency labels above:

`PRA-1` Improvement — Broken documentation link fixed

Location: docs/reference/commands.mdx:1667
Category: docs
Problem: Fixed broken internal link from `../manage-sandboxes/install-openclaw-plugins` to `../deployment/install-openclaw-plugins`. Target file `docs/deployment/install-openclaw-plugins.mdx` exists and is the correct documentation page for OpenClaw plugin installation.
Impact: Users following the link in the published docs would previously hit a 404. Now resolves to the correct plugin installation guide.
Suggested action: No action needed — fix is correct and verified. Merge as-is.
Expected follow-up: Prefer a current-PR fix when local to changed code; defer only with rationale or linked follow-up.
Verification: Verify `docs/deployment/install-openclaw-plugins.mdx` exists and `rg -n 'manage-sandboxes/install-openclaw-plugins' docs/` returns no matches.
Missing regression test: Not applicable — documentation link fix covered by existing `npm run docs:strict` link validation.
Done when: The local improvement is applied, or the PR notes why it should be deferred.
Evidence: PR diff shows link change at commands.mdx:1667; target file confirmed via `find` tool; `npm run docs:strict` reports 0 errors.

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

github-actions · 2026-07-06T03:14:23Z

PR Review Advisor — No blocking findings

Merge posture: No blocking advisor findings
Primary next action: No advisor follow-up required beyond maintainer review.
Open items: 0 required · 0 warnings · 0 suggestions · 0 test follow-ups

Workflow run details

This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision.

prekshivyas

Verified on the branch: all hardcoded agent version strings in the "Expected output" blocks are replaced with the v<version> placeholder, and the broken plugin link is corrected from ../manage-sandboxes/install-openclaw-plugins to ../deployment/install-openclaw-plugins. Confirmed zero remaining OpenClaw v2026/Hermes v2026 strings and zero manage-sandboxes/install-openclaw-plugins references in docs/. Docs-only, CI green, advisor merge_as_is. LGTM.

…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>  ## 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.  --------- Signed-off-by: Yimo Jiang <yimoj@nvidia.com> Signed-off-by: Carlos Villela <cvillela@nvidia.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>

…ons (NVIDIA#6290)

…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>  ## 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.  --------- Signed-off-by: Yimo Jiang <yimoj@nvidia.com> Signed-off-by: Carlos Villela <cvillela@nvidia.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>

yimoj added the v0.0.75 label Jul 6, 2026

prekshivyas self-assigned this Jul 6, 2026

prekshivyas approved these changes Jul 6, 2026

View reviewed changes

cv merged commit 113fcaf into main Jul 6, 2026
49 of 51 checks passed

cv deleted the fix/5445-docs-links-versions branch July 6, 2026 19:14

ericksoa mentioned this pull request Jul 6, 2026

fix(onboard): diagnose incomplete custom plugin images #6250

Closed

21 tasks

yimoj mentioned this pull request Jul 7, 2026

docs(commands): route Install OpenClaw Plugins link to published section (#5445) #6385

Merged

9 tasks

wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance labels Jul 7, 2026

apurvvkumaria mentioned this pull request Jul 8, 2026

docs: fix broken link and hardcoded version strings in commands.mdx #5465

Closed

13 tasks

Hadar301 pushed a commit to Hadar301/NemoClaw-OpenShift that referenced this pull request Jul 12, 2026

docs(commands): fix broken plugin link and drop hardcoded agent versi…

6a83c50

…ons (NVIDIA#6290)

senthilr-nv added v0.0.89 and removed v0.0.88 labels Jul 18, 2026

Uh oh!

Conversation

yimoj commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Changes

Type of Change

Quality Gates

Verification

Uh oh!

coderabbitai Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

github-actions Bot commented Jul 6, 2026

Uh oh!

github-actions Bot commented Jul 6, 2026

E2E Advisor Recommendation

E2E Recommendation Advisor

Required E2E

Optional E2E

New E2E recommendations

Uh oh!

github-actions Bot commented Jul 6, 2026

E2E Target Recommendation

E2E Target Advisor

Required E2E targets

Optional E2E targets

Relevant changed files

Uh oh!

github-actions Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Advisor (Nemotron Ultra) — No blocking findings

Action checklist

Findings index

⚠️ Resolve or justify before merge

💡 In-scope improvements

PRA-1 Improvement — Broken documentation link fixed

PRA-1 Improvement — Broken documentation link fixed

Uh oh!

github-actions Bot commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review Advisor — No blocking findings

Uh oh!

prekshivyas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yimoj commented Jul 6, 2026 •

edited

Loading

coderabbitai Bot commented Jul 6, 2026 •

edited

Loading

github-actions Bot commented Jul 6, 2026 •

edited

Loading

`PRA-1` Improvement — Broken documentation link fixed

`PRA-1` Improvement — Broken documentation link fixed

github-actions Bot commented Jul 6, 2026 •

edited

Loading