docs(reference): document remote-deploy env vars#3349
docs(reference): document remote-deploy env vars#3349latenighthackathon wants to merge 1 commit into
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:
📝 WalkthroughWalkthroughThis PR adds a "Remote Deployment" subsection to environment variables, documenting four Brev-specific seed variables— ChangesRemote Deployment Environment Variables
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 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 to document remote-deploy env vars. This change aims to improve the accuracy of the documentation by adding a new subsection for remote deployment environment variables. Related open issues: |
6e94778 to
2c26d64
Compare
5930b8b to
96fe544
Compare
Add a `### Remote Deployment` subsection covering the four env vars read in `src/lib/deploy.ts` for the `nemoclaw deploy` / `nemoclaw onboard --remote` flow: - `NEMOCLAW_BREV_PROVIDER` (default `gcp`) - `NEMOCLAW_GPU` (default `a2-highgpu-1g:nvidia-tesla-a100:1`) - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each had a flag equivalent on `deploy` but no doc entry, so non-interactive remote provisioning users could not discover them from the docs portal. Defaults verified against `src/lib/deploy.ts:296-303`. Mirrored to the nemoclaw-user-reference skill. Follow-up to NVIDIA#3184; the env-var doc-drift gate still passes since these vars are read via a destructured `env.NEMOCLAW_*` local that the AST extractor does not currently flag. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
50938d9 to
f107870
Compare
Summary
Adds a
### Remote Deploymentsubsection to the## Environment Variablesreference, documenting the four env vars thatsrc/lib/deploy/index.tsreads for thenemoclaw deploy/nemoclaw onboard --remoteflow. Follow-up to #3184: the env-var doc gate currently passes because these vars are accessed via a destructuredenv.NEMOCLAW_*local that the AST extractor does not flag, but the same users who hit the new gate-enforced sections also hit these deploy knobs and had no doc entry to find them.Related Issue
Follow-up to #3184. Original umbrella issue #3059 was already substantively addressed by #3184; this PR closes the four remaining deploy-vars gaps from that audit.
Changes
docs/reference/commands.mdx: new### Remote Deploymentsubsection between### Lifecycle Behavior Flagsand## NemoHermes Alias. One table with four rows:NEMOCLAW_BREV_PROVIDER(defaultgcp),NEMOCLAW_GPU(defaulta2-highgpu-1g:nvidia-tesla-a100:1),NEMOCLAW_DEPLOY_NO_CONNECT,NEMOCLAW_DEPLOY_NO_START_SERVICES. Defaults verified againstsrc/lib/deploy/index.ts:295-303..agents/skills/nemoclaw-user-reference/references/commands.md: same subsection added at the corresponding position to keep the auto-generated skill in sync.Test plan
prek runcleanenv.NEMOCLAW_*reads insrc/lib/deploy/index.ts(the file moved fromsrc/lib/deploy.tstosrc/lib/deploy/index.tsupstream)Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com