docs: catch up documentation for v0.0.11 changes and add docs-skip - #1719
Conversation
Update docs for user-facing changes since v0.0.10: remove github from baseline network policy (now opt-in preset), add github/brave/brew to preset tables, update huggingface/npm/pypi descriptions for tightened HTTP rules, and fix binary-scoping example. Add docs/.docs-skip exclusion file and update the contributor update-docs skill with skip-features, skip-terms, and agent matrix filtering to prevent documenting experimental or unreleased features. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughIntroduces a documentation skip-list mechanism for excluding commits and terms from automated doc generation, relocates GitHub network endpoints from baseline policy to a dedicated preset, and synchronizes policy preset definitions (adds Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 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 unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/reference/network-policies.md (1)
90-94: Use active voice in the note.Line 91 uses a passive construction: "is not included in the baseline policy."
✍️ Suggested revision
:::{note} -GitHub access (`github.com`, `api.github.com`) is not included in the baseline policy. +The baseline policy does not include GitHub access (`github.com`, `api.github.com`). Apply the `github` preset during onboarding if your agent needs GitHub access. See [Customize the Network Policy](../network-policy/customize-network-policy.md). :::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/network-policies.md` around lines 90 - 94, The note using the phrase "GitHub access (`github.com`, `api.github.com`) is not included in the baseline policy." uses passive voice; update that sentence to active voice (e.g., "The baseline policy does not include GitHub access (`github.com`, `api.github.com`).") within the same note block so the meaning and links remain unchanged; ensure the surrounding guidance (apply the `github` preset...) stays intact and grammatical..agents/skills/nemoclaw-contributor-update-docs/SKILL.md (1)
56-56: Clarify the agent support matrix source.The instruction references "the tested agent support matrix in the quickstart or platform docs" but the relevant code snippet shows that
ci/platform-matrix.jsonis the actual source of truth. Consider clarifying whether the skill should:
- Read
ci/platform-matrix.jsondirectly, or- Look for the matrix in generated documentation pages
📝 Proposed clarification
-5. **Agent support matrix**: Do not document agent support (e.g., Claude Code, OpenHands, Goose) unless the agent is listed in the tested agent support matrix in the quickstart or platform docs. Commits that add or modify agent integration code should only produce doc updates for agents already in the matrix. Report excluded agents under "Skipped (not in agent matrix)" in the summary. +5. **Agent support matrix**: Do not document agent support (e.g., Claude Code, OpenHands, Goose) unless the agent is listed in the tested agent support matrix (`ci/platform-matrix.json` or the derived tables in quickstart/platform docs). Commits that add or modify agent integration code should only produce doc updates for agents already in the matrix. Report excluded agents under "Skipped (not in agent matrix)" in the summary.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/nemoclaw-contributor-update-docs/SKILL.md at line 56, Update the "Agent support matrix" guidance in SKILL.md to explicitly reference ci/platform-matrix.json as the source of truth and instruct contributors to use that file (not generated docs) when determining which agents are in-scope; mention that skills should only document agents listed in ci/platform-matrix.json and that excluded agents must be reported under "Skipped (not in agent matrix)" in the summary. Ensure the language in SKILL.md replaces ambiguous phrases like "tested agent support matrix in the quickstart or platform docs" with a clear statement pointing to ci/platform-matrix.json and a short note about optionally checking generated documentation only for human-readable confirmation.
🤖 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-contributor-update-docs/SKILL.md:
- Line 55: The SKILL.md instructions reference a non-existent "skip-commits"
setting causing a mismatch with the parser; remove the mention of skip-commits
from the Skip list sentence in SKILL.md and update the sentence to only
reference the actually parsed skip-features and skip-terms (and noting that
.docs-skip does not define skip-commits), so all documentation aligns with the
parsing rules that handle skip-features and skip-terms.
In `@docs/.docs-skip`:
- Around line 30-37: The SKILL.md refers to a skip-commits list but
docs/.docs-skip only documents skip-features and skip-terms, so either add a
skip-commits section to docs/.docs-skip (with format guidance: a top-level
"skip-commits:" YAML list of short commit hashes, and update the parsing
instructions near the block that currently shows lines 29–32 to include
skip-commits) or remove the skip-commits reference from
./.agents/skills/nemoclaw-contributor-update-docs/SKILL.md (the line that
instructs excluding commits whose short hash appears in skip-commits); choose
one action and update the corresponding documentation and parsing note so the
SKILL and docs stay consistent.
---
Nitpick comments:
In @.agents/skills/nemoclaw-contributor-update-docs/SKILL.md:
- Line 56: Update the "Agent support matrix" guidance in SKILL.md to explicitly
reference ci/platform-matrix.json as the source of truth and instruct
contributors to use that file (not generated docs) when determining which agents
are in-scope; mention that skills should only document agents listed in
ci/platform-matrix.json and that excluded agents must be reported under "Skipped
(not in agent matrix)" in the summary. Ensure the language in SKILL.md replaces
ambiguous phrases like "tested agent support matrix in the quickstart or
platform docs" with a clear statement pointing to ci/platform-matrix.json and a
short note about optionally checking generated documentation only for
human-readable confirmation.
In `@docs/reference/network-policies.md`:
- Around line 90-94: The note using the phrase "GitHub access (`github.com`,
`api.github.com`) is not included in the baseline policy." uses passive voice;
update that sentence to active voice (e.g., "The baseline policy does not
include GitHub access (`github.com`, `api.github.com`).") within the same note
block so the meaning and links remain unchanged; ensure the surrounding guidance
(apply the `github` preset...) stays intact and grammatical.
🪄 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
Run ID: 5273c88e-727c-4b77-8975-d9383b280dda
📒 Files selected for processing (8)
.agents/skills/nemoclaw-contributor-update-docs/SKILL.md.agents/skills/nemoclaw-user-configure-security/references/best-practices.md.agents/skills/nemoclaw-user-manage-policy/SKILL.md.agents/skills/nemoclaw-user-reference/references/network-policies.mddocs/.docs-skipdocs/network-policy/customize-network-policy.mddocs/reference/network-policies.mddocs/security/best-practices.md
| 1. **Commit type**: `feat`, `fix`, `refactor`, `perf` commits often change behavior. `docs` commits are already doc changes. `chore`, `ci`, `test` commits rarely need doc updates. | ||
| 2. **Files changed**: Changes to `nemoclaw/src/`, `nemoclaw-blueprint/`, `bin/`, `scripts/`, or policy-related code are high-signal. | ||
| 3. **Ignore**: Changes limited to `test/`, `.github/`, or internal-only modules. | ||
| 4. **Skip list**: Exclude any commit whose short hash appears in `skip-commits`, or whose commit message or changed file paths contain a `skip-features` substring. Report skipped commits in the final summary under a "Skipped (docs-skip)" heading. |
There was a problem hiding this comment.
Remove reference to skip-commits — not defined or parsed.
Line 55 mentions excluding commits whose short hash appears in skip-commits, but:
- The
.docs-skipfile does not define askip-commits:section - Step 0 parsing instructions (lines 29-34) only parse
skip-featuresandskip-terms
This creates an inconsistency where the skill instructions reference a feature that isn't implemented.
📝 Proposed fix to remove skip-commits reference
-4. **Skip list**: Exclude any commit whose short hash appears in `skip-commits`, or whose commit message or changed file paths contain a `skip-features` substring. Report skipped commits in the final summary under a "Skipped (docs-skip)" heading.
+4. **Skip list**: Exclude any commit whose commit message or changed file paths contain a `skip-features` substring. Report skipped commits in the final summary under a "Skipped (docs-skip)" heading.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 4. **Skip list**: Exclude any commit whose short hash appears in `skip-commits`, or whose commit message or changed file paths contain a `skip-features` substring. Report skipped commits in the final summary under a "Skipped (docs-skip)" heading. | |
| 4. **Skip list**: Exclude any commit whose commit message or changed file paths contain a `skip-features` substring. Report skipped commits in the final summary under a "Skipped (docs-skip)" heading. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.agents/skills/nemoclaw-contributor-update-docs/SKILL.md at line 55, The
SKILL.md instructions reference a non-existent "skip-commits" setting causing a
mismatch with the parser; remove the mention of skip-commits from the Skip list
sentence in SKILL.md and update the sentence to only reference the actually
parsed skip-features and skip-terms (and noting that .docs-skip does not define
skip-commits), so all documentation aligns with the parsing rules that handle
skip-features and skip-terms.
| skip-features: | ||
| - "--dangerously-skip-permissions" # experimental flag, pending UX review | ||
| - "openclaw-sandbox-permissive.yaml" # permissive policy file, same feature | ||
|
|
||
| skip-terms: | ||
| - "dangerously-skip-permissions" # do not mention this flag anywhere in docs | ||
| - "permissive mode" # do not reference this concept in docs | ||
| - "Hermes" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for any other references to skip-commits in the codebase
rg -n "skip-commits" --type mdRepository: NVIDIA/NemoClaw
Length of output: 41
🏁 Script executed:
# Find SKILL.md and check its content
fd -t f "SKILL.md" || fd -t f "skill.md"Repository: NVIDIA/NemoClaw
Length of output: 144
🏁 Script executed:
# Check the docs/.docs-skip file
cat -n docs/.docs-skipRepository: NVIDIA/NemoClaw
Length of output: 1910
🏁 Script executed:
# Check the found SKILL.md file and get line count
wc -l test/e2e/e2e-cloud-experimental/features/skill/fixtures/skill-smoke-template.SKILL.mdRepository: NVIDIA/NemoClaw
Length of output: 147
🏁 Script executed:
# Display lines around line 55 of the found SKILL.md (if it's long enough)
sed -n '50,60p' test/e2e/e2e-cloud-experimental/features/skill/fixtures/skill-smoke-template.SKILL.mdRepository: NVIDIA/NemoClaw
Length of output: 41
🏁 Script executed:
# Search for all SKILL.md files to see if there are other documentation files
fd -t f "SKILL.md" -o "skill.md"Repository: NVIDIA/NemoClaw
Length of output: 194
🏁 Script executed:
# Get complete line count of docs/.docs-skip
wc -l docs/.docs-skipRepository: NVIDIA/NemoClaw
Length of output: 77
🏁 Script executed:
# Search for all SKILL.md files without the syntax error
find . -name "*SKILL.md" -o -name "*skill.md"Repository: NVIDIA/NemoClaw
Length of output: 1139
🏁 Script executed:
# Search for skip-commits in ALL file types (not just markdown)
rg -n "skip-commits"Repository: NVIDIA/NemoClaw
Length of output: 41
🏁 Script executed:
# List files in docs directory
ls -la docs/Repository: NVIDIA/NemoClaw
Length of output: 1264
🏁 Script executed:
# Check the nemoclaw-contributor-update-docs SKILL.md file
wc -l ./.agents/skills/nemoclaw-contributor-update-docs/SKILL.mdRepository: NVIDIA/NemoClaw
Length of output: 121
🏁 Script executed:
# Get content around the claimed line 55
sed -n '50,60p' ./.agents/skills/nemoclaw-contributor-update-docs/SKILL.mdRepository: NVIDIA/NemoClaw
Length of output: 1355
🏁 Script executed:
# Show the full content to understand the file structure
cat -n ./.agents/skills/nemoclaw-contributor-update-docs/SKILL.mdRepository: NVIDIA/NemoClaw
Length of output: 10585
Add skip-commits: section to docs/.docs-skip or remove the reference from SKILL.md.
Line 55 of ./.agents/skills/nemoclaw-contributor-update-docs/SKILL.md instructs the skill to exclude commits whose short hash appears in a skip-commits section, but:
- The parsing instructions (lines 29–32) document only
skip-features:andskip-terms: - The
docs/.docs-skipfile contains noskip-commits:section - No
skip-commitsreferences exist elsewhere in the codebase
Either add a skip-commits: section to docs/.docs-skip with format instructions, or remove the skip-commits reference from SKILL.md line 55 to align the skill implementation with the actual skip-list format.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/.docs-skip` around lines 30 - 37, The SKILL.md refers to a skip-commits
list but docs/.docs-skip only documents skip-features and skip-terms, so either
add a skip-commits section to docs/.docs-skip (with format guidance: a top-level
"skip-commits:" YAML list of short commit hashes, and update the parsing
instructions near the block that currently shows lines 29–32 to include
skip-commits) or remove the skip-commits reference from
./.agents/skills/nemoclaw-contributor-update-docs/SKILL.md (the line that
instructs excluding commits whose short hash appears in skip-commits); choose
one action and update the corresponding documentation and parsing note so the
SKILL and docs stay consistent.
…VIDIA#1719) ## Summary - Remove `github` and `github_rest_api` from baseline network policy docs (now opt-in preset, NVIDIA#1660) - Add `github` preset to presets tables in customize-network-policy.md and best-practices.md - Add `brave` and `brew` presets to best-practices.md - Update `huggingface` description (download-only + inference router, NVIDIA#1663) - Update `npm` and `pypi` descriptions (GET-only, publishing blocked, NVIDIA#1672) - Fix binary-scoping example to reference `github` as a preset, not baseline - Add `docs/.docs-skip` exclusion file for suppressing docs on experimental/unreleased features - Update `nemoclaw-contributor-update-docs` skill with skip-features, skip-terms, and agent matrix filtering rules - Regenerate `nemoclaw-user-*` skills from updated docs ## Test plan - [x] `make docs` builds without warnings - [x] All pre-commit and pre-push hooks pass - [x] Skip-term scan passes (zero violations in branch diff) - [ ] Verify rendered pages in docs site preview 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Introduced skip-list configuration for controlling documentation generation based on commit patterns and excluded terminology. * **Documentation** * Updated network policy presets with new `github`, `brave`, and `brew` options. * Refined preset descriptions for `huggingface`, `npm`, and `pypi` to clarify access scopes. * Clarified that GitHub access is no longer baseline and requires applying the `github` preset during onboarding. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…VIDIA#1719) ## Summary - Remove `github` and `github_rest_api` from baseline network policy docs (now opt-in preset, NVIDIA#1660) - Add `github` preset to presets tables in customize-network-policy.md and best-practices.md - Add `brave` and `brew` presets to best-practices.md - Update `huggingface` description (download-only + inference router, NVIDIA#1663) - Update `npm` and `pypi` descriptions (GET-only, publishing blocked, NVIDIA#1672) - Fix binary-scoping example to reference `github` as a preset, not baseline - Add `docs/.docs-skip` exclusion file for suppressing docs on experimental/unreleased features - Update `nemoclaw-contributor-update-docs` skill with skip-features, skip-terms, and agent matrix filtering rules - Regenerate `nemoclaw-user-*` skills from updated docs ## Test plan - [x] `make docs` builds without warnings - [x] All pre-commit and pre-push hooks pass - [x] Skip-term scan passes (zero violations in branch diff) - [ ] Verify rendered pages in docs site preview 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Introduced skip-list configuration for controlling documentation generation based on commit patterns and excluded terminology. * **Documentation** * Updated network policy presets with new `github`, `brave`, and `brew` options. * Refined preset descriptions for `huggingface`, `npm`, and `pypi` to clarify access scopes. * Clarified that GitHub access is no longer baseline and requires applying the `github` preset during onboarding. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
githubandgithub_rest_apifrom baseline network policy docs (now opt-in preset, fix(security): gate GitHub access behind an opt-in policy preset (#1583) #1660)githubpreset to presets tables in customize-network-policy.md and best-practices.mdbraveandbrewpresets to best-practices.mdhuggingfacedescription (download-only + inference router, fix(security): drop POST allow rule from huggingface preset (#1432) #1663)npmandpypidescriptions (GET-only, publishing blocked, fix(policy): restrict npm and PyPI presets to GET-only REST rules #1672)githubas a preset, not baselinedocs/.docs-skipexclusion file for suppressing docs on experimental/unreleased featuresnemoclaw-contributor-update-docsskill with skip-features, skip-terms, and agent matrix filtering rulesnemoclaw-user-*skills from updated docsTest plan
make docsbuilds without warnings🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation
github,brave, andbrewoptions.huggingface,npm, andpypito clarify access scopes.githubpreset during onboarding.