docs(reference): add a complete environment-variable index to the commands reference (#3059)#4170
Open
latenighthackathon wants to merge 1 commit into
Open
Conversation
3 tasks
Contributor
|
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:
📝 WalkthroughWalkthroughClarifies that ChangesNemoClaw Command Reference and Environment Variables Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
.agents/skills/nemoclaw-user-reference/references/commands.md (2)
976-976: 💤 Low valuePrefer active voice.
The sentence uses passive constructions "is not started" and "is configured." Rewrite using active voice.
Suggested revision: "Channel messaging (Telegram, Discord, Slack) does not start here;
nemoclaw onboardconfigures it and OpenShell-managed constructs run it."As per coding guidelines, active voice is required and passive constructions should be flagged.
🤖 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 976, Rewrite the passive sentence in the commands.md entry to active voice: replace "Channel messaging (Telegram, Discord, Slack) is not started here; it is configured during `nemoclaw onboard` and runs through OpenShell-managed constructs." with an active-voice variant such as "Channel messaging (Telegram, Discord, Slack) does not start here; `nemoclaw onboard` configures it and OpenShell-managed constructs run it." Update the sentence where the original passive occurs so the subject performs the actions (use `nemoclaw onboard` and OpenShell-managed constructs as the actors).
984-985: ⚡ Quick winSplit into one sentence per line.
Lines 984-985 contain two sentences on the same line. The source should have one sentence per line to make diffs readable.
Split like this:
-The named tunnel hostname and `localhost:<dashboard-port>` route must already be configured in the Cloudflare dashboard. -NemoClaw passes the token to `cloudflared` through the `TUNNEL_TOKEN` environment variable, so the token does not appear in the `cloudflared` command-line arguments. +The named tunnel hostname and `localhost:<dashboard-port>` route must already be configured in the Cloudflare dashboard. +NemoClaw passes the token to `cloudflared` through the `TUNNEL_TOKEN` environment variable, so the token does not appear in the `cloudflared` command-line arguments.As per coding guidelines, one sentence per line in source makes diffs readable.
🤖 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 around lines 984 - 985, Split the two sentences currently on the same line into separate lines so each sentence is on its own line: place "The named tunnel hostname and `localhost:<dashboard-port>` route must already be configured in the Cloudflare dashboard." on one line and "NemoClaw passes the token to `cloudflared` through the `TUNNEL_TOKEN` environment variable, so the token does not appear in the `cloudflared` command-line arguments." on the next line to follow the one-sentence-per-line guideline.
🤖 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.
Nitpick comments:
In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 976: Rewrite the passive sentence in the commands.md entry to active
voice: replace "Channel messaging (Telegram, Discord, Slack) is not started
here; it is configured during `nemoclaw onboard` and runs through
OpenShell-managed constructs." with an active-voice variant such as "Channel
messaging (Telegram, Discord, Slack) does not start here; `nemoclaw onboard`
configures it and OpenShell-managed constructs run it." Update the sentence
where the original passive occurs so the subject performs the actions (use
`nemoclaw onboard` and OpenShell-managed constructs as the actors).
- Around line 984-985: Split the two sentences currently on the same line into
separate lines so each sentence is on its own line: place "The named tunnel
hostname and `localhost:<dashboard-port>` route must already be configured in
the Cloudflare dashboard." on one line and "NemoClaw passes the token to
`cloudflared` through the `TUNNEL_TOKEN` environment variable, so the token does
not appear in the `cloudflared` command-line arguments." on the next line to
follow the one-sentence-per-line guideline.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 6dfccec4-6598-4a68-b4f4-f69e052f102b
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-reference/references/commands.mddocs/reference/commands.mdx
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.agents/skills/nemoclaw-user-reference/references/commands.md (1)
1201-1201: ⚡ Quick winMinor anchor link inconsistency in the At a Glance table.
The "Service Ports" category links to
#environment-variables, which is the parent section heading (line 1188). All other categories link to their specific subsection anchors (e.g.,#onboarding-configuration,#gateway-lifecycle-tunables).Consider adding a "### Service Ports" heading before line 1210 so this category can link to a dedicated anchor like the others, improving navigation consistency.
🤖 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 1201, The At a Glance table links "Service Ports" to the parent section anchor (`#environment-variables`) instead of a dedicated subsection; add a new subsection heading "### Service Ports" (which will generate the anchor `#service-ports`) before the block starting around line 1210 and then update the table entry to link to `#service-ports` so the table points to the specific subsection; ensure the heading text matches the table label exactly ("Service Ports") so the generated anchor is consistent.
🤖 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.
Nitpick comments:
In @.agents/skills/nemoclaw-user-reference/references/commands.md:
- Line 1201: The At a Glance table links "Service Ports" to the parent section
anchor (`#environment-variables`) instead of a dedicated subsection; add a new
subsection heading "### Service Ports" (which will generate the anchor
`#service-ports`) before the block starting around line 1210 and then update the
table entry to link to `#service-ports` so the table points to the specific
subsection; ensure the heading text matches the table label exactly ("Service
Ports") so the generated anchor is consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: bba7bf80-ae0f-496f-ae92-a3dbe6a7ff53
📒 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
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/reference/commands.mdx (1)
1220-1220: ⚡ Quick winSplit this into one sentence per source line.
Line 1220 contains two sentences on the same line, which breaks the docs source-line rule.
As per coding guidelines, “One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line.”
🤖 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 `@docs/reference/commands.mdx` at line 1220, The line that currently contains both "These variables override the TCP ports NemoClaw uses for its core services." and "Each value must be a non-privileged integer between 1024 and 65535." should be split into two source lines so each sentence stands alone; edit the paragraph containing that sentence pair (the sentence starting "These variables override the TCP ports NemoClaw uses for its core services.") and place the first sentence on its own line and the second sentence ("Each value must be a non-privileged integer between 1024 and 65535.") on the next line to comply with the one-sentence-per-source-line rule.
🤖 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.
Nitpick comments:
In `@docs/reference/commands.mdx`:
- Line 1220: The line that currently contains both "These variables override the
TCP ports NemoClaw uses for its core services." and "Each value must be a
non-privileged integer between 1024 and 65535." should be split into two source
lines so each sentence stands alone; edit the paragraph containing that sentence
pair (the sentence starting "These variables override the TCP ports NemoClaw
uses for its core services.") and place the first sentence on its own line and
the second sentence ("Each value must be a non-privileged integer between 1024
and 65535.") on the next line to comply with the one-sentence-per-source-line
rule.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d342e8ac-1a81-4507-a947-562e3fb821a5
📒 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)
- .agents/skills/nemoclaw-user-reference/references/commands.md
wscurran
added
CI/CD
Contributor
|
✨ Thanks for submitting this detailed PR about adding an env-var index and lifecycle documentation. This proposes a way to improve the documentation by adding a categorized index and refreshing the user-facing env-var surface, and it closes issue #3059. Related open PRs:
Related open issues: |
latenighthackathon
force-pushed
the
docs/3652-env-var-index-v2
branch
3 times, most recently
from
b2746ac to
5a273cd
Compare
cv
added
the
Integration: WhatsApp
latenighthackathon
force-pushed
the
docs/3652-env-var-index-v2
branch
3 times, most recently
from
86cbf98 to
451f819
Compare
latenighthackathon
changed the title
sandl99
added
the
enhancement: messaging
…mands reference (NVIDIA#3059) Add an At-a-Glance index grouping every documented NEMOCLAW_* environment variable by category, plus the gateway-lifecycle and sandbox-runtime variable tables the index links to. The section is written as current reference material rather than release-scoped notes. Closes NVIDIA#3059 Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
latenighthackathon
force-pushed
the
docs/3652-env-var-index-v2
branch
from
451f819 to
2aa8d2e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The CLI commands reference lists environment variables scattered through prose, with no single place to see what exists (#3059). This adds an At-a-Glance index to the
## Environment Variablessection that groups every documentedNEMOCLAW_*variable by category, and fills in the variable tables those categories link to: the gateway-lifecycle tuning knobs, the sandbox-runtime overrides, and a few previously-undocumented macOS VM-driver and Docker-GPU networking flags. It is written as current reference material, not release-scoped notes.Related Issue
Closes #3059
Changes
NEMOCLAW_*variable by category (service ports, onboarding configuration and flags, probe and onboard timeouts, gateway lifecycle, sandbox runtime, lifecycle flags), each linking to its detail table.NEMOCLAW_TOOL_CATALOG,NEMOCLAW_OPENCLAW_MANAGED_PROXY,NEMOCLAW_SANDBOX_BASE_VERSION_TAG,NEMOCLAW_HERMES_TOOL_GATEWAY_REFRESH_TOKEN), with each entry explaining when to set it..agents/skills/nemoclaw-user-reference/references/commands.md) viascripts/docs-to-skills.py.Type of Change
Verification
Ran
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run(clean), theNEMOCLAW_*env-var documentation gate, andmarkdownlint-cli2(clean).Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit
nemoclaw tunnel startonly starts Cloudflared/dashboard exposure and does not start messaging bridges (Telegram/Discord/Slack); those are configured via onboarding.nemoclaw resources/status and expanded messaging-channel docs (wechat, experimental whatsapp).