Skip to content

fix(docs): correct in-sandbox OpenClaw config path in runtime controls#5436

Closed
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:fix/docs-runtime-config-path
Closed

fix(docs): correct in-sandbox OpenClaw config path in runtime controls#5436
harjothkhara wants to merge 1 commit into
NVIDIA:mainfrom
harjothkhara:fix/docs-runtime-config-path

Conversation

@harjothkhara

@harjothkhara harjothkhara commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

The Runtime Controls page tells users the OpenClaw "runtime source of truth inside the sandbox" is /opt/nemoclaw/openclaw.json. That directory holds the NemoClaw plugin, not the agent config — so a user following the doc to inspect or reconcile config would look in the wrong place. OpenClaw reads its config from /sandbox/.openclaw/openclaw.json. This corrects the path.

Related Issue

None — found during a documentation correctness sweep. (No tracking issue filed.)

Changes

  • docs/manage-sandboxes/runtime-controls.mdx: fix the OpenClaw "runtime source of truth" path from /opt/nemoclaw/openclaw.json to /sandbox/.openclaw/openclaw.json. The Hermes sibling row a few lines below already uses the correct /sandbox/.hermes/config.yaml + /sandbox/.hermes/.env paths.
  • test/repro-runtime-controls-config-path.test.ts: add a regression test asserting the corrected OpenClaw path (and the existing Hermes paths), mirroring the existing docs-regression pattern in test/repro-5088-best-practices-layers.test.ts.

Evidence the corrected path is the real one:

  • Dockerfile installs the NemoClaw plugin at /opt/nemoclaw (openclaw plugins install /opt/nemoclaw) and writes the agent config to /sandbox/.openclaw/openclaw.json.
  • src/lib/channel-runtime-status.ts reads /sandbox/.openclaw/openclaw.json and documents it as "the same file OpenClaw parses at startup."

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

(One-word prose correction; plus an additive docs-regression guard test. No runtime code or code samples changed.)

Verification

  • Git hooks passed during commit and push, or npx prek run --from-ref main --to-ref HEAD passes
  • Targeted tests pass for changed behavior
  • Full npm test passes (broad runtime changes only)
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Notes: the new regression test passes (vitest run test/repro-runtime-controls-config-path.test.ts → 2 passed). The full npm test and npm run docs boxes are left unchecked because this is a prose-only change with no link or structural impact; the targeted regression test is the proof.


Signed-off-by: harjoth harjoth.khara@gmail.com

Summary by CodeRabbit

  • Documentation

    • Updated NemoClaw runtime controls documentation to reference the correct in-sandbox OpenClaw “source of truth” path (/sandbox/.openclaw/openclaw.json) instead of the prior /opt/... location.
  • Tests

    • Added a regression test that validates the documentation no longer references the old OpenClaw path and continues to confirm the expected Hermes runtime “source of truth” paths.

@copy-pr-bot

copy-pr-bot Bot commented Jun 15, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bd2a8176-6ba6-4493-9cdc-255b5dba360f

📥 Commits

Reviewing files that changed from the base of the PR and between f9023ca and 6ca5e6b.

📒 Files selected for processing (2)
  • docs/manage-sandboxes/runtime-controls.mdx
  • test/repro-runtime-controls-config-path.test.ts
✅ Files skipped from review due to trivial changes (1)
  • docs/manage-sandboxes/runtime-controls.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • test/repro-runtime-controls-config-path.test.ts

📝 Walkthrough

Walkthrough

A single-character path correction in docs/manage-sandboxes/runtime-controls.mdx changes the OpenClaw runtime source-of-truth path from /opt/nemoclaw/openclaw.json to /sandbox/.openclaw/openclaw.json. A new Vitest regression test reads that documentation file and asserts the corrected path, the absence of the old path, and the stability of Hermes runtime paths.

Changes

OpenClaw Config Path Fix and Regression Guard

Layer / File(s) Summary
Doc path correction and regression test
docs/manage-sandboxes/runtime-controls.mdx, test/repro-runtime-controls-config-path.test.ts
Corrects the in-sandbox OpenClaw config path from /opt/nemoclaw/openclaw.json to /sandbox/.openclaw/openclaw.json in the runtime controls docs, and adds a Vitest test that verifies the corrected OpenClaw path is present, the stale path is absent, and Hermes runtime paths (/sandbox/.hermes/config.yaml, /sandbox/.hermes/.env) remain unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

area: docs

Poem

A path was astray in the docs one bright day,
/opt/nemoclaw had wandered away!
🐇 Now .openclaw sits snug in /sandbox instead,
A Vitest guard watches so it stays on the right thread.
Hop, hop — no regressions, the warren is fed! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: correcting the in-sandbox OpenClaw configuration path in the runtime controls documentation from an incorrect path to the correct one.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

The runtime-controls page told users the OpenClaw "runtime source of truth
inside the sandbox" is /opt/nemoclaw/openclaw.json, but that directory holds
the NemoClaw plugin (installed via "openclaw plugins install /opt/nemoclaw"),
not the config. OpenClaw reads its config from /sandbox/.openclaw/openclaw.json
-- the path the Dockerfile writes and that src/lib/channel-runtime-status.ts
calls "the same file OpenClaw parses." The Hermes sibling row already uses the
correct /sandbox/.hermes paths.

Add a regression test asserting the corrected path, mirroring the docs
repro-test pattern (test/repro-5088-best-practices-layers.test.ts).

Signed-off-by: harjoth <harjoth.khara@gmail.com>
@harjothkhara harjothkhara force-pushed the fix/docs-runtime-config-path branch from f9023ca to 6ca5e6b Compare June 16, 2026 23:00
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build bug-fix PR fixes a bug or regression integration: openclaw OpenClaw integration behavior labels Jun 23, 2026
@wscurran

Copy link
Copy Markdown
Contributor

✨ Thanks for the proposed fix correcting the OpenClaw runtime source of truth path from /opt/nemoclaw/openclaw.json to /sandbox/.openclaw/openclaw.json in the Runtime Controls documentation. This proposes a way to fix the documented config location and adds a regression test asserting the corrected OpenClaw and Hermes paths.

@harjothkhara

Copy link
Copy Markdown
Contributor Author

Closing this as superseded. The fix here — correcting the OpenClaw in-sandbox source-of-truth path from /opt/nemoclaw/openclaw.json to /sandbox/.openclaw/openclaw.json — already landed on main via #5874 (fix(sandbox): add host-mediated gateway restart), which rewrote this section of docs/manage-sandboxes/runtime-controls.mdx and applied the corrected path. The old path no longer appears anywhere under docs/, so the documentation change is a no-op against current main. Thanks for flagging it — glad the correct path is now in place. 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build bug-fix PR fixes a bug or regression integration: openclaw OpenClaw integration behavior

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants