Skip to content

docs: remove local flag from sandbox inference examples#3892

Open
glenn-agent wants to merge 1 commit into
NVIDIA:mainfrom
glenn-agent:docs/remove-local-agent-flag
Open

docs: remove local flag from sandbox inference examples#3892
glenn-agent wants to merge 1 commit into
NVIDIA:mainfrom
glenn-agent:docs/remove-local-agent-flag

Conversation

@glenn-agent
Copy link
Copy Markdown

@glenn-agent glenn-agent commented May 20, 2026

Summary

  • Remove --local from sandbox inference verification examples.
  • Keep the examples on the gateway-managed inference route that works inside NemoClaw sandboxes.

Related Issue

Fixes #3692.

Changes

  • Updated docs/deployment/deploy-to-remote-gpu.mdx.
  • Updated docs/monitoring/monitor-sandbox-activity.mdx.

Verification

  • npm run docs:strict
  • Verified the updated openclaw agent --agent main ... form inside a NemoClaw sandbox and confirmed it returns successfully without --local.

Type of Change

  • Bug fix
  • Documentation update
  • New feature
  • Breaking change
  • Tests
  • Other

Signed-off-by: Glenn-Agent glenn_agent@163.com

Summary by CodeRabbit

  • Documentation
    • Updated example commands in deployment and monitoring guides to reflect proper execution patterns for inference operations in remote sandbox environments.

Review Change Stack

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 20, 2026

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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2026

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: 9bbaaadc-3e5b-4f21-b110-255be7f33933

📥 Commits

Reviewing files that changed from the base of the PR and between cd8e2f0 and 2374df5.

📒 Files selected for processing (2)
  • docs/deployment/deploy-to-remote-gpu.mdx
  • docs/monitoring/monitor-sandbox-activity.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/deployment/deploy-to-remote-gpu.mdx
  • docs/monitoring/monitor-sandbox-activity.mdx

📝 Walkthrough

Walkthrough

Two documentation pages remove the sandbox-blocked --local flag from their openclaw agent example commands; --agent, -m, and --session-id usage is unchanged.

Changes

Documentation Examples - OpenClaw Agent Invocations

Layer / File(s) Summary
Remove --local flag from sandbox example commands
docs/deployment/deploy-to-remote-gpu.mdx, docs/monitoring/monitor-sandbox-activity.mdx
"Verify Inference" and "Test Inference" examples are updated to run openclaw agent without the --local flag; agent selection, model string, and session-id arguments remain the same.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

documentation

Suggested reviewers

  • miyoungc
  • ericksoa
  • jacobtomlinson

Poem

🐰 I hopped through docs with nimble feet,
Removed the flag that caused defeat,
Sandbox-safe the command now reads,
No crashes, errors, or misdeeds,
Happy users, tidy suite.

🚥 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 and concisely summarizes the main change: removing the --local flag from sandbox inference examples in documentation.
Linked Issues check ✅ Passed The PR fully addresses issue #3692 by removing the --local flag from both affected documentation files (deploy-to-remote-gpu.mdx and monitor-sandbox-activity.mdx) as required.
Out of Scope Changes check ✅ Passed All changes are scoped to the two documentation files specified in issue #3692; other affected files mentioned in the issue are correctly noted as out of scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

Signed-off-by: Glenn-Agent <glenn_agent@163.com>
@glenn-agent glenn-agent force-pushed the docs/remove-local-agent-flag branch from cd8e2f0 to 2374df5 Compare May 20, 2026 12:53
@glenn-agent glenn-agent changed the title doc: remove local flag from sandbox inference examples docs: remove local flag from sandbox inference examples May 20, 2026
@wscurran wscurran added documentation Improvements or additions to documentation fix labels May 20, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR about removing the local flag from sandbox inference examples. This PR proposes a way to update the documentation examples to reflect proper execution patterns for inference operations in remote sandbox environments.


Related open issues:

1 similar comment
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR about removing the local flag from sandbox inference examples. This PR proposes a way to update the documentation examples to reflect proper execution patterns for inference operations in remote sandbox environments.


Related open issues:

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

Labels

documentation Improvements or additions to documentation fix

Projects

None yet

2 participants