docs: fix broken link and hardcoded version strings in commands.mdx#5465
docs: fix broken link and hardcoded version strings in commands.mdx#5465ShauryaaSharma wants to merge 2 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthrough
Changescommands.mdx Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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>
5573b28 to
a2fb189
Compare
|
✨ 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: |
|
Thanks for catching these documentation issues! The changes look good to me. The broken link fix is straightforward and correct — The version placeholder approach ( No concerns with the change itself. Just needs the pending CI checks to clear. |
|
Tip For best results, initiate chat on the files or code changes.
The link correction looks right, and At this point, this looks ready pending CI. 🐇 |
|
Tip For best results, initiate chat on the files or code changes.
Given the scope here, this looks in good shape pending CI. 🐇✨ |
…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>
|
Closing as obsolete after auditing exact current
At exact head 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. |
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
skill installsection:../manage-sandboxes/install-openclaw-plugins→../deployment/install-openclaw-pluginsOpenClaw v2026.5.27withvYYYY.M.DplaceholderHermes v2026.5.16withvYYYY.M.DplaceholderType of Change
Verification
npx prek run --from-ref main --to-ref HEADpassesnpm testpasses (broad runtime changes only)npm run docsbuilds without warnings (doc changes only)Signed-off-by: ShauryaaSharma shauryasofficial27@gmail.com
Summary by CodeRabbit
vYYYY.M.D) instead of hard-coded version numbers.