docs(reference): document remote-deploy env vars (closes #3059)#4166
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
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 (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a "Remote Deployment" Environment Variables subsection (mirrored to the generated CLI skill reference) documenting NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU, NEMOCLAW_DEPLOY_NO_CONNECT, and NEMOCLAW_DEPLOY_NO_START_SERVICES used by remote deploy/onboard flows. ChangesNemoClaw CLI Reference & Generated Skill Reference
Sequence Diagram(s)sequenceDiagram
participant CLI_Reference as "docs/reference/commands.mdx"
participant Skill_Reference as ".agents/skills/nemoclaw-user-reference/references/commands.md"
CLI_Reference->>Skill_Reference: mirror Remote Deployment subsection
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
✨ Thanks for submitting this detailed PR about documenting remote-deploy environment variables. This proposes a way to improve the documentation by adding a 'Remote Deployment' subsection under Environment Variables in Related open PRs:
Related open issues: |
latenighthackathon
force-pushed
the
docs/3349-remote-deploy-env-vars-v2
branch
3 times, most recently
from
35c265e to
a64fad7
Compare
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
latenighthackathon
force-pushed
the
docs/3349-remote-deploy-env-vars-v2
branch
from
a64fad7 to
f6ae703
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 1469: The text referencing "Deploy to Remote GPU" should be turned into
an explicit markdown link so readers can click from the env-var table; update
the line that mentions NEMOCLAW_BREV_PROVIDER and NEMOCLAW_GPU to use a markdown
link (e.g., [Deploy to Remote GPU](`#deploy-to-remote-gpu`) or the correct section
anchor) pointing to the "Deploy to Remote GPU" section, ensuring the link target
matches the actual heading ID in the document.
🪄 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: 8cad4f48-d4cc-495b-b39a-3bff88c4607a
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-reference/references/commands.mddocs/reference/commands.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/reference/commands.mdx
|
|
||
| These variables seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`, which provision a sandbox on a Brev instance. | ||
| Each has a flag equivalent on `deploy`; the env var lets non-interactive runs skip the prompt. | ||
| For narrative how-to coverage of `NEMOCLAW_BREV_PROVIDER` and `NEMOCLAW_GPU`, see Deploy to Remote GPU. |
There was a problem hiding this comment.
Make the “Deploy to Remote GPU” cross-reference clickable.
This line reads as plain text in the generated mirror, so readers can’t navigate directly from the env-var table context. Please render it as an explicit markdown link to the corresponding section.
🤖 Prompt for 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.
In @.agents/skills/nemoclaw-user-reference/references/commands.md at line 1469,
The text referencing "Deploy to Remote GPU" should be turned into an explicit
markdown link so readers can click from the env-var table; update the line that
mentions NEMOCLAW_BREV_PROVIDER and NEMOCLAW_GPU to use a markdown link (e.g.,
[Deploy to Remote GPU](`#deploy-to-remote-gpu`) or the correct section anchor)
pointing to the "Deploy to Remote GPU" section, ensuring the link target matches
the actual heading ID in the document.
…oy-env-vars-v2 # Conflicts: # .agents/skills/nemoclaw-user-reference/references/commands.md
wscurran
added
area: docs
3 participants
Summary
Add a "Remote Deployment" subsection under Environment Variables in
docs/reference/commands.mdxcovering the four env vars that seed defaults fornemoclaw deployandnemoclaw onboard --remote.Related Issue
Closes #3059.
Problem
The env-var reference table lists
NEMOCLAW_*flag defaults for many existing commands but omits the remote-deploy path. Discovering the seed-value env vars for a non-interactive Brev deployment currently requires reading source, since the docs say nothing about them.Changes
### Remote Deploymentsubsection just before## NemoHermes AliasdocumentingNEMOCLAW_BREV_PROVIDER(defaultgcp),NEMOCLAW_GPU(defaulta2-highgpu-1g:nvidia-tesla-a100:1),NEMOCLAW_DEPLOY_NO_CONNECT(unset;1skips post-deploy connect), andNEMOCLAW_DEPLOY_NO_START_SERVICES(unset;1skips service start).deploytake precedence so non-interactive runs can skip prompts.Deploy to Remote GPUnarrative for full how-to coverage..agents/skills/nemoclaw-user-reference/references/commands.mdviascripts/docs-to-skills.pyso the skill stays in sync with the user-facing docs.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Ran:
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-runclean;markdownlint-cli2clean on both files. All pre-commit hooks pass except the pre-existingtsc-plugininfra failure innemoclaw/src/onboard/config.tsthat is also present on stockupstream/main.Note: this is a fresh recreation of the closed #3349. The original branch was opened against the legacy
.mddocs layout before the Fern MDX migration (#3837) and accumulated 10 commits of upstream churn oncommands.mdx. Rather than rebasing across that conflict surface, this rebuilds cleanly on top of currentupstream/main(8be998680) as a single signed commit.Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit