Docs(network policy) enhance user manage policy#1981
Docs(network policy) enhance user manage policy#1981vl43den wants to merge 3 commits intoNVIDIA:mainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation updates to policy management: require a Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/network-policy/customize-network-policy.md (1)
115-130: Use periods instead of colons in these prose lead-ins.Lines 115, 123, and 129 use colons as general punctuation rather than list introduction; this conflicts with the docs style rule.
As per coding guidelines, "Colons should only introduce a list. Flag colons used as general punctuation between clauses."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/network-policy/customize-network-policy.md` around lines 115 - 130, Replace the lead-in colons (and the semicolon used as clause punctuation) with periods in the prose lines that introduce the examples and notes: change "To apply a preset to a running sandbox:", "Note that preset selection is an interactive prompt; any positional arguments for presets are ignored.", and "To list which presets are applied to a sandbox:" to use periods instead of colons/semicolons, then capitalize the following sentence fragments as needed so each becomes a standalone sentence; locate these exact phrases in customize-network-policy.md and make the punctuation and capitalization edits accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/network-policy/customize-network-policy.md`:
- Around line 115-130: Replace the lead-in colons (and the semicolon used as
clause punctuation) with periods in the prose lines that introduce the examples
and notes: change "To apply a preset to a running sandbox:", "Note that preset
selection is an interactive prompt; any positional arguments for presets are
ignored.", and "To list which presets are applied to a sandbox:" to use periods
instead of colons/semicolons, then capitalize the following sentence fragments
as needed so each becomes a standalone sentence; locate these exact phrases in
customize-network-policy.md and make the punctuation and capitalization edits
accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 2873995d-03a6-4483-9c12-bf9e45649aa5
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-manage-policy/SKILL.mddocs/network-policy/customize-network-policy.md
Updated the SKILL.md documentation to clarify steps and improve formatting.
vl43den
force-pushed
the
docs(network-policy)-enhance-user-manage-policy
branch
from
00c46f9 to
07bd938
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/network-policy/customize-network-policy.md (1)
174-176: Split the note into one sentence per source line.Line 175 currently continues one sentence and starts another on the same source line; please keep exactly one sentence per line in docs source.
As per coding guidelines, "One sentence per line in source (makes diffs readable)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/network-policy/customize-network-policy.md` around lines 174 - 176, Split the note that describes command usage so each sentence sits on its own source line: break the current line that contains both "The `openshell policy set --policy <file> <sandbox-name>` command operates on raw policy files and does not accept the `preset:` metadata block used in preset YAML files." and "Use `nemoclaw <name> policy-add` for presets." into two separate lines, keeping the exact wording for the first sentence (about openshell) on one line and the second sentence (about using `nemoclaw <name> policy-add`) on the next line so the docs follow the one-sentence-per-line guideline.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/skills/nemoclaw-user-manage-policy/SKILL.md:
- Around line 198-199: Add a single blank line after the "## Related Skills"
heading in SKILL.md so the heading is followed by an empty line before the list
item `- `nemoclaw-user-reference` — Network Policies...`; edit the section
containing the heading "## Related Skills" to insert one newline between the
heading and the list.
---
Nitpick comments:
In `@docs/network-policy/customize-network-policy.md`:
- Around line 174-176: Split the note that describes command usage so each
sentence sits on its own source line: break the current line that contains both
"The `openshell policy set --policy <file> <sandbox-name>` command operates on
raw policy files and does not accept the `preset:` metadata block used in preset
YAML files." and "Use `nemoclaw <name> policy-add` for presets." into two
separate lines, keeping the exact wording for the first sentence (about
openshell) on one line and the second sentence (about using `nemoclaw <name>
policy-add`) on the next line so the docs follow the one-sentence-per-line
guideline.
🪄 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: 4f4cdd58-dd2c-4f33-93e4-bc36c37a91c4
📒 Files selected for processing (2)
.agents/skills/nemoclaw-user-manage-policy/SKILL.mddocs/network-policy/customize-network-policy.md
| ## Related Skills | ||
| - `nemoclaw-user-reference` — Network Policies for the full baseline policy reference |
There was a problem hiding this comment.
Add a blank line after the heading at Line 198.
## Related Skills should be followed by an empty line before the list to satisfy markdown heading spacing rules.
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 198-198: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.agents/skills/nemoclaw-user-manage-policy/SKILL.md around lines 198 - 199,
Add a single blank line after the "## Related Skills" heading in SKILL.md so the
heading is followed by an empty line before the list item `-
`nemoclaw-user-reference` — Network Policies...`; edit the section containing
the heading "## Related Skills" to insert one newline between the heading and
the list.
wscurran
added
documentation
|
✨ Thanks for submitting this PR that proposes documentation improvements for user-managed policy customization, which could help clarify the process for users. Possibly related open PRs: |
prekshivyas
left a comment
prekshivyas
left a comment
There was a problem hiding this comment.
Fixes misleading preset docs — interactive prompt, not positional args. CodeRabbit flagged a missing blank line after '## Related Skills' heading in SKILL.md. @vl43den can you fix that and rebase onto main?
3 participants
Summary
This PR isolates the relevant documentation improvements from PR #1036 and applies them against the current file paths on
main. It fixes inaccurate positional arguments in the preset commands documentation and clarifies dynamic custom policy requirements, directly resolving @prekshivyas feedback.Related Issue
Follow-up action to #1036
Changes
<preset>argument onnemoclaw <name> policy-addexamples incustomize-network-policy.md.nemoclaw <name> policy-addinitiates an interactive prompt where positional preset arguments are ignored.version: 1requirement for custom dynamic YAML policies within thenemoclaw-user-manage-policyskill.openshell policy set --policyoperates on raw policy files and does not acceptpreset:metadata blocks.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)AI Disclosure
Signed-off-by: Vladan Sekulic is231338@fhstp.ac.at
Summary by CodeRabbit
nemoclaw <name> policy-addto apply presets andnemoclaw <name> policy-listto view applied presets.versionfield (e.g.,version: 1) for compatibility with OpenShell.openshell policy set --policy <file> <sandbox>accepts raw policy files only (not preset YAML withpreset:).