docs: catch up documentation for v0.0.15 changes#1879
Merged
Conversation
Document tier-based policy selector, configurable port overrides, skill install command, reserved sandbox names, and bump doc versions through 0.0.15. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughThis pull request updates documentation across multiple files to introduce policy tier-based onboarding, document the new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/reference/network-policies.md (1)
109-109: Format access-mode values as inline code.Please wrap
readandread-writein inline code formatting to match the docs rule for parameter values.As per coding guidelines, “CLI commands, file paths, flags, parameter names, and values must use inline
codeformatting.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/network-policies.md` at line 109, Update the sentence that currently mentions access modes so the access-mode values are formatted as inline code: replace plain text occurrences of read and read-write in the sentence "After selecting a tier, a combined preset and access-mode screen lets you include or exclude individual presets and toggle each between read (GET only) and read-write (GET + POST/PUT/PATCH) access." with inline code formatting for `read` and `read-write`, keeping the explanatory parentheticals (GET only, GET + POST/PUT/PATCH) unchanged.docs/reference/commands.md (3)
80-97: Tone/style cleanup needed in policy-tier section.Please remove emphasis on “policy tier” and avoid the colon in “...
balanced):” before the example block; both patterns conflict with the docs style constraints.As per coding guidelines, “Unnecessary bold on routine instructions ... should be flagged (LLM pattern detected)” and “Colons should only introduce a list.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` around lines 80 - 97, Remove the bold emphasis around "policy tier" and any other unnecessary bolding in that section, and delete the colon that appears immediately before the example block (the line ending with ``balanced`):``); keep the sentence flow so the example begins on the next line, and ensure the environment variable name NEMOCLAW_POLICY_TIER and the inline example remain unchanged otherwise.
266-273: Convert this block to active voice.Several sentences are passive (for example, “is required,” “are skipped,” “are rejected,” “is refreshed”). Please switch these to active constructions for consistency with docs voice guidelines.
As per coding guidelines, “Active voice required. Flag passive constructions.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` around lines 266 - 273, Rewrite the documented sentences to use active voice: state that "The skill directory must contain a SKILL.md file with YAML frontmatter that includes a name field" as "Place a SKILL.md file in the skill directory with YAML frontmatter that includes a name field"; change "Skill names must contain only..." to "Only allow skill names containing alphanumeric characters, dots, hyphens, and underscores"; change "Files with names starting with `.` (dotfiles) are skipped and listed in the output" to "Skip and list dotfiles (names starting with `.`) in the output"; change "Files with unsafe path characters are rejected to prevent shell injection" to "Reject files that contain unsafe path characters to prevent shell injection"; and change "the agent session index is refreshed so the agent discovers the skill on the next session" to "refresh the agent session index so the agent discovers the skill on the next session" — apply these edits to the block mentioning SKILL.md, skill names, dotfiles, unsafe path characters, and agent session index.
127-127: Use active voice for reserved-name validation.This sentence is passive (“are rejected”). Please rewrite it in active voice.
As per coding guidelines, “Active voice required. Flag passive constructions.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/commands.md` at line 127, Replace the passive sentence "Names that match global CLI commands (`status`, `list`, `debug`, etc.) are rejected to avoid routing conflicts." with an active-voice construction; for example, reword it to "We reject names that match global CLI commands (e.g., `status`, `list`, `debug`) to avoid routing conflicts" or "Reject names that match global CLI commands (e.g., `status`, `list`, `debug`) to avoid routing conflicts" so the reserved-name validation is stated in active voice.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/troubleshooting.md`:
- Around line 196-197: Update the reserved-name sentence to make it explicit
that the list is non-exhaustive: either add the missing token `setup-spark` to
the enumerated list (alongside `onboard`, `list`, `deploy`, `setup`, `start`,
`stop`, `status`, `debug`, `uninstall`, `credentials`, and `help`) or change the
wording to "Reserved names include, for example, ..." (or append "such as") so
readers know more global commands may collide; modify the sentence near the
existing reserved names text accordingly.
---
Nitpick comments:
In `@docs/reference/commands.md`:
- Around line 80-97: Remove the bold emphasis around "policy tier" and any other
unnecessary bolding in that section, and delete the colon that appears
immediately before the example block (the line ending with ``balanced`):``);
keep the sentence flow so the example begins on the next line, and ensure the
environment variable name NEMOCLAW_POLICY_TIER and the inline example remain
unchanged otherwise.
- Around line 266-273: Rewrite the documented sentences to use active voice:
state that "The skill directory must contain a SKILL.md file with YAML
frontmatter that includes a name field" as "Place a SKILL.md file in the skill
directory with YAML frontmatter that includes a name field"; change "Skill names
must contain only..." to "Only allow skill names containing alphanumeric
characters, dots, hyphens, and underscores"; change "Files with names starting
with `.` (dotfiles) are skipped and listed in the output" to "Skip and list
dotfiles (names starting with `.`) in the output"; change "Files with unsafe
path characters are rejected to prevent shell injection" to "Reject files that
contain unsafe path characters to prevent shell injection"; and change "the
agent session index is refreshed so the agent discovers the skill on the next
session" to "refresh the agent session index so the agent discovers the skill on
the next session" — apply these edits to the block mentioning SKILL.md, skill
names, dotfiles, unsafe path characters, and agent session index.
- Line 127: Replace the passive sentence "Names that match global CLI commands
(`status`, `list`, `debug`, etc.) are rejected to avoid routing conflicts." with
an active-voice construction; for example, reword it to "We reject names that
match global CLI commands (e.g., `status`, `list`, `debug`) to avoid routing
conflicts" or "Reject names that match global CLI commands (e.g., `status`,
`list`, `debug`) to avoid routing conflicts" so the reserved-name validation is
stated in active voice.
In `@docs/reference/network-policies.md`:
- Line 109: Update the sentence that currently mentions access modes so the
access-mode values are formatted as inline code: replace plain text occurrences
of read and read-write in the sentence "After selecting a tier, a combined
preset and access-mode screen lets you include or exclude individual presets and
toggle each between read (GET only) and read-write (GET + POST/PUT/PATCH)
access." with inline code formatting for `read` and `read-write`, keeping the
explanatory parentheticals (GET only, GET + POST/PUT/PATCH) unchanged.
🪄 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: Pro Plus
Run ID: c2f1e908-e684-4b2c-bd9c-93ec676b9487
📒 Files selected for processing (9)
.agents/skills/nemoclaw-user-manage-policy/SKILL.md.agents/skills/nemoclaw-user-reference/references/commands.md.agents/skills/nemoclaw-user-reference/references/network-policies.md.agents/skills/nemoclaw-user-reference/references/troubleshooting.mddocs/network-policy/customize-network-policy.mddocs/reference/commands.mddocs/reference/network-policies.mddocs/reference/troubleshooting.mddocs/versions1.json
Comment on lines
+196
to
+197
| Reserved names include `onboard`, `list`, `deploy`, `setup`, `start`, `stop`, `status`, `debug`, `uninstall`, `credentials`, and `help`. | ||
| Using a reserved name would cause the CLI to route to the global command instead of the sandbox. |
Contributor
There was a problem hiding this comment.
Clarify that the reserved-name list is non-exhaustive (or include all valid command collisions).
setup-spark is also a reserved global command token, but it is missing from this list. Please either add it or explicitly label this as examples (for example, “such as ...”) so users do not treat the current list as complete.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/reference/troubleshooting.md` around lines 196 - 197, Update the
reserved-name sentence to make it explicit that the list is non-exhaustive:
either add the missing token `setup-spark` to the enumerated list (alongside
`onboard`, `list`, `deploy`, `setup`, `start`, `stop`, `status`, `debug`,
`uninstall`, `credentials`, and `help`) or change the wording to "Reserved names
include, for example, ..." (or append "such as") so readers know more global
commands may collide; modify the sentence near the existing reserved names text
accordingly.
cv
approved these changes
Apr 14, 2026
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
2 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
NEMOCLAW_GATEWAY_PORT,NEMOCLAW_DASHBOARD_PORT,NEMOCLAW_VLLM_PORT,NEMOCLAW_OLLAMA_PORT) (from feat(cli): add configurable port overrides via environment variables #1645)nemoclaw <sandbox> skill install <path>command (from feat(cli): add nemoclaw <sandbox> skill install command (#1844) #1845, fix(cli): report skipped hidden directories during skill install #1856)--dangerously-skip-permissionsfrom onboard usage synopsis (docs-skip violation)Test plan
make docsbuilds without warningspolicy-tiersanchor,environment-variablessection)🤖 Generated with Claude Code