docs: refresh daily docs for 0.0.31 - #2724
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughDocumentation updates across NemoClaw's inference and troubleshooting guides, including sandbox container reachability retry behavior, stricter onboarding path validation, proxy configuration guidance, and TLS certificate refresh procedures. Version bumped from 0.0.29 to 0.0.31. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 9/10 reviews remaining, refill in 6 minutes. Comment |
## Summary Refreshes the daily docs from NemoClaw commits merged in the past 24 hours and advances the docs metadata from 0.0.29 to 0.0.31, the next version after tag v0.0.30. The updates cover documented behavior gaps found in the merged PRs listed below. ## Related Issue None. ## Changes - `docs/versions1.json` and `docs/project.json`: bump the preferred docs version to `0.0.31` for daily release preparation after latest tag `v0.0.30`. - `docs/reference/commands.md`: document non-interactive Brave Search validation fallback from NVIDIA#2511 / 9bfe30b, missing `--from <Dockerfile>` path validation from NVIDIA#2597 / 7186834, and `logs` reading OpenShell audit events from NVIDIA#2590 / e225dfb. - `docs/inference/use-local-inference.md`: document local inference reachability retry and host-side fallback from NVIDIA#2453 / 9dbe855, plus compatible-endpoint timeout coverage from NVIDIA#2583 / b4ef3db. - `docs/reference/troubleshooting.md`: document source-install shim fallback from NVIDIA#2520 / 01a177c, TLS gateway trust recovery from NVIDIA#1936 / 24725d2, compatible-endpoint timeout coverage from NVIDIA#2583 / b4ef3db, local reachability diagnostics from NVIDIA#2453 / 9dbe855, and host proxy `NO_PROXY` injection from NVIDIA#2662 / b4df07e. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [ ] Doc only (prose changes, no code sample modifications) - [x] 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 - [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) Additional verification: - `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-run` passed. - `git diff --check` passed. - Pre-push hooks passed through markdownlint, docs-to-skills, JSON checks, gitleaks, and version sync before `Test (skills YAML)` failed because this fresh worktree lacked `vitest/config`. - `npx prek run --all-files` could not run from the fresh worktree because `npx prek` resolved to a missing `prek@*` package; downloading `@j178/prek` was not approved. - `npm test` could not complete from the fresh worktree because dependencies and compiled `dist/lib/*` artifacts were absent. ## AI Disclosure - [x] AI-assisted — tool: OpenAI Codex --- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Version updated to 0.0.31 * Local inference onboarding now includes retry logic for container reachability checks * Web search setup failure handling clarified with fallback guidance * Dockerfile path validation timing documented * Logging behavior clarified for concurrent stream reading * New TLS/certificate troubleshooting section added * Install path and proxy configuration troubleshooting updated <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Summary
Refreshes the daily docs from NemoClaw commits merged in the past 24 hours and advances the docs metadata from 0.0.29 to 0.0.31, the next version after tag v0.0.30.
The updates cover documented behavior gaps found in the merged PRs listed below.
Related Issue
None.
Changes
docs/versions1.jsonanddocs/project.json: bump the preferred docs version to0.0.31for daily release preparation after latest tagv0.0.30.docs/reference/commands.md: document non-interactive Brave Search validation fallback from fix(onboard): don't abort onboard when Brave Search key validation fails #2511 / 9bfe30b, missing--from <Dockerfile>path validation from fix(onboard): validate custom Dockerfile path before onboarding #2597 / 7186834, andlogsreading OpenShell audit events from fix(cli): include OpenShell audit events in logs #2590 / e225dfb.docs/inference/use-local-inference.md: document local inference reachability retry and host-side fallback from fix(onboard): retry and fallback for container reachability check #2453 / 9dbe855, plus compatible-endpoint timeout coverage from fix(cli): honour NEMOCLAW_LOCAL_INFERENCE_TIMEOUT for compatible-endpoint (#2403) #2583 / b4ef3db.docs/reference/troubleshooting.md: document source-install shim fallback from fix(install): surface npm link failures and fall back to user-local shim #2520 / 01a177c, TLS gateway trust recovery from fix(onboard): classify TLS certificate errors during sandbox create #1936 / 24725d2, compatible-endpoint timeout coverage from fix(cli): honour NEMOCLAW_LOCAL_INFERENCE_TIMEOUT for compatible-endpoint (#2403) #2583 / b4ef3db, local reachability diagnostics from fix(onboard): retry and fallback for container reachability check #2453 / 9dbe855, and host proxyNO_PROXYinjection from fix(proxy): inject NO_PROXY=localhost,127.0.0.1 when HTTP_PROXY is set (#2616) #2662 / b4df07e.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Additional verification:
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-runpassed.git diff --checkpassed.Test (skills YAML)failed because this fresh worktree lackedvitest/config.npx prek run --all-filescould not run from the fresh worktree becausenpx prekresolved to a missingprek@*package; downloading@j178/prekwas not approved.npm testcould not complete from the fresh worktree because dependencies and compileddist/lib/*artifacts were absent.AI Disclosure
Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit