Skip to content

docs: catch up documentation for v0.0.11 changes and add docs-skip - #1719

Merged
miyoungc merged 1 commit into
mainfrom
docs/refresh-0.0.11
Apr 10, 2026
Merged

docs: catch up documentation for v0.0.11 changes and add docs-skip#1719
miyoungc merged 1 commit into
mainfrom
docs/refresh-0.0.11

Conversation

@miyoungc

@miyoungc miyoungc commented Apr 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

Test plan

  • make docs builds without warnings
  • All pre-commit and pre-push hooks pass
  • Skip-term scan passes (zero violations in branch diff)
  • Verify rendered pages in docs site preview

🤖 Generated with Claude Code

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.

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>
@coderabbitai

coderabbitai Bot commented Apr 10, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Introduces 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 brave/brew, refines github/huggingface/npm/pypi) across skill and documentation files.

Changes

Cohort / File(s) Summary
Documentation Skip List Infrastructure
docs/.docs-skip, .agents/skills/nemoclaw-contributor-update-docs/SKILL.md
Introduces new skip-list configuration file and documents new "Step 0" logic for loading skip rules (skip-features, skip-terms, skip-commits) with parsing behavior, integration into commit filtering, and skip-reasons reporting in final output.
GitHub Network Policy Restructuring
.agents/skills/nemoclaw-user-reference/references/network-policies.md, docs/reference/network-policies.md
Removes github and github_rest_api endpoint groups from baseline allowed endpoints; adds documentation note directing users to apply github preset during onboarding instead.
Policy Presets Standardization
.agents/skills/nemoclaw-user-configure-security/references/best-practices.md, .agents/skills/nemoclaw-user-manage-policy/SKILL.md, docs/network-policy/customize-network-policy.md, docs/security/best-practices.md
Updates preset catalog consistently across all files: adds brave and brew presets; adds/refines github preset; splits huggingface into "download-only" and "inference router" responsibilities; restricts npm and pypi to GET-only (with HEAD for pypi) blocking publishing; updates binary-scoped endpoint example to use github preset reference.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 A skip-list so clever, presets that align,
GitHub takes wing from baseline's design,
Brave, brew, and polish—the catalog grows,
Where policies preset, the governance flows! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: documentation updates for v0.0.11 compatibility and addition of a docs-skip feature for filtering documentation generation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refresh-0.0.11

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json is the actual source of truth. Consider clarifying whether the skill should:

  1. Read ci/platform-matrix.json directly, or
  2. 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

📥 Commits

Reviewing files that changed from the base of the PR and between cde928e and fdf547a.

📒 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.md
  • docs/.docs-skip
  • docs/network-policy/customize-network-policy.md
  • docs/reference/network-policies.md
  • docs/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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Remove reference to skip-commits — not defined or parsed.

Line 55 mentions excluding commits whose short hash appears in skip-commits, but:

  1. The .docs-skip file does not define a skip-commits: section
  2. Step 0 parsing instructions (lines 29-34) only parse skip-features and skip-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.

Suggested change
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.

Comment thread docs/.docs-skip
Comment on lines +30 to +37
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"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Search for any other references to skip-commits in the codebase
rg -n "skip-commits" --type md

Repository: 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-skip

Repository: 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.md

Repository: 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.md

Repository: 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-skip

Repository: 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.md

Repository: 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.md

Repository: 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.md

Repository: 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:

  1. The parsing instructions (lines 29–32) document only skip-features: and skip-terms:
  2. The docs/.docs-skip file contains no skip-commits: section
  3. No skip-commits references 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.

@miyoungc
miyoungc merged commit 9075e68 into main Apr 10, 2026
15 checks passed
ericksoa pushed a commit to cheese-head/NemoClaw that referenced this pull request Apr 14, 2026
…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>
gemini2026 pushed a commit to gemini2026/NemoClaw that referenced this pull request Apr 14, 2026
…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>
@miyoungc
miyoungc deleted the docs/refresh-0.0.11 branch May 27, 2026 20:52
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants