Skip to content

docs: prep for v0.0.22#2209

Merged
miyoungc merged 2 commits intomainfrom
docs/refresh-v0.0.22
Apr 22, 2026
Merged

docs: prep for v0.0.22#2209
miyoungc merged 2 commits intomainfrom
docs/refresh-v0.0.22

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Apr 22, 2026

Summary

Bumps the published doc version to 0.0.22 and documents the user-visible CLI behavior changes to nemoclaw <name> connect that landed since v0.0.21. Drafted via the nemoclaw-contributor-update-docs skill against commits in v0.0.21..origin/main, filtered through docs/.docs-skip.

Changes

  • docs/project.json and docs/versions1.json: bump the published version from 0.0.20 to 0.0.22; insert a 0.0.21 entry into the version list so the history stays contiguous.
  • docs/reference/commands.mdnemoclaw <name> connect: document two new behaviors.

Feature PRs that shipped their own docs in the same commit are intentionally not re-documented here:

Skipped per docs/.docs-skip:

  • e6bad533 fix(shields): verify config lock and fail hard on re-lock failure (#2066) — matched skip-features: src/lib/shields.ts.

Other commits in the range (#2141 OpenShell version bump, #1819 plugin banner live inference probe, #2085 / #2146 Slack Socket Mode fixes, #2110 axios proxy fix, #1818 NIM curl timeouts, #1824 onboard gateway bootstrap recovery, and assorted CI / test / install plumbing) are internal behavior refinements with no doc-relevant surface change.

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 for the modified files via the pre-commit hook, including Regenerate agent skills from docs (source ↔ generated parity confirmed)
  • npm test passes — skipped; the one pre-existing test/cli.test.ts > unknown command exits 1 failure on origin/main is unrelated to these markdown/JSON-only changes
  • Tests added or updated for new or changed behavior — n/a, doc-only
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • make docs builds without warnings (doc changes only) — not run locally
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only) — n/a, no new pages

AI Disclosure

  • AI-assisted — tool: Claude Code

Signed-off-by: Miyoung Choi [email protected]

Summary by CodeRabbit

  • New Features

    • connect now displays the sandbox phase while waiting for readiness and honors a configurable timeout via NEMOCLAW_CONNECT_TIMEOUT (default 120s).
    • TTY hints are agent-aware and instruct using /exit before returning to the host shell.
  • Documentation

    • Command docs updated to describe polling, timeout, and TTY guidance.
    • Project/docs metadata updated for versions 0.0.21 and 0.0.22 (package version bumped to 0.0.22).

Bump the published doc version and document the user-visible CLI
changes landed since v0.0.21 for the upcoming release.

- project.json / versions1.json: bump from 0.0.20 to 0.0.22, insert
  0.0.21 into the version list.
- commands.md > `nemoclaw <name> connect`: document the new
  readiness poll with NEMOCLAW_CONNECT_TIMEOUT (default 120s) that
  replaces the silent hang when the sandbox is not yet Ready (#466);
  the post-connect hint is now agent-aware and includes /exit
  guidance (#2080).

channels list/add/remove (#2139) and nemoclaw gc (#2176) were already
documented by their feature PRs. OpenShell version range bump (#2141),
plugin banner live model probe (#1819), Slack Socket Mode fixes
(#2085, #2146), axios proxy conflict (#2110), NIM curl timeouts
(#1818), and onboard gateway bootstrap recovery (#1824) are internal
behavior refinements with no doc-relevant surface change. Shields
commit (#2066) skipped per docs/.docs-skip.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Apr 22, 2026
@miyoungc miyoungc self-assigned this Apr 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 22, 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: 8af1e352-87a0-40a6-ae88-82110890851e

📥 Commits

Reviewing files that changed from the base of the PR and between 740b142 and aa53395.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/reference/commands.md
✅ Files skipped from review due to trivial changes (1)
  • docs/reference/commands.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/nemoclaw-user-reference/references/commands.md

📝 Walkthrough

Walkthrough

Documentation updates describe new polling behavior for nemoclaw connect during non-Ready sandbox phases, introduce NEMOCLAW_CONNECT_TIMEOUT configuration (default 120s), update TTY connection hints with agent awareness and /exit guidance, and bump version metadata to 0.0.22 with corresponding version history entries.

Changes

Cohort / File(s) Summary
Documentation Updates
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Updated nemoclaw connect docs: now polls openshell sandbox list during non-Ready phases and prints phase updates; added NEMOCLAW_CONNECT_TIMEOUT (default 120s) and exit-on-timeout behavior; refined agent-aware TTY hint and added /exit guidance.
Version Metadata
docs/project.json
Bumped package version from 0.0.20 to 0.0.22.
Version History
docs/versions1.json
Prepended new entries for 0.0.22 (preferred) and 0.0.21 with their docs urls.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A rabbit hops through docs with glee,
Polling sandboxes patiently—
No silent waits when images load,
With timeout budgets on the road!
The TTY hints now agent-aware, /exit to leave with care. 🌟

🚥 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 title 'docs: prep for v0.0.22' directly summarizes the main change—bumping documentation to version 0.0.22 and documenting CLI behavior updates.
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/refresh-v0.0.22

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

- Split the 46-word readiness-poll sentence into two sentences
  (<30 words each).
- Replace the semicolon in the NEMOCLAW_CONNECT_TIMEOUT parenthetical
  with a comma.
- Split the 32-word agent-aware hint sentence into two; this also
  removes the mid-clause colon since style guide limits colons to
  list lead-ins.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
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.

🧹 Nitpick comments (2)
docs/reference/commands.md (2)

207-207: Replace colon with period or conjunction.

The colon here is used as general punctuation between clauses rather than to introduce a list, which violates the style guide.

As per coding guidelines: "Colons should only introduce a list. Flag colons used as general punctuation between clauses."

Suggested fix

Option 1 (period):

-The hint is agent-aware: it names the correct TUI command for the sandbox's agent and reminds you to use `/exit` to leave the chat before `exit` returns you to the host shell.
+The hint is agent-aware.
+It names the correct TUI command for the sandbox's agent and reminds you to use `/exit` to leave the chat before `exit` returns you to the host shell.

Option 2 (conjunction):

-The hint is agent-aware: it names the correct TUI command for the sandbox's agent and reminds you to use `/exit` to leave the chat before `exit` returns you to the host shell.
+The hint is agent-aware and names the correct TUI command for the sandbox's agent and reminds you to use `/exit` to leave the chat before `exit` returns you to the host shell.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/commands.md` at line 207, The sentence "The hint is
agent-aware: it names the correct TUI command for the sandbox's agent and
reminds you to use `/exit` to leave the chat before `exit` returns you to the
host shell." uses a colon as general punctuation; change it to either two
sentences or add a conjunction—e.g., replace the colon with a period and start
the next sentence with "It names...", or replace the colon with "and" (or "and
it") so the sentence reads as a single clause; update the line containing that
exact sentence in docs/reference/commands.md accordingly.

204-204: Split into separate lines (one sentence per line).

This line contains two sentences. The style guide requires one sentence per line in source to make diffs readable.

As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

Suggested fix
-Control the wait budget with `NEMOCLAW_CONNECT_TIMEOUT` (integer seconds; default `120`). When the deadline expires, `connect` exits non-zero with the last-seen phase.
+Control the wait budget with `NEMOCLAW_CONNECT_TIMEOUT` (integer seconds; default `120`).
+When the deadline expires, `connect` exits non-zero with the last-seen phase.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/reference/commands.md` at line 204, The line describing
NEMOCLAW_CONNECT_TIMEOUT bundles two sentences; edit the docs entry that
mentions NEMOCLAW_CONNECT_TIMEOUT and the `connect` command so each sentence is
on its own line (e.g., one line: "Control the wait budget with
`NEMOCLAW_CONNECT_TIMEOUT` (integer seconds; default `120`)." and a separate
line: "When the deadline expires, `connect` exits non-zero with the last-seen
phase."); ensure no other sentences are merged on that same line.
🤖 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/reference/commands.md`:
- Line 207: The sentence "The hint is agent-aware: it names the correct TUI
command for the sandbox's agent and reminds you to use `/exit` to leave the chat
before `exit` returns you to the host shell." uses a colon as general
punctuation; change it to either two sentences or add a conjunction—e.g.,
replace the colon with a period and start the next sentence with "It names...",
or replace the colon with "and" (or "and it") so the sentence reads as a single
clause; update the line containing that exact sentence in
docs/reference/commands.md accordingly.
- Line 204: The line describing NEMOCLAW_CONNECT_TIMEOUT bundles two sentences;
edit the docs entry that mentions NEMOCLAW_CONNECT_TIMEOUT and the `connect`
command so each sentence is on its own line (e.g., one line: "Control the wait
budget with `NEMOCLAW_CONNECT_TIMEOUT` (integer seconds; default `120`)." and a
separate line: "When the deadline expires, `connect` exits non-zero with the
last-seen phase."); ensure no other sentences are merged on that same line.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 0b4b3e17-1920-498e-a77b-83a6383234ab

📥 Commits

Reviewing files that changed from the base of the PR and between e6bad53 and 740b142.

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

@miyoungc miyoungc merged commit eda521e into main Apr 22, 2026
14 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.

3 participants