docs: fix Deep Agents troubleshooting security link - #6606
Merged
Conversation
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)
📝 WalkthroughWalkthroughThe PR adds the OpenShell 0.0.72 compatibility review to NemoClaw security navigation, updates the troubleshooting link to its relative security path, and tests link rendering across all agent variants. ChangesOpenShell compatibility review
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Contributor
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage remains at 96%, unchanged from the TypeScript / code-coverage/cliThe overall coverage in the Show a code coverage summary of the most impacted files.
Updated |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-6606.docs.buildwithfern.com/nemoclaw |
![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
🤖 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/agent-variant-docs.test.ts`:
- Around line 185-187: The current test for renderAgentVariantPage only covers
the sourcePath case, so it never exercises the rewriteRelativePaths branch that
runs when both sourcePath and outputPath are present. Update the agent variant
troubleshooting test to pass the generated troubleshooting outputPath for each
variant, then assert against the final rewritten rendered link rather than the
unchanged source link. Use renderAgentVariantPage and rewriteRelativePaths as
the key references while adjusting the test setup and expectation.
🪄 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: 38f4ed42-af78-4aa1-a9cf-a4575387c702
📒 Files selected for processing (3)
docs/index.ymldocs/reference/troubleshooting.mdxtest/agent-variant-docs.test.ts
Contributor
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
Contributor
E2E Target RecommendationRequired E2E targets: None Full E2E target advisor summaryE2E Target AdvisorBase: Required E2E targets
Optional E2E targets
Relevant changed files
|
Contributor
PR Review Advisor (Nemotron Ultra) — No blocking findingsMerge posture: No blocking advisor findings This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
Contributor
PR Review Advisor — No blocking findingsMerge posture: No blocking advisor findings Action checklist
Test follow-ups to resolve or justifyIf these cover changed behavior, prefer adding them in this PR; otherwise state why existing coverage is enough or link the follow-up.
This is an automated, non-binding review; it still expects maintainers and agents to respond to each required or warning item. Treat suggestions as current-PR improvements when they touch changed code; defer only with maintainer rationale or a linked follow-up. A human maintainer must make the final merge decision. |
Collaborator
Author
|
The public issue provides no additional reproduction clauses beyond the title and its NVBug pointer, so these checks directly cover the observable documented behavior available in this repository. |
cv
approved these changes
Jul 9, 2026
Hadar301
pushed a commit
to Hadar301/NemoClaw-OpenShift
that referenced
this pull request
Jul 12, 2026
<!-- markdownlint-disable MD041 --> ## Summary <!-- 1-3 sentences: what this PR does and why. --> Fixes the shared troubleshooting page so the OpenShell compatibility review link stays within the active OpenClaw, Hermes, or Deep Agents guide instead of sending Deep Agents readers to the OpenClaw guide. The existing route checker accepted the old absolute URL because it resolved to a published page, so this PR also adds a focused variant regression assertion. ## Related Issue <!-- Fixes #NNN or Closes #NNN. Remove this section if none. --> Closes NVIDIA#6558. ## Changes <!-- Bullet list of key changes. --> - Replace the hard-coded OpenClaw compatibility-review URL in `docs/reference/troubleshooting.mdx` with a route-style relative link. - Publish the existing OpenShell 0.0.72 compatibility review in the Deep Agents security navigation. - Verify generated troubleshooting pages keep the review link within each agent guide. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [x] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates <!-- Check exactly one tests line and one docs line. Check other lines when applicable. Add every requested justification or approval reference. --> - [x] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [ ] Tests not applicable — justification: - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification <!-- Check each applicable item only when supported by the requested evidence. Run targeted tests once per relevant change set and rerun after later edits or hook autofixes that can affect the tested behavior. Do not rerun hook-covered checks. --> - [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, or tests are marked not applicable above — command/result or justification: `npx vitest run --project integration test/agent-variant-docs.test.ts` passed 8/8 tests. - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) — command passed; Fern reported the existing light-mode accent contrast warning (2.41:1), and the route checker reported all internal links resolve. - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) --- <!-- DCO sign-off is required in this PR description, and every commit must appear as Verified in GitHub. Run: git config user.name && git config user.email --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a new **Security** page entry for the **OpenShell 0.0.72 Compatibility Review** to the Deep Agents documentation navigation. * **Bug Fixes** * Updated troubleshooting documentation to link directly to the new security review page via the correct relative URL. * **Tests** * Added automated checks to ensure the security review link renders correctly across multiple agent variant guides and is not rewritten into a variant-specific path. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
apurvvkumaria
pushed a commit
that referenced
this pull request
Jul 22, 2026
## Summary Fixes a broken link that 404s for Deep Agents readers on the OpenShell 0.0.72 compatibility review page. The page renders in the openclaw, hermes, and deepagents variants and links to the OpenShell 0.0.71 gateway authentication review. That review page is intentionally scoped to openclaw and hermes only. Its content is specific to those agents (Hermes env-file secret boundaries and the OpenClaw gateway-runtime API) and it was deliberately left out of the deepagents nav when the variant was added. A later scoped PR (#6606) added only the 0.0.72 review to the deepagents nav and included a regression test asserting that scoping, so adding 0.0.71 to the deepagents nav would contradict a prior decision and break that test. Instead of forcing the 0.0.71 page into the deepagents nav, this scopes the link itself. The sentence is wrapped in AgentOnly variant="openclaw,hermes" so those readers keep the working link, and a parallel AgentOnly variant="deepagents" block carries the same sentence as plain text so Deep Agents readers still get the information without a dead link. This follows the existing convention in docs/manage-sandboxes/run-sandboxes.mdx. ## Test plan npx vitest run test/agent-variant-docs.test.ts passes (13 tests). npm run docs builds with 0 errors. Verified the generated output: openclaw and hermes keep the link, deepagents renders the plain-text sentence with no broken link. Signed-off-by: Atharv Kumaria <kumariaaatharv@gmail.com> Signed-off-by: Atharv Kumaria <kumariaaatharv@gmail.com>
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
3 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 the shared troubleshooting page so the OpenShell compatibility review link stays within the active OpenClaw, Hermes, or Deep Agents guide instead of sending Deep Agents readers to the OpenClaw guide.
The existing route checker accepted the old absolute URL because it resolved to a published page, so this PR also adds a focused variant regression assertion.
Related Issue
Closes #6558.
Changes
docs/reference/troubleshooting.mdxwith a route-style relative link.Type of Change
Quality Gates
Verification
Verifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run check:diffpassed when hooks were skipped or unavailablenpx vitest run --project integration test/agent-variant-docs.test.tspassed 8/8 tests.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only) — command passed; Fern reported the existing light-mode accent contrast warning (2.41:1), and the route checker reported all internal links resolve.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit