Commit 5d115f8
authored
Addresses the actionable findings from the 2026-06-19 doc-validate run
across 11 guide pages.
Closes NVIDIA#5630
Refs NVIDIA#5631
Closes NVIDIA#5632
Closes NVIDIA#5633
Closes NVIDIA#5634
Closes NVIDIA#5635
Closes NVIDIA#5636
Closes NVIDIA#5637
Closes NVIDIA#5638
Closes NVIDIA#5639
Closes NVIDIA#5640
| Issue | Page | Fix |
|-------|------|-----|
| NVIDIA#5630 | manage-sandboxes/lifecycle | bump stale NEMOCLAW_INSTALL_TAG
example v0.0.63 → v0.0.65 |
| NVIDIA#5631 | get-started/quickstart | self-contained non-interactive
install (provider/key/sandbox name); consistent sandbox name |
| NVIDIA#5632 | inference/set-up-sub-agent | guidance for non-Omni sub-agent
configs (auth-profiles upload already documented) |
| NVIDIA#5633 | inference/switch-inference-providers | show `credentials list`
to discover provider names before switching |
| NVIDIA#5634 | network-policy/integration-policy-examples | note `policy-add`
is non-idempotent; remove before re-applying |
| NVIDIA#5635 | inference/inference-options | state vLLM install +
running-server prerequisites |
| NVIDIA#5636 | inference/use-local-inference | add
`--yes-i-accept-third-party-software` to non-interactive Ollama; add
`docker network inspect` subnet discovery |
| NVIDIA#5637 | reference/troubleshooting | nvm/Docker prerequisites note;
make CA-bundle grep non-zero-safe (`|| true`) |
| NVIDIA#5638 | deployment/sandbox-hardening | explain `nemoclaw-sandbox`
image placeholder; Landlock verify expected output/fallback |
| NVIDIA#5639 | manage-sandboxes/messaging-channels | quote angle-bracket
credential placeholders |
| NVIDIA#5640 | monitoring/monitor-sandbox-activity | correct legacy `sandbox
exec` → `<name> exec --`; placeholder names; context-overflow `/reset`
remediation |
NVIDIA#5631 is referenced rather than closed: this PR fixes the quickstart
docs (the non-interactive block now lists the required
provider/key/sandbox-name vars, and the `connect` example uses a
consistent sandbox name). The exit-1 failure in item 1 is an installer
bug, root-caused in NVIDIA#5626 with the fix in flight at NVIDIA#5641, and item 2's
name consistency is also covered by NVIDIA#5723. NVIDIA#5631 should close once those
land, not on this docs PR.
Not changed (with rationale):
- The recurring "`$$nemoclaw` breaks copy-paste" finding (NVIDIA#5630, NVIDIA#5634,
NVIDIA#5635, NVIDIA#5636, NVIDIA#5639, NVIDIA#5640): `$$nemoclaw` is the intentional
`CLI_SENTINEL` replaced at build time by
scripts/sync-agent-variant-docs.ts (and required on shared nav pages by
`assertNoUnsharedPlaceholders`). It renders as `nemoclaw`/`nemohermes`
in published docs, so it is correct as-is; the validator scanned raw MDX
rather than rendered output.
- NVIDIA#5637 "v0.0.43" string: kept — it is a historical "starting with
version X" statement, not a stale version.
- Some findings (NVIDIA#5636 hermes tool-calling-reliability link, NVIDIA#5639
hermes deploy link and backtick) are already resolved in current source
(links are `AgentOnly variant="openclaw"` gated; backticks balanced).
Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Strengthened sandbox hardening guidance with clearer runtime
capability-dropping instructions and more explicit Landlock
detection/fallback behavior.
* Refreshed quickstart and installer/CLI examples, including corrected
sandbox naming and a more reliable non-interactive install flow.
* Updated inference setup materials (vLLM sequencing, endpoint
readiness, provider discovery/selection, and streamlined sub-agent JSON
editing).
* Improved local inference, sandbox lifecycle install tag, monitoring
command examples, and added context-reset troubleshooting.
* Enhanced messaging/network-policy/troubleshooting snippets with safer
quoting and more resilient command behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Signed-off-by: Abhimanyu Kumar <abhimanyukumar7290@gmail.com>
1 parent 0cfaf8f commit 5d115f8
11 files changed
Lines changed: 67 additions & 23 deletions
File tree
- docs
- deployment
- get-started
- inference
- manage-sandboxes
- monitoring
- network-policy
- reference
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
| 59 | + | |
59 | 60 | | |
60 | 61 | | |
61 | 62 | | |
| |||
138 | 139 | | |
139 | 140 | | |
140 | 141 | | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
141 | 145 | | |
142 | 146 | | |
143 | 147 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
57 | 63 | | |
58 | 64 | | |
| 65 | + | |
| 66 | + | |
59 | 67 | | |
60 | 68 | | |
61 | 69 | | |
| |||
275 | 283 | | |
276 | 284 | | |
277 | 285 | | |
278 | | - | |
| 286 | + | |
279 | 287 | | |
280 | 288 | | |
281 | 289 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
241 | 241 | | |
242 | 242 | | |
243 | 243 | | |
| 244 | + | |
244 | 245 | | |
245 | 246 | | |
246 | 247 | | |
| |||
266 | 267 | | |
267 | 268 | | |
268 | 269 | | |
269 | | - | |
| 270 | + | |
| 271 | + | |
270 | 272 | | |
271 | 273 | | |
272 | 274 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
84 | 84 | | |
85 | 85 | | |
86 | 86 | | |
| 87 | + | |
87 | 88 | | |
88 | 89 | | |
89 | 90 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
24 | 35 | | |
25 | 36 | | |
26 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
148 | 148 | | |
149 | 149 | | |
150 | 150 | | |
151 | | - | |
| 151 | + | |
| 152 | + | |
152 | 153 | | |
153 | 154 | | |
154 | 155 | | |
| |||
175 | 176 | | |
176 | 177 | | |
177 | 178 | | |
178 | | - | |
| 179 | + | |
179 | 180 | | |
180 | 181 | | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
181 | 187 | | |
182 | 188 | | |
183 | 189 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
257 | 257 | | |
258 | 258 | | |
259 | 259 | | |
260 | | - | |
| 260 | + | |
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
175 | 175 | | |
176 | 176 | | |
177 | 177 | | |
178 | | - | |
| 178 | + | |
179 | 179 | | |
180 | | - | |
181 | | - | |
182 | | - | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | | - | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
190 | 190 | | |
191 | 191 | | |
192 | 192 | | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
193 | 196 | | |
194 | 197 | | |
195 | 198 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | 77 | | |
78 | 78 | | |
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | | - | |
| 117 | + | |
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
| |||
126 | 126 | | |
127 | 127 | | |
128 | 128 | | |
| 129 | + | |
129 | 130 | | |
130 | 131 | | |
131 | 132 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
96 | 96 | | |
97 | 97 | | |
98 | 98 | | |
99 | | - | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
100 | 102 | | |
101 | 103 | | |
102 | 104 | | |
| |||
0 commit comments