Skip to content

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

Closed
ShauryaaSharma wants to merge 2 commits into
NVIDIA:mainfrom
ShauryaaSharma:fix/commands-mdx-broken-link-and-version-strings
Closed

docs: fix broken link and hardcoded version strings in commands.mdx#5465
ShauryaaSharma wants to merge 2 commits into
NVIDIA:mainfrom
ShauryaaSharma:fix/commands-mdx-broken-link-and-version-strings

Conversation

@ShauryaaSharma

@ShauryaaSharma ShauryaaSharma commented Jun 15, 2026

Copy link
Copy Markdown

The skill install section linked to manage-sandboxes/install-openclaw-plugins
which does not exist. The file lives under deployment/, so the correct relative
path is ../deployment/install-openclaw-plugins.

Expected-output code blocks showed hardcoded OpenClaw v2026.5.27 and Hermes
v2026.5.16. These go stale on every release bump. Replaced with the vYYYY.M.D
format placeholder that conveys the versioning scheme without locking to a
specific release.

Summary

Fixes a broken internal link and two hardcoded version strings in docs/reference/commands.mdx.

Related Issue

Closes #5445

Changes

  • Fixed link in skill install section: ../manage-sandboxes/install-openclaw-plugins../deployment/install-openclaw-plugins
  • Replaced hardcoded OpenClaw v2026.5.27 with vYYYY.M.D placeholder
  • Replaced hardcoded Hermes v2026.5.16 with vYYYY.M.D placeholder

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

  • Git hooks passed during commit and push, or npx prek run --from-ref main --to-ref HEAD passes
  • Targeted tests pass for changed behavior
  • Full npm test passes (broad runtime changes only)
  • 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: ShauryaaSharma shauryasofficial27@gmail.com

Summary by CodeRabbit

  • Documentation
    • Updated the command reference “Expected output” snippets for OpenClaw and Hermes to use standardized sandbox agent version placeholders (vYYYY.M.D) instead of hard-coded version numbers.

@coderabbitai

coderabbitai Bot commented Jun 15, 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: 425c8cbe-8857-4463-82b2-5f41e3197287

📥 Commits

Reviewing files that changed from the base of the PR and between a2fb189 and 7c359af.

📒 Files selected for processing (1)
  • docs/reference/commands.mdx
💤 Files with no reviewable changes (1)
  • docs/reference/commands.mdx

📝 Walkthrough

Walkthrough

docs/reference/commands.mdx updates two status output examples so the agent version is shown as vYYYY.M.D instead of fixed version numbers.

Changes

commands.mdx Documentation Updates

Layer / File(s) Summary
Version placeholder updates
docs/reference/commands.mdx
OpenClaw and Hermes status expected-output lines now use the vYYYY.M.D placeholder format instead of hardcoded versions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 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 clearly describes the two docs fixes: a broken link and stale version strings in commands.mdx.
Linked Issues check ✅ Passed The documented changes align with #5445 by correcting the internal link and replacing hardcoded OpenClaw and Hermes versions with placeholders.
Out of Scope Changes check ✅ Passed The PR stays within the docs-only scope and only updates the affected link and example version strings.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

The skill install section linked to manage-sandboxes/install-openclaw-plugins
which does not exist. The file lives under deployment/, so the correct relative
path is ../deployment/install-openclaw-plugins.

Expected-output code blocks showed hardcoded OpenClaw v2026.5.27 and Hermes
v2026.5.16. These go stale on every release bump. Replaced with the vYYYY.M.D
format placeholder that conveys the versioning scheme without locking to a
specific release.

Closes NVIDIA#5445

Signed-off-by: ShauryaaSharma <shauryasofficial27@gmail.com>
@ShauryaaSharma ShauryaaSharma force-pushed the fix/commands-mdx-broken-link-and-version-strings branch from 5573b28 to a2fb189 Compare June 18, 2026 20:01
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance integration: hermes Hermes integration behavior labels Jun 23, 2026
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for fixing the broken internal link in the skill install section and replacing hardcoded OpenClaw and Hermes version strings with placeholders. This proposes a way to correct the documentation reference path and prevent version strings from going stale on future releases.


Related open issues:

@wscurran wscurran added the NV QA Bugs found by the NVIDIA QA Team label Jun 26, 2026
@ShauryaaSharma

ShauryaaSharma commented Jun 28, 2026

Copy link
Copy Markdown
Author

@wscurran @coderabbitai

Thanks for catching these documentation issues! The changes look good to me.

The broken link fix is straightforward and correct — ../deployment/install-openclaw-plugins is the right relative path. The old manage-sandboxes/ prefix was clearly a copy-paste artifact from a different section.

The version placeholder approach (vYYYY.M.D) is a sensible solution to the staleness problem. It communicates the versioning scheme to readers without creating a maintenance burden on every release. One minor thought: if there's a docs-wide convention for version placeholders (e.g., <version>, x.y.z, or a specific format), it might be worth checking docs/ for consistency, but vYYYY.M.D is self-explanatory and probably fine as-is.

No concerns with the change itself. Just needs the pending CI checks to clear.

@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Tip

For best results, initiate chat on the files or code changes.

@ShauryaaSharma Thanks for the thoughtful review — agreed on all points.

The link correction looks right, and vYYYY.M.D is a good fit here to avoid churn from release-by-release doc updates. Your note about checking for a docs-wide placeholder convention is a good follow-up idea too, but I agree it’s non-blocking for this PR.

At this point, this looks ready pending CI. 🐇

@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Tip

For best results, initiate chat on the files or code changes.

@ShauryaaSharma Thanks — agreed. Your read on both changes makes sense, and the note about checking for a docs-wide placeholder convention is a good follow-up idea, but I also see it as non-blocking for this PR.

Given the scope here, this looks in good shape pending CI. 🐇✨

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>
@github-actions github-actions Bot mentioned this pull request Jul 7, 2026
21 tasks
@apurvvkumaria apurvvkumaria added the v0.0.79 Release target label Jul 8, 2026
@apurvvkumaria apurvvkumaria self-assigned this Jul 8, 2026
@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Closing as obsolete after auditing exact current main (0e0807d11c7ac31100c632750af1abceb8b75a82).

  • #6290 independently removed the two hardcoded versions using the repository-consistent v<version> placeholder.
  • QA then established that the proposed ../deployment/install-openclaw-plugins target follows the source directory but resolves to a 404 on the published Fern route. #6385 restored ../manage-sandboxes/install-openclaw-plugins and added a published-route regression guard.
  • Current main now has the correct published-route link, version-neutral OpenClaw and Hermes examples, and a route-level #5445 test that rejects the deployment/ form.

At exact head 7c359af70bffc0a06ac7124fd3dd8b1eb8a83ebb, #5465 is conflicting and its remaining diff only replaces v<version> with vYYYY.M.D; the link change described in its body is both superseded and known to be wrong for the published route. Salvaging it would duplicate the landed version fix and risk regressing the corrected link, so no code is being carried forward.

Thank you @ShauryaaSharma for identifying both documentation problems, preparing the original focused patch, and calling out the need for a stable version placeholder. No maintainer-authored replacement commit is being made in this closure, so there is no new commit to receive a co-author trailer.

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

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance integration: hermes Hermes integration behavior NV QA Bugs found by the NVIDIA QA Team v0.0.79 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[All Platforms][Docs] commands.mdx has broken internal link and hardcoded OpenClaw version strings

3 participants