docs: fix broken internal links to Windows Prerequisites and Hermes Quickstart#5392
docs: fix broken internal links to Windows Prerequisites and Hermes Quickstart#5392harjothkhara wants to merge 1 commit into
Conversation
…uickstart Fern resolves relative markdown links by source-file path, so several links resolved to missing or wrong pages: - Windows Prerequisites links used the nav slug path (../get-started/prerequisites/windows-preparation); the source file is docs/get-started/windows-preparation.mdx. - Hermes Quickstart links used an out-of-tree path (../../hermes/get-started/quickstart) or pointed at the OpenClaw quickstart in a "Quickstart with Hermes" context; the source file is docs/get-started/quickstart-hermes.mdx. Point each link at its real source file (matching the file-path convention from NVIDIA#5099) and add a regression test covering the corrected targets. Fixes NVIDIA#5076 Signed-off-by: harjoth <harjoth.khara@gmail.com>
|
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 (4)
📝 WalkthroughWalkthroughThis PR fixes broken internal documentation links in the NemoClaw docs that were identified in issue ChangesDocumentation Link Fixes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Closing this. The underlying issue #5076 was closed as not-planned (a docs-link validation false positive): NemoClaw Fern docs use route-style links resolved via the nav slugs in |
Summary
Several internal documentation links pointed at paths that do not exist as Fern source files, so they 404 (or resolve to the wrong page) in the rendered docs. Fern resolves relative
[](…)links by source-file path, so this points each link at its real source file.Related Issue
Fixes #5076
Changes
docs/reference/troubleshooting.mdx../get-started/prerequisites/windows-preparation→../get-started/windows-preparation(the page isdocs/get-started/windows-preparation.mdx;prerequisites/is the nav slug, not a directory).../../hermes/get-started/quickstart(escapes thedocs/tree) and a "Quickstart with Hermes" link that pointed at the OpenClaw quickstart →../get-started/quickstart-hermes.docs/get-started/prerequisites.mdx:prerequisites/windows-preparation→windows-preparation.docs/about/overview.mdx: thevariant="hermes""Quickstart with Hermes" link../get-started/quickstart→../get-started/quickstart-hermes.quickstartlinks untouched.test/repro-5076-docs-links.test.tsasserting the corrected targets (mirrorstest/repro-5088-best-practices-layers.test.ts).This matches the file-path convention established by #5099, which linked Sandbox Hardening through its real
deployment/path rather than its nav slug.Type of Change
test/Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Verified locally: every corrected link's target source file exists;
scripts/docs-to-skills.py docs/ .agents/skills/ skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-runsucceeds; and the new regression test's assertions pass. The fullprek/npm test/npm run docssuite was not run locally; leaving those for CI.Signed-off-by: harjoth harjoth.khara@gmail.com
Summary by CodeRabbit
Documentation
Tests