docs: fix generated variant route links#4737
Merged
Merged
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Contributor
|
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 skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR consolidates Hermes quickstart links to shared ChangesDocumentation Updates and Tooling
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Contributor
PR Review AdvisorFindings: 0 needs attention, 2 worth checking, 0 nice ideas Review findings🛠️ Needs attention
🔎 Worth checking
🌱 Nice ideas
Since last review detailsCurrent findings:
This is an automated advisory review. A human maintainer must make the final merge decision. |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-4737.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorFailed: Could not parse JSON from advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/e2e-advisor/e2e-advisor-raw-output.txt |
Contributor
E2E Scenario Advisor RecommendationRequired scenario E2E: None Full scenario advisor summaryE2E Scenario AdvisorFailed: Could not parse JSON from advisor output; see /home/runner/work/NemoClaw/NemoClaw/artifacts/e2e-advisor/e2e-scenario-advisor-raw-output.txt |
miyoungc
added
area: docs
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
cv
approved these changes
Jun 4, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
scripts/sync-agent-variant-docs.ts (1)
372-389:⚠️ Potential issue | 🟠 Major | ⚡ Quick winDon't mutate generated docs from the
--checkpath.
writeGeneratedFiles()now always prunes and writes files. Becausemain()also calls it when--checkis set, stale variant outputs will be silently rewritten instead of causing the check to fail, which makes the verification path non-authoritative.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@scripts/sync-agent-variant-docs.ts` around lines 372 - 389, writeGeneratedFiles currently always prunes and writes files, which mutates generated docs even when running in --check; change writeGeneratedFiles to accept a boolean checkMode (or dryRun) and thread that into pruneStaleGeneratedFiles so that when checkMode is true you do not call writeFileSync or rmSync or create directories; instead compare contents with readOptionalFile and, on any mismatch or any stale file discovered via listGeneratedFiles, return/throw a non-zero/explicit error so main() can fail the check; update any call site (main()) to pass the --check flag into writeGeneratedFiles.
🧹 Nitpick comments (2)
docs/security/best-practices.mdx (1)
303-305: ⚡ Quick winSplit into one sentence per line.
Line 304 contains two sentences on the same line.
The style guide requires one sentence per line in source to make diffs readable.📝 Proposed fix
<AgentOnly variant="openclaw"> -For additional protection, pass `--cap-drop=ALL` with `docker run` or Compose. Refer to [Sandbox Hardening](../manage-sandboxes/sandbox-hardening). +For additional protection, pass `--cap-drop=ALL` with `docker run` or Compose. +Refer to [Sandbox Hardening](../manage-sandboxes/sandbox-hardening). </AgentOnly>As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/security/best-practices.mdx` around lines 303 - 305, The AgentOnly block (<AgentOnly variant="openclaw">) contains two sentences on one line; split them so each sentence is on its own line within that block (i.e., put "For additional protection, pass `--cap-drop=ALL` with `docker run` or Compose." on one line and "Refer to [Sandbox Hardening](../manage-sandboxes/sandbox-hardening)." on the next) to satisfy the one-sentence-per-line style rule.docs/reference/troubleshooting.mdx (1)
1561-1561: ⚡ Quick winConsider splitting this into multiple lines.
Line 1561 contains multiple sentences on the same line, which makes diffs less readable. As per coding guidelines, documentation should have one sentence per line.
📝 Suggested refactor
-The Hermes wizard intentionally omits the Brave Search preset because Hermes does not use NemoClaw's OpenClaw web-search configuration (see [Quickstart with Hermes](../../hermes/get-started/quickstart) and [Network Policies](network-policies)). +The Hermes wizard intentionally omits the Brave Search preset because Hermes does not use NemoClaw's OpenClaw web-search configuration. +See [Quickstart with Hermes](../../hermes/get-started/quickstart) and [Network Policies](network-policies) for details.As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/reference/troubleshooting.mdx` at line 1561, The single line "The Hermes wizard intentionally omits the Brave Search preset because Hermes does not use NemoClaw's OpenClaw web-search configuration (see [Quickstart with Hermes](../../hermes/get-started/quickstart) and [Network Policies](network-policies))." should be split so each sentence is on its own line (one-sentence-per-line policy); break after the clause describing omission and place the parenthetical reference "(see [Quickstart with Hermes]... and [Network Policies])" on its own line or attached to the sentence it documents, preserving the link text and punctuation exactly and ensuring whitespace/newline only changes, not link targets or wording.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@test/check-docs-links.test.ts`:
- Around line 99-147: The test uses fixed/shared tempPath and navPath which can
collide; change the test to create a unique temporary directory (e.g., with
fs.mkdtempSync) and place both the MDX test file (was tempPath) and the nav YAML
(was navPath) inside that unique dir, update references passed to runCheckDocs
to point to those per-run paths, and ensure cleanup removes that temp dir;
target symbols: tempPath, navPath, runCheckDocs in the test so the file
creation, invocation, and teardown are all switched to per-test unique temp
files instead of hardcoded/shared names.
---
Outside diff comments:
In `@scripts/sync-agent-variant-docs.ts`:
- Around line 372-389: writeGeneratedFiles currently always prunes and writes
files, which mutates generated docs even when running in --check; change
writeGeneratedFiles to accept a boolean checkMode (or dryRun) and thread that
into pruneStaleGeneratedFiles so that when checkMode is true you do not call
writeFileSync or rmSync or create directories; instead compare contents with
readOptionalFile and, on any mismatch or any stale file discovered via
listGeneratedFiles, return/throw a non-zero/explicit error so main() can fail
the check; update any call site (main()) to pass the --check flag into
writeGeneratedFiles.
---
Nitpick comments:
In `@docs/reference/troubleshooting.mdx`:
- Line 1561: The single line "The Hermes wizard intentionally omits the Brave
Search preset because Hermes does not use NemoClaw's OpenClaw web-search
configuration (see [Quickstart with Hermes](../../hermes/get-started/quickstart)
and [Network Policies](network-policies))." should be split so each sentence is
on its own line (one-sentence-per-line policy); break after the clause
describing omission and place the parenthetical reference "(see [Quickstart with
Hermes]... and [Network Policies])" on its own line or attached to the sentence
it documents, preserving the link text and punctuation exactly and ensuring
whitespace/newline only changes, not link targets or wording.
In `@docs/security/best-practices.mdx`:
- Around line 303-305: The AgentOnly block (<AgentOnly variant="openclaw">)
contains two sentences on one line; split them so each sentence is on its own
line within that block (i.e., put "For additional protection, pass
`--cap-drop=ALL` with `docker run` or Compose." on one line and "Refer to
[Sandbox Hardening](../manage-sandboxes/sandbox-hardening)." on the next) to
satisfy the one-sentence-per-line style rule.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ea552e9e-5279-4b16-a96e-67a3edad2dc0
📒 Files selected for processing (20)
docs/about/ecosystem-hermes.mdxdocs/about/how-it-works.mdxdocs/about/overview.mdxdocs/about/release-notes.mdxdocs/get-started/prerequisites.mdxdocs/get-started/windows-preparation.mdxdocs/index.mdxdocs/index.ymldocs/inference/inference-options.mdxdocs/inference/use-local-inference.mdxdocs/manage-sandboxes/lifecycle.mdxdocs/manage-sandboxes/messaging-channels.mdxdocs/reference/commands-nemohermes.mdxdocs/reference/commands.mdxdocs/reference/troubleshooting.mdxdocs/security/best-practices.mdxfern/docs.ymlscripts/sync-agent-variant-docs.tstest/check-docs-links.test.tstest/e2e/e2e-cloud-experimental/check-docs.sh
💤 Files with no reviewable changes (2)
- docs/reference/commands-nemohermes.mdx
- docs/reference/commands.mdx
13 tasks
cv
pushed a commit
that referenced
this pull request
Jun 5, 2026
## Summary
- Add the v0.0.59 release notes from the GitHub announcement discussion.
- Refresh local inference and credential-storage guidance for the
current release behavior.
- Regenerate the user skills from the updated Fern docs.
- Tighten release-prep and docs review guidance for generated skills, PR
labels, and shared `$$nemoclaw` command placeholders.
## Verification
- `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix
nemoclaw-user --doc-platform fern-mdx`
- `rg "permissive mode|shields down|shields up|shields status|config
rotate-token|rotate-token" --glob '*.{md,mdx}'`
- `git diff --check`
- `npm run docs` (rerun outside sandbox after sandbox-only `tsx` IPC
permission failure)
- `npm run typecheck:cli`
- Pre-commit hooks during commit passed, including markdownlint,
docs-to-skills verification, gitleaks, commitlint, and skills YAML
tests.
## Source Summary
- #3679, #4437, #4681, #4766, #4772, #4775, #4786 ->
`docs/about/release-notes.mdx`, `docs/reference/commands.mdx`,
`docs/reference/troubleshooting.mdx`: Summarize OpenClaw 2026.5.27
compatibility, runtime path pinning, plugin registry recovery, live
gateway reconciliation, and clearer host-alias/startup diagnostics.
- #4332, #4402, #4769, #4776, #4779 -> `docs/about/release-notes.mdx`,
`docs/inference/inference-options.mdx`,
`docs/inference/use-local-inference.mdx`,
`docs/inference/switch-inference-providers.mdx`: Document the release
inference changes covering Local NIM waits, Hermes Anthropic routing,
Nemotron 3 Ultra, the current Ollama starter fallback, and Spark
managed-vLLM context length.
- #4628, #4652, #4733, #4745 -> `docs/about/release-notes.mdx`,
`docs/security/credential-storage.mdx`,
`docs/manage-sandboxes/messaging-channels.mdx`,
`docs/reference/troubleshooting.mdx`: Capture permission healing,
gateway-stored credential reuse, cross-sandbox messaging credential
conflict checks, and CDI preflight diagnostics.
- #4728, #4737, #4743, #4744, #4782 -> `.agents/skills/nemoclaw-user-*`:
Regenerate the user skill references from the updated source docs.
- Follow-up maintenance ->
`.agents/skills/nemoclaw-contributor-update-docs/SKILL.md`,
`.coderabbit.yaml`: Add release-prep area labels for docs and skills
PRs, and teach docs review guidance that `$$nemoclaw` is the correct
shared command placeholder for examples that work across agent aliases.
Note: the `documentation` label was not present in the repository, so
this PR is labeled with `v0.0.59` only.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Updated default model for local Ollama inference setup to qwen3.5:9b
* Added Nemotron 3 Ultra 550B as an NVIDIA Endpoints model option
* Clarified credential storage and reuse behavior for post-deployment
(day-two) operations
* Added v0.0.59 release notes covering OpenClaw compatibility, inference
options, Hermes messaging sync, and troubleshooting
* Clarified CLI selection guidance and updated OpenClaw version example
in status output
* Revised release-prep instructions and docs review guidance for CLI
alias usage
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes broken route-style links in generated OpenClaw/Hermes docs variants and tightens the docs link checker so future Fern route links do not use
.mdor.mdxsuffixes.Changes
quickstartroute and added redirects from legacyquickstart-hermespaths.scripts/sync-agent-variant-docs.tsso generated variant output prunes stale files and keeps only referenced generated pages..md/.mdxsuffixes when a link resolves as a Fern route.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Verified locally:
npm test -- test/check-docs-links.test.tsbash test/e2e/e2e-cloud-experimental/check-docs.sh --only-links --local-onlynpm run docs(passes with the existing Fern warning)Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit