docs: catch up release prep for 0.0.25 by miyoungc · Pull Request #2463 · NVIDIA/NemoClaw

miyoungc · 2026-04-25T00:21:04Z

Summary

Catches up the user-facing docs for changes merged since v0.0.24 and bumps docs/versions1.json so the next docs build publishes as 0.0.25.

Changes

docs/reference/troubleshooting.md: corrected the JetPack 7 (L4T 39.x) entry to reflect the new conditional br_netfilter auto-load on R39 hosts that lack it (from fix(jetson): apply br_netfilter on JetPack R39 when missing (Fixes #2418) #2419), and added a new "DNS resolution from inside docker fails (corporate firewall)" section covering the new container-DNS preflight probe and platform-specific remediation paths (from feat(preflight): probe container DNS and surface corp-firewall workaround (#2101) #2349).
docs/get-started/quickstart.md: added a "Review the Configuration Before the Sandbox Build" subsection documenting the new [Y/n] review gate that fires after the sandbox-name prompt (from feat(onboard): add review summary + Y/n gate before destructive sandbox build #2221).
docs/versions1.json: promoted 0.0.25 to preferred: true, demoted 0.0.24, and trimmed to ten entries to match what scripts/bump-version.ts writes. docs/project.json regenerates from versions1.json at build time and now reports 0.0.25.
.agents/skills/nemoclaw-user-get-started/ and .agents/skills/nemoclaw-user-reference/: regenerated via scripts/docs-to-skills.py.

Type of Change

Code change (feature, bug fix, or refactor)
Code change with doc updates
Doc only (prose changes, no code sample modifications)
Doc only (includes code sample changes)

Verification

npx prek run --all-files passes
npm test passes
Tests added or updated for new or changed behavior
No secrets, API keys, or credentials committed
Docs updated for user-facing behavior changes
make docs builds without warnings (doc changes only)
Doc pages follow the style guide (doc changes only)
New doc pages include SPDX header and frontmatter (new pages only)

AI Disclosure

AI-assisted — tool: Claude Code

Signed-off-by: Miyoung Choi miyoungc@nvidia.com

Summary by CodeRabbit

New Features
- Onboarding now shows a configuration review and requires explicit confirmation before building a sandbox; non-interactive mode prints the summary without prompting.
Documentation
- Expanded Jetson troubleshooting for JetPack 7 / L4T 39.x and conditional br_netfilter guidance.
- Added corporate-firewall DNS troubleshooting with platform-specific remediation and a verification nslookup step.
- Quickstart updated to document the new confirmation flow.
Chores
- Documentation version index updated.

Document user-facing changes merged since v0.0.24 and bump the docs version pointer. Quickstart now describes the [Y/n] review summary that fires after the sandbox-name prompt, and troubleshooting covers the new container-DNS preflight probe with platform-specific remediation and the JetPack R39 br_netfilter auto-load behavior. versions1.json promotes 0.0.25 to preferred, demotes 0.0.24, and trims to ten entries to match scripts/bump-version.ts. Regenerated user skills under .agents/skills/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-04-25T00:21:16Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2df1d6ec-964e-40f4-aaed-b76affb901d4

📥 Commits

Reviewing files that changed from the base of the PR and between 3db4ba0 and a2b3f65.

📒 Files selected for processing (2)

.agents/skills/nemoclaw-user-get-started/SKILL.md
docs/get-started/quickstart.md

📝 Walkthrough

Walkthrough

Documentation updates: onboarding adds an explicit pre-build configuration confirmation step; Jetson/JetPack R39 troubleshooting refined for conditional br_netfilter loading; new corporate-firewall DNS troubleshooting added with platform-specific remediation; docs version bumped from 0.0.24 to 0.0.25.

Changes

Cohort / File(s)	Summary
Onboarding Confirmation Documentation `.agents/skills/nemoclaw-user-get-started/SKILL.md`, `docs/get-started/quickstart.md`	Adds explicit pre-build configuration review and `Apply this configuration? [Y/n]:` prompt after sandbox-name entry; documents Enter default, `n` abort path, and `NEMOCLAW_NON_INTERACTIVE=1` behavior.
Troubleshooting Guides `.agents/skills/nemoclaw-user-reference/references/troubleshooting.md`, `docs/reference/troubleshooting.md`	Refines Jetson (JetPack 7 / L4T 39.x) guidance to note conditional `br_netfilter` loading and specific installer log line; adds corporate-firewall DNS troubleshooting with preflight `nslookup`, platform-specific fixes (Linux systemd-resolved + Docker, macOS Colima/Docker Desktop, Windows/WSL), and verification command.
Version Management `docs/project.json`, `docs/versions1.json`	Bumps docs version from `0.0.24` to `0.0.25` and updates versions registry (adds `0.0.25` entry, removes older `0.0.15`–`0.0.9` entries).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through docs to check the flow,
A prompt appeared — "Apply?" — so off I go,
DNS and JetPack notes neatly spun,
Versions bumped and fixes done —
I nibble carrots, celebrate the run. 🥕

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main objective: documentation updates for version 0.0.25 release preparation, including configuration review steps, DNS troubleshooting, and version bumping.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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/release-prep-0.0.25

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

coderabbitai

🧹 Nitpick comments (2)

docs/reference/troubleshooting.md (1)
135-147: Use one sentence per line in the new troubleshooting prose.

Several newly added lines contain multiple sentences on one source line (for example, the JetPack 7 R39 paragraph and DNS section intro bullets), which conflicts with the docs source formatting 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 the current code and only fix it if needed.

In `@docs/reference/troubleshooting.md` around lines 135 - 147, The new prose in
the "JetPack 7 (L4T 39.x)" paragraph and the "DNS resolution from inside docker
fails (corporate firewall)" intro (including the "Linux with systemd-resolved."
bullet) contains multiple sentences on single source lines; edit those sections
in docs/reference/troubleshooting.md so each sentence is on its own line (break
the JetPack/R39 paragraph into separate lines per sentence, do the same for the
DNS intro and each bullet sentence), preserving wording and punctuation but
ensuring one sentence per line to comply with the docs source formatting rule.
docs/get-started/quickstart.md (1)
226-226: Split this into one sentence per source line.

This line has two sentences on one line, which reduces diff readability.
Suggested edit
-The default is `Y`, so you can press Enter once to continue. Answer `n` to abort cleanly, fix the entries, and re-run `nemoclaw onboard`.
+The default is `Y`, so you can press Enter once to continue.
+Answer `n` to abort cleanly, fix the entries, and re-run `nemoclaw onboard`.
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 the current code and only fix it if needed.

In `@docs/get-started/quickstart.md` at line 226, The line containing "The default
is `Y`, so you can press Enter once to continue. Answer `n` to abort cleanly,
fix the entries, and re-run `nemoclaw onboard`." has two sentences on one source
line; split it into two separate lines so each sentence is on its own line,
preserving punctuation, backticks, and the `nemoclaw onboard` command text.

🤖 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/get-started/quickstart.md`:
- Line 226: The line containing "The default is `Y`, so you can press Enter once
to continue. Answer `n` to abort cleanly, fix the entries, and re-run `nemoclaw
onboard`." has two sentences on one source line; split it into two separate
lines so each sentence is on its own line, preserving punctuation, backticks,
and the `nemoclaw onboard` command text.

In `@docs/reference/troubleshooting.md`:
- Around line 135-147: The new prose in the "JetPack 7 (L4T 39.x)" paragraph and
the "DNS resolution from inside docker fails (corporate firewall)" intro
(including the "Linux with systemd-resolved." bullet) contains multiple
sentences on single source lines; edit those sections in
docs/reference/troubleshooting.md so each sentence is on its own line (break the
JetPack/R39 paragraph into separate lines per sentence, do the same for the DNS
intro and each bullet sentence), preserving wording and punctuation but ensuring
one sentence per line to comply with the docs source formatting rule.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 88b0e8a7-b692-442e-b38c-be940dacc001

📥 Commits

Reviewing files that changed from the base of the PR and between 79c8e2a and 3db4ba0.

📒 Files selected for processing (6)

.agents/skills/nemoclaw-user-get-started/SKILL.md
.agents/skills/nemoclaw-user-reference/references/troubleshooting.md
docs/get-started/quickstart.md
docs/project.json
docs/reference/troubleshooting.md
docs/versions1.json

ericksoa

Looks good — clean doc-only PR, CI green, skills properly regenerated.

Two non-blocking nits:

troubleshooting.md L4T 39.x entry — The sentence starting "For JetPack 7 (L4T 39.x)..." is ~60 words. Consider splitting after "left untouched." for scannability.
quickstart.md review-gate example — Double-check that the nvidia-api provider label in the example matches current printReviewSummary output — recent PRs may have changed it to nvidia-prod or similar.

Neither is blocking. LGTM.

## Summary Catches up the user-facing docs for changes merged since v0.0.24 and bumps `docs/versions1.json` so the next docs build publishes as 0.0.25. ## Changes - `docs/reference/troubleshooting.md`: corrected the JetPack 7 (L4T 39.x) entry to reflect the new conditional `br_netfilter` auto-load on R39 hosts that lack it (from NVIDIA#2419), and added a new "DNS resolution from inside docker fails (corporate firewall)" section covering the new container-DNS preflight probe and platform-specific remediation paths (from NVIDIA#2349). - `docs/get-started/quickstart.md`: added a "Review the Configuration Before the Sandbox Build" subsection documenting the new `[Y/n]` review gate that fires after the sandbox-name prompt (from NVIDIA#2221). - `docs/versions1.json`: promoted 0.0.25 to `preferred: true`, demoted 0.0.24, and trimmed to ten entries to match what `scripts/bump-version.ts` writes. `docs/project.json` regenerates from `versions1.json` at build time and now reports `0.0.25`. - `.agents/skills/nemoclaw-user-get-started/` and `.agents/skills/nemoclaw-user-reference/`: regenerated via `scripts/docs-to-skills.py`. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Verification - [x] `npx prek run --all-files` passes - [x] `npm test` passes - [x] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [x] Docs updated for user-facing behavior changes - [x] `make docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) ## AI Disclosure - [x] AI-assisted — tool: Claude Code --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>  ## Summary by CodeRabbit * **New Features** * Onboarding now shows a configuration review and requires explicit confirmation before building a sandbox; non-interactive mode prints the summary without prompting. * **Documentation** * Expanded Jetson troubleshooting for JetPack 7 / L4T 39.x and conditional br_netfilter guidance. * Added corporate-firewall DNS troubleshooting with platform-specific remediation and a verification nslookup step. * Quickstart updated to document the new confirmation flow. * **Chores** * Documentation version index updated.  --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

miyoungc added the documentation label Apr 25, 2026

miyoungc self-assigned this Apr 25, 2026

coderabbitai Bot reviewed Apr 25, 2026

View reviewed changes

docs: some edits

a2b3f65

ericksoa approved these changes Apr 25, 2026

View reviewed changes

ericksoa merged commit 6966f4b into main Apr 25, 2026
19 checks passed

miyoungc deleted the docs/release-prep-0.0.25 branch May 27, 2026 20:52

wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed documentation labels Jun 3, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: catch up release prep for 0.0.25#2463

docs: catch up release prep for 0.0.25#2463
ericksoa merged 2 commits into
mainfrom
docs/release-prep-0.0.25

miyoungc commented Apr 25, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 25, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

ericksoa left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

miyoungc commented Apr 25, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Type of Change

Verification

AI Disclosure

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

ericksoa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

miyoungc commented Apr 25, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 25, 2026 •

edited

Loading