Skip to content

docs: catch up documentation for v0.0.17 changes#1968

Merged
miyoungc merged 2 commits intomainfrom
docs/refresh-v0.0.17
Apr 16, 2026
Merged

docs: catch up documentation for v0.0.17 changes#1968
miyoungc merged 2 commits intomainfrom
docs/refresh-v0.0.17

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 16, 2026

Summary

Test plan

  • make docs builds without warnings
  • All pre-commit hooks pass
  • Verify rendered pages in docs build output

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified onboarding error when build context contains unreadable files.
    • Updated snapshot restore: sandbox must be running; restore cleanly replaces state directories and removes files added after the snapshot.
    • Added Jetson BSP R39 automatic configuration guidance.
    • Added Ollama network-exposure security guidance for local provider selection during onboarding.
  • Documentation (versions)
    • Added docs entry for version 0.0.17 and updated project docs version.

Document Ollama network exposure warning, snapshot restore liveness
preflight and clean restore behavior, Jetson BSP R39+ support, custom
Dockerfile permission error handling, and bump doc versions through
0.0.17.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 16, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c7debff1-978b-4335-9453-445e0aed9e03

📥 Commits

Reviewing files that changed from the base of the PR and between d442dc4 and 64cfdc3.

📒 Files selected for processing (1)
  • docs/project.json
✅ Files skipped from review due to trivial changes (1)
  • docs/project.json

📝 Walkthrough

Walkthrough

The pull request updates various nemoclaw documentation files and project metadata: clarifies onboarding with Docker build-context unreadable files, snapshot restore requirements and behavior, adds Jetson BSP R39+ handling note, adds an Ollama network-exposure warning during onboarding, and inserts a new preferred docs version 0.0.17.

Changes

Cohort / File(s) Summary
Commands Reference
/.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Clarify nemoclaw onboard --from <Dockerfile> exits with error if the Docker build-context contains unreadable files; require sandbox running for nemoclaw <name> snapshot restore [timestamp] and state that restore cleanly replaces state directories (removing files added after snapshot).
Troubleshooting Guide
/.agents/skills/nemoclaw-user-reference/references/troubleshooting.md, docs/reference/troubleshooting.md
Add Jetson note that BSP R39+ no longer requires host customization; add "Ollama network exposure warning during onboard" describing that onboarding binds Ollama to 0.0.0.0 for local Docker sandbox reachability, the resulting network exposure risks, and that the warning is suppressed on WSL (127.0.0.1).
Docs Version & Project Metadata
docs/versions1.json, docs/project.json
Insert new preferred documentation version entry for 0.0.17 and bump docs/project.json package version from 0.0.16 to 0.0.17.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A nibble of notes, a hop and a cheer,
Docs polished bright so the path is clear,
Ollama's door noted, Jetson's tune sung,
Snapshots restored when the sandbox is sprung,
Version 0.0.17—new page, new run. 🥕

🚥 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 PR title directly and clearly describes the main objective: updating documentation to catch up with v0.0.17 changes, which aligns with all file modifications including troubleshooting entries, snapshot restore documentation, Jetson BSP updates, permission error handling, and version bumps.
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-v0.0.17

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/reference/troubleshooting.md`:
- Line 522: The sentence in docs/reference/troubleshooting.md that states "The
warning is suppressed on WSL, where Ollama binds to `127.0.0.1` instead." should
be changed to clarify this is the default behavior and not a guarantee: reword
it to say that on WSL Ollama defaults to binding to 127.0.0.1 but explicit
OLLAMA_HOST environment variables are respected (as implemented in
bin/lib/onboard.js), so the warning may not be suppressed if a user has exported
OLLAMA_HOST; keep the explanation concise and reference the behavior rather than
asserting it as absolute.
🪄 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: 24ca997e-5f33-4ffe-a51d-fb039ad8da68

📥 Commits

Reviewing files that changed from the base of the PR and between 121148c and d442dc4.

📒 Files selected for processing (5)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/reference/commands.md
  • docs/reference/troubleshooting.md
  • docs/versions1.json

On trusted private networks, the warning is informational.
On shared or public networks (airports, coffee shops), any adjacent device can send prompts to and enumerate models on your Ollama instance.

The warning is suppressed on WSL, where Ollama binds to `127.0.0.1` instead.
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 | 🟡 Minor

Avoid absolute WSL binding wording here.

Line 522 currently implies WSL always binds Ollama to 127.0.0.1. That is not always true if a user explicitly exports OLLAMA_HOST, so this should be phrased as default behavior rather than a guarantee.

Based on learnings: In bin/lib/onboard.js (NemoClaw project), the WSL2 Ollama startup path intentionally does NOT clear an inherited OLLAMA_HOST environment variable and respects explicit user configuration.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/troubleshooting.md` at line 522, The sentence in
docs/reference/troubleshooting.md that states "The warning is suppressed on WSL,
where Ollama binds to `127.0.0.1` instead." should be changed to clarify this is
the default behavior and not a guarantee: reword it to say that on WSL Ollama
defaults to binding to 127.0.0.1 but explicit OLLAMA_HOST environment variables
are respected (as implemented in bin/lib/onboard.js), so the warning may not be
suppressed if a user has exported OLLAMA_HOST; keep the explanation concise and
reference the behavior rather than asserting it as absolute.

@miyoungc miyoungc merged commit a648ed4 into main Apr 16, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants