Skip to content

docs: fix commands reference install-plugins link (#5080)#5193

Closed
Thabhelo wants to merge 1 commit into
NVIDIA:mainfrom
Thabhelo:fix/docs-commands-reference-5080
Closed

docs: fix commands reference install-plugins link (#5080)#5193
Thabhelo wants to merge 1 commit into
NVIDIA:mainfrom
Thabhelo:fix/docs-commands-reference-5080

Conversation

@Thabhelo

@Thabhelo Thabhelo commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes the broken Install OpenClaw Plugins cross-link in the commands reference and documents current sandbox-scoped sessions behavior. The tunnel status and sessions dispatch issues reported on v0.0.55 are already fixed on main.

Related Issue

Fixes #5080

Changes

  • Point docs/reference/commands.mdx plugin link from ../manage-sandboxes/install-openclaw-plugins to ../deployment/install-openclaw-plugins.
  • Clarify that nemoclaw <name> sessions requires an existing sandbox and reports Sandbox '<name>' does not exist otherwise.
  • Add test/commands-reference-links.test.ts regression test for the install-plugins link target.

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)

Signed-off-by: Thabhelo 50872400+Thabhelo@users.noreply.github.com

Summary by CodeRabbit

  • Documentation

    • Updated OpenClaw plugin installation reference link location in CLI commands documentation
    • Added clarification noting target sandbox must already exist when using NemoClaw sessions command
  • Tests

    • Added validation tests for documentation link correctness

Point the OpenClaw plugins cross-link at docs/deployment/install-openclaw-plugins.mdx
and clarify that sandbox-scoped sessions require an existing sandbox. Add a
regression test for the link target.

Signed-off-by: Thabhelo <50872400+Thabhelo@users.noreply.github.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 11, 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 11, 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: 55998360-634d-4207-bd13-b3ca22c826f2

📥 Commits

Reviewing files that changed from the base of the PR and between e67ff23 and 034af8f.

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

📝 Walkthrough

Walkthrough

This PR fixes a broken documentation link in the commands reference that incorrectly pointed to ../manage-sandboxes/install-openclaw-plugins instead of the correct ../deployment/install-openclaw-plugins. It also adds a clarifying note to the sessions command documenting that the target sandbox must exist before invocation. A new test validates the link fix and prevents regression.

Changes

Commands Reference Link Fix

Layer / File(s) Summary
Reference link correction, sessions clarification, and validation test
docs/reference/commands.mdx, test/commands-reference-links.test.ts
"Install OpenClaw Plugins" link updated from broken path to correct ../deployment/install-openclaw-plugins target. Sessions command note added clarifying that sandbox <name> must already exist, reporting a "Sandbox does not exist" error if missing. New Vitest test validates link presence, absence of old path, and existence of target documentation file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A link once broken, now repaired with care,
From manage-sandboxes to deploy's lair—
Sessions note whispers: sandbox must be there,
Tests keep us honest, catching unaware! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR addresses 2 of 3 requirements from #5080: fixes the broken install-plugins link and documents sessions sandbox requirement, but does not resolve the tunnel status subcommand mismatch. Address the tunnel status issue by either implementing the subcommand or removing/rewording the documentation section to match the current CLI which only supports tunnel start/stop.
✅ Passed checks (4 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 primary fix: correcting the broken link in the commands reference documentation for the install-plugins reference.
Out of Scope Changes check ✅ Passed All changes align with the objectives: updating the broken link, clarifying sessions behavior, and adding a regression test for the link fix.
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.

@wscurran wscurran added area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build documentation labels Jun 12, 2026
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for fixing the broken Install OpenClaw Plugins cross-link in the commands reference. This proposes a way to update the link target to the deployment guide, clarify sandbox-scoped sessions behavior, and add a regression test for the link.


Related open issues:

@wscurran wscurran requested a review from miyoungc June 12, 2026 14:18
@wscurran wscurran added chore Build, CI, dependency, or tooling maintenance bug-fix PR fixes a bug or regression and removed documentation chore Build, CI, dependency, or tooling maintenance labels Jun 12, 2026
@miyoungc

Copy link
Copy Markdown
Collaborator

Thank you for digging into this, @Thabhelo — the investigation and write-up are appreciated. I'm going to close this one, though, because the core change is based on a false detection in the originating issue (#5080, finding #1) and would actually break the link.

The link is already correct

NemoClaw docs are a Fern site, where inter-page links are route-style paths built from the navigation hierarchy and page slugs in docs/index.yml, not from the .mdx file location on disk. The "Install OpenClaw Plugins" page is filed in nav under the manage-sandboxes section with slug: install-openclaw-plugins, even though the source file lives in deployment/:

- section: "Manage Sandboxes"
  slug: manage-sandboxes
  contents:
    - page: "Install OpenClaw Plugins"
      path: deployment/install-openclaw-plugins.mdx   # file location
      slug: install-openclaw-plugins                  # page slug

So the published route is manage-sandboxes/install-openclaw-plugins, which is exactly what the current link in commands.mdx uses. Changing it to ../deployment/install-openclaw-plugins would 404, because the Deployment nav section only contains deploy-to-remote-gpu and brev-web-ui — there is no deployment/install-openclaw-plugins route.

The QA finding came from checking whether docs/manage-sandboxes/install-openclaw-plugins.mdx exists on disk. It doesn't (the file is under deployment/), but the file folder is not the route. I've left the same explanation on #5080 so the originating report is corrected at the source.

On the added link test

I'd also like to gently push back on test/commands-reference-links.test.ts. A bespoke test that asserts a hardcoded ../deployment/... link target would lock the file-path-based assumption into CI and contradict how Fern resolves routes. The repo already validates route-style links through the Fern build (npm run docs), so we don't want a parallel, divergent link check. Please don't add one-off link assertions like this.

For drafting or fixing docs, the nemoclaw-contributor-update-docs skill follows the route-style conventions automatically, and docs/CONTRIBUTING.md covers the rules under "Route-Style Links" and "Agent Variant Generation".

Other findings

The sessions clarification you noted (finding #3) is a separate, legitimate topic, but it shouldn't ride along with a breaking link change and a divergent test. If it's still relevant on main, a small focused docs PR for just that wording is welcome.

Thanks again, and sorry to turn this one away.

@miyoungc miyoungc closed this Jun 12, 2026
@Thabhelo

Copy link
Copy Markdown
Contributor Author

Kudos for picking that up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build bug-fix PR fixes a bug or regression

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[All Platforms][Docs] Commands reference: broken link + CLI mismatch for tunnel status and sessions

3 participants