Skip to content

docs: refresh daily docs for 0.0.29#2576

Merged
miyoungc merged 3 commits intomainfrom
docs/daily-refresh-0.0.29
Apr 28, 2026
Merged

docs: refresh daily docs for 0.0.29#2576
miyoungc merged 3 commits intomainfrom
docs/daily-refresh-0.0.29

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 28, 2026

Summary

Refreshes user-facing docs for the last 24 hours of merged NemoClaw history and bumps the docs metadata to 0.0.29, the next version after v0.0.28. The updates are limited to behavior supported by merged PR descriptions and diffs.

Changes

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 — failed locally in installer-integration tests and one onboard helper timeout; the doc-scoped hook test projects passed under prek.
  • 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) — build succeeded, but local Sphinx emitted the existing version-switcher file read message.
  • 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: Codex

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

Summary by CodeRabbit

  • New Features

    • Support for custom YAML presets in policy configuration via --from-file and --from-dir.
    • New build-time inference input option to declare accepted modalities (text or text,image).
  • Improvements

    • Credential validation now offers interactive recovery: re-enter key, retry, choose another provider, or exit.
    • Clarified provider-specific API key prefix handling (nvapi- only applies to NVIDIA keys).
  • Documentation

    • TLS certificate troubleshooting for inspected networks.
    • Clarified remote dashboard security/device-pairing behavior; command docs updated; docs version bumped.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 28, 2026
@miyoungc miyoungc self-assigned this Apr 28, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2026

📝 Walkthrough

Walkthrough

Refines several docs: updates inference credential validation flow, ties OpenClaw pairing disablement to non-loopback CHAT_UI_URL, adds policy-add flags for custom YAML presets, documents Git TLS-inspection CA troubleshooting, and bumps documentation version metadata to 0.0.29.

Changes

Cohort / File(s) Summary
Inference Validation Flow
/.agents/skills/nemoclaw-user-configure-inference/references/inference-options.md, docs/inference/inference-options.md
Distinguishes credential-specific validation failures from generic provider/model failures; wizard now offers re-enter API key / select another provider / retry / exit options. Notes nvapi- prefix check applies only to NVIDIA_API_KEY.
Remote Deployment Security
/.agents/skills/nemoclaw-user-deploy-remote/SKILL.md, docs/deployment/deploy-to-remote-gpu.md
Reframes device-pairing disablement to depend on CHAT_UI_URL being a non-loopback origin; clarifies browser-only remote users cannot complete terminal pairing and warns against exposing the dashboard origin.
Policy Command & Troubleshooting
/.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md, /.agents/skills/nemoclaw-user-reference/references/troubleshooting.md, docs/reference/troubleshooting.md
Adds --from-file and --from-dir for nemoclaw <name> policy-add, updates --yes/--force behavior and examples; adds troubleshooting for Git certificate errors in TLS-inspecting networks and documents CA-bundle env var export/persistence.
Inference Inputs Metadata
/.agents/skills/nemoclaw-user-configure-inference/SKILL.md, docs/inference/switch-inference-providers.md
Introduces NEMOCLAW_INFERENCE_INPUTS build-time env var and documents accepted input modalities (text or text,image) in model metadata; updates onboarding examples.
Version Metadata
docs/project.json, docs/versions1.json
Bumps docs/project.json version from 0.0.25 to 0.0.29; adds 0.0.29 as preferred in docs/versions1.json and removes older public entries (0.0.16–0.0.19).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐇 I hopped through pages, soft and spry,

Tucked keys and CA-bundles where they lie.
Presets, inputs, pairing in a line—
Versioned snugly: 0.0.29. 🥕✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: refresh daily docs for 0.0.29' directly reflects the main change: bumping documentation to version 0.0.29 and refreshing docs based on merged NemoClaw history.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/daily-refresh-0.0.29

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/reference/commands.md (1)

351-375: ⚠️ Potential issue | 🟡 Minor

Document --from-file and --from-dir exclusivity and batch-failure behavior.

The new flags are documented, but the page does not mention that combining both flags is invalid, and --from-dir stops on the first failing preset. Adding this avoids confusing failures in automation.

Proposed doc addition
 | `--from-file <path>` | Apply a custom preset YAML file instead of a built-in preset |
 | `--from-dir <path>` | Apply every custom preset YAML file in a directory in lexicographic order |
 | `--yes`, `--force` | Skip the confirmation prompt (requires a preset name, `--from-file`, or `--from-dir`) |
 | `--dry-run` | Preview the endpoints a preset would open without applying changes |

+`--from-file` and `--from-dir` are mutually exclusive.
+`--from-dir` reads only `.yaml` and `.yml` files and aborts on the first failed preset.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/commands.md` around lines 351 - 375, Update the policy-add CLI
docs to state that the flags `--from-file` and `--from-dir` are mutually
exclusive (cannot be used together) and to document the batch-failure behavior
of `--from-dir` (it stops processing on the first failing preset), referencing
the `policy-add` command and the flags `--from-file`, `--from-dir`, and
`--yes`/`--force` so readers know the limitation and that automation should
handle failure/ordering accordingly.
🧹 Nitpick comments (1)
docs/reference/troubleshooting.md (1)

499-499: Format git clone as inline code in the heading.

Line 499 uses a CLI command phrase in prose form. Use inline code formatting for command names in headings too for consistency.

As per coding guidelines, "CLI commands, file paths, flags, parameter names, and values must use inline code formatting."

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

In `@docs/reference/troubleshooting.md` at line 499, Update the heading "### Git
clone fails with a certificate verification error" to format the CLI command as
inline code by changing it to "### `git clone` fails with a certificate
verification error"; locate the heading text in the docs (search for the exact
string) and replace it so that the command `git clone` uses inline backticks to
comply with the guideline that CLI commands, file paths, flags and parameters
use code formatting.
🤖 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`:
- Around line 503-509: The verification command omits GIT_SSL_CAPATH even though
the text mentions it; update the env check used in the troubleshooting doc (the
grep pattern used in the `env | grep -E '...'` line) to include GIT_SSL_CAPATH
alongside SSL_CERT_FILE, GIT_SSL_CAINFO, CURL_CA_BUNDLE, and REQUESTS_CA_BUNDLE
so the command actually verifies all listed CA-related variables.

---

Outside diff comments:
In `@docs/reference/commands.md`:
- Around line 351-375: Update the policy-add CLI docs to state that the flags
`--from-file` and `--from-dir` are mutually exclusive (cannot be used together)
and to document the batch-failure behavior of `--from-dir` (it stops processing
on the first failing preset), referencing the `policy-add` command and the flags
`--from-file`, `--from-dir`, and `--yes`/`--force` so readers know the
limitation and that automation should handle failure/ordering accordingly.

---

Nitpick comments:
In `@docs/reference/troubleshooting.md`:
- Line 499: Update the heading "### Git clone fails with a certificate
verification error" to format the CLI command as inline code by changing it to
"### `git clone` fails with a certificate verification error"; locate the
heading text in the docs (search for the exact string) and replace it so that
the command `git clone` uses inline backticks to comply with the guideline that
CLI commands, file paths, flags and parameters use code formatting.
🪄 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: Enterprise

Run ID: 6fc5ce9d-e072-4faf-864a-8435b6bf1d13

📥 Commits

Reviewing files that changed from the base of the PR and between d392ec0 and 2068960.

📒 Files selected for processing (10)
  • .agents/skills/nemoclaw-user-configure-inference/references/inference-options.md
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • .agents/skills/nemoclaw-user-reference/references/troubleshooting.md
  • docs/deployment/deploy-to-remote-gpu.md
  • docs/inference/inference-options.md
  • docs/project.json
  • docs/reference/commands.md
  • docs/reference/troubleshooting.md
  • docs/versions1.json

Comment on lines +503 to +509
It also forwards standard CA bundle variables for subprocesses, including `GIT_SSL_CAPATH`, `CURL_CA_BUNDLE`, and `REQUESTS_CA_BUNDLE`.

If Git still reports `server certificate verification failed`, reconnect to the sandbox and check that the CA variables are present:

```console
$ env | grep -E 'SSL_CERT_FILE|GIT_SSL_CAINFO|CURL_CA_BUNDLE|REQUESTS_CA_BUNDLE'
```
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

Include GIT_SSL_CAPATH in the verification command.

Line 503 documents GIT_SSL_CAPATH, but Line 508 does not verify it. That can hide the exact missing variable in failing environments.

Proposed doc fix
-$ env | grep -E 'SSL_CERT_FILE|GIT_SSL_CAINFO|CURL_CA_BUNDLE|REQUESTS_CA_BUNDLE'
+$ env | grep -E 'SSL_CERT_FILE|GIT_SSL_CAINFO|GIT_SSL_CAPATH|CURL_CA_BUNDLE|REQUESTS_CA_BUNDLE'
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/troubleshooting.md` around lines 503 - 509, The verification
command omits GIT_SSL_CAPATH even though the text mentions it; update the env
check used in the troubleshooting doc (the grep pattern used in the `env | grep
-E '...'` line) to include GIT_SSL_CAPATH alongside SSL_CERT_FILE,
GIT_SSL_CAINFO, CURL_CA_BUNDLE, and REQUESTS_CA_BUNDLE so the command actually
verifies all listed CA-related variables.

Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
@miyoungc miyoungc merged commit 277048e into main Apr 28, 2026
21 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