Skip to content

docs(reference): correct NEMOCLAW_CONFIG_ACCEPT_NEW_PATH and document config set - #7572

Closed
harjothkhara wants to merge 2 commits into
NVIDIA:mainfrom
harjothkhara:docs/config-accept-new-path
Closed

docs(reference): correct NEMOCLAW_CONFIG_ACCEPT_NEW_PATH and document config set#7572
harjothkhara wants to merge 2 commits into
NVIDIA:mainfrom
harjothkhara:docs/config-accept-new-path

Conversation

@harjothkhara

@harjothkhara harjothkhara commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Summary

The NEMOCLAW_CONFIG_ACCEPT_NEW_PATH reference row describes behavior the variable does not have, and it sits in the wrong table. The variable gates writing a config key dotpath that does not yet exist in the sandbox config during nemoclaw <name> config set. It has nothing to do with a filesystem config path, and it does not affect onboarding. This corrects the row, moves it to the table it belongs in, and adds the missing config set reference section so the matching --config-accept-new-path flag is documented.

Related Issue

None.

Changes

  • Correct the NEMOCLAW_CONFIG_ACCEPT_NEW_PATH description in docs/reference/commands.mdx. The previous text said the variable "accepts a new sandbox config path ... when the stored path differs from the discovered one". The gate is classifyNewKeyGate in src/lib/sandbox/config.ts:425, called from configSet at src/lib/sandbox/config.ts:1164 under if (oldValue === undefined), so it gates a config key dotpath that does not already exist, not a filesystem path.
  • Move the row out of "Onboarding Behavior Flags" into "Lifecycle Behavior Flags". The only reader of the variable is configSet, which manages an existing sandbox, and the surrounding onboarding table says to set those flags before running onboard.
  • Record the exact accepted value. classifyNewKeyGate matches acceptEnv === "1" only, and test/config-set.test.ts asserts that true, yes, and empty are not accepted.
  • Add a nemoclaw <name> config set reference section next to the existing config get section under Advanced Sandbox Maintenance Commands. --config-accept-new-path previously appeared nowhere under docs/, because config set had no reference section to hold it. Flag descriptions match the oclif definitions in src/commands/sandbox/config/set.ts.

No new abstraction, configuration, fallback, or compatibility path. This documents existing shipped behavior.

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)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: Prose-only change to docs/reference/commands.mdx. No runtime behavior changes. The behavior now described correctly is already covered by the classifyNewKeyGate tests in test/config-set.test.ts.
  • 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:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: docs-updated
  • Evidence: docs/reference/commands.mdx. The reviewer checked the change against the writing rules and documentation style in docs/CONTRIBUTING.md and WRITING.md, and its findings were applied: passive voice removed from the --value and new-dotpath descriptions, one term ("dotpath") used for one concept, the URL validation sentence split, the NEMOCLAW_NON_INTERACTIVE=1 refusal case added, and the env-var Effect cell reworded to match the verb register of the surrounding rows.
  • Agent: Claude Code

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run check:diff passed when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification:
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only) — npm run docs reports Found 0 errors and 2 warnings. Both warnings are pre-existing: the same count comes back when the file is reverted to origin/main.
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

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

Summary by CodeRabbit

  • Documentation
    • Clarified configuration update rules for $$nemoclaw <name> config set, including HTTPS/URL validation, required shield state before writes, and handling of non-existent dotpaths.
    • Added documentation for --restart and --config-accept-new-path, including stricter opt-in semantics and precedence with non-interactive mode.
    • Explicitly documented refusal to write gateway/gateway.* and pointed to token-rotation guidance.
    • Updated environment variable docs with agent-scoped flags and adjusted placement/meaning of NEMOCLAW_CONFIG_ACCEPT_NEW_PATH.

… config set

The environment variable row described the variable as accepting a new
sandbox config path when the stored path differs from the discovered one.
It actually gates writing a config key dotpath that does not yet exist in
the sandbox config, and it applies only to `config set`, not onboarding.

Move the row from Onboarding Behavior Flags to Lifecycle Behavior Flags,
correct the description, and add a `config set` reference section so the
matching `--config-accept-new-path` flag is documented.

Signed-off-by: harjoth <harjoth.khara@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 26, 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 Jul 26, 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: 63b56956-bb30-4662-9f00-5855c65e94ed

📥 Commits

Reviewing files that changed from the base of the PR and between affdf34 and 472bb6d.

📒 Files selected for processing (1)
  • docs/reference/commands.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/reference/commands.mdx

📝 Walkthrough

Walkthrough

Updated command and environment-variable documentation for sandbox configuration writes, protected gateway paths, new-dotpath confirmation, lifecycle flag precedence, and OpenClaw/Hermes onboarding validation skips.

Changes

Configuration Documentation

Layer / File(s) Summary
Config set behavior
docs/reference/commands.mdx
Documents URL validation, shield requirements, restart and confirmation flags, protected gateway paths, and interactive handling of new dotpaths.
Lifecycle and agent flags
docs/reference/commands.mdx
Moves NEMOCLAW_CONFIG_ACCEPT_NEW_PATH to lifecycle flags with strict precedence rules and adds Telegram and Slack onboarding skip flags.

Estimated code review effort: 2 (Simple) | ~5–15 minutes

🚥 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 clearly reflects the doc-only update to NEMOCLAW_CONFIG_ACCEPT_NEW_PATH and the new config set documentation.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions

github-actions Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings reported

Advisor assessment: No blocking advisor findings reported
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions

Model lanes

  • GPT-5.6 Terra (primary): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Model comparison: normalized findings match; normalized E2E selections differ; severity counts match.

Nemotron output stays in workflow artifacts and does not change the assessment above.

E2E guidance

Advisory only. E2E / PR Gate selects and runs jobs independently.

Recommended E2E: None

1 optional E2E recommendation
  • docs-validation

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 `@docs/reference/commands.mdx`:
- Line 3856: Update the NEMOCLAW_CONFIG_ACCEPT_NEW_PATH documentation to
describe the accepted value as the code-formatted string "1", replacing the
unquoted numeric wording while preserving the existing strict opt-in behavior.
🪄 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: 363919b4-5ec6-4153-800b-88c975f83246

📥 Commits

Reviewing files that changed from the base of the PR and between d525e15 and affdf34.

📒 Files selected for processing (1)
  • docs/reference/commands.mdx

Comment thread docs/reference/commands.mdx Outdated
…alue

Address CodeRabbit review feedback on NVIDIA#7572. The gate compares the raw
environment string, so document the accepted value as "1".

Signed-off-by: harjoth <harjoth.khara@gmail.com>
@harjothkhara

Copy link
Copy Markdown
Contributor Author

Superseded by #7565, which now carries this docs change alongside the code fix it documents.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant