docs: refresh release prep docs for 0.0.33#2866
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 (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughDocumentation-only updates for v0.0.33: Hermes onboarding defaults and sandbox listing clarified, Telegram group-reply control ( Changesv0.0.33 Documentation Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Onboarding
participant Sandbox
participant InferenceLocal as inference.local
participant Telegram
User->>Onboarding: start Hermes onboarding (Telegram enabled)
Onboarding->>Sandbox: create/start sandbox (agent=Hermes)
Onboarding->>Sandbox: request sandbox to perform smoke check
Sandbox->>InferenceLocal: POST /v1/chat/completions (bounded)
InferenceLocal-->>Sandbox: 200 / error
Sandbox-->>Onboarding: smoke check result
Onboarding-->>User: success or guidance to fix endpoint/credentials/network
Note over Telegram,Onboarding: Messaging settings (TELEGRAM_REQUIRE_MENTION) applied separately
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: 8/10 reviews remaining, refill in 9 minutes and 57 seconds. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/versions1.json (1)
4-38:⚠️ Potential issue | 🟠 Major | ⚡ Quick winVersion list exceeds the validated maximum and can break bump automation.
With the new
0.0.33entry,docs/versions1.jsonnow has 9 entries (Line 4 through Line 38), butscripts/bump-version.tsvalidates this file must contain at most 5 entries. Please trim this list to the 5 newest versions to keep release tooling green.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/versions1.json` around lines 4 - 38, The versions1.json file now contains 9 version objects (including "0.0.33"), exceeding the maximum of 5 enforced by scripts/bump-version.ts; trim the array in docs/versions1.json to only the five most recent version objects (e.g., keep "0.0.33", "0.0.32", "0.0.31", "0.0.25", "0.0.24") by removing the older entries so the file contains at most 5 entries and bump automation passes.
🧹 Nitpick comments (1)
docs/inference/inference-options.md (1)
66-66: ⚡ Quick winSplit this table-cell text to one sentence per source line.
This row currently packs several sentences into a single line, which breaks the docs source readability 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/inference/inference-options.md` at line 66, The table row starting with "Other OpenAI-compatible endpoint" contains multiple sentences on a single source line; split that table cell so each sentence is on its own line (e.g., separate sentences about routing to /v1/chat/completions, fallback to /chat/completions, wizard prompting for base URL and model name, compatibility with OpenRouter/LocalAI/llama.cpp/proxies, Telegram sandbox smoke check via https://inference.local/v1/chat/completions, and setting COMPATIBLE_API_KEY) so the source follows the "one sentence per line" rule.
🤖 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/get-started/quickstart-hermes.md`:
- Line 64: The example prompt shows an incorrect default; update the "Sandbox
name [my-hermes]: my-hermes" example so the bracketed default matches the actual
default "hermes" used in the code: either change the prompt to "Sandbox name
[hermes]: my-hermes" if demonstrating overriding the default, or change the
entered value to "hermes" (e.g., "Sandbox name [hermes]: hermes") if showing
default behavior; locate the string "Sandbox name" in quickstart-hermes.md to
make this edit.
- Line 59: The docs state the default Hermes sandbox is "my-hermes" but the code
returns "hermes"; update the quickstart text and example to use "hermes" instead
of "my-hermes" so the doc matches the implementation (the Hermes default
returned in the onboarding logic in onboard.ts), and ensure any example command
or prompt on the page uses "hermes" as the sandbox name.
---
Outside diff comments:
In `@docs/versions1.json`:
- Around line 4-38: The versions1.json file now contains 9 version objects
(including "0.0.33"), exceeding the maximum of 5 enforced by
scripts/bump-version.ts; trim the array in docs/versions1.json to only the five
most recent version objects (e.g., keep "0.0.33", "0.0.32", "0.0.31", "0.0.25",
"0.0.24") by removing the older entries so the file contains at most 5 entries
and bump automation passes.
---
Nitpick comments:
In `@docs/inference/inference-options.md`:
- Line 66: The table row starting with "Other OpenAI-compatible endpoint"
contains multiple sentences on a single source line; split that table cell so
each sentence is on its own line (e.g., separate sentences about routing to
/v1/chat/completions, fallback to /chat/completions, wizard prompting for base
URL and model name, compatibility with OpenRouter/LocalAI/llama.cpp/proxies,
Telegram sandbox smoke check via https://inference.local/v1/chat/completions,
and setting COMPATIBLE_API_KEY) so the source follows the "one sentence per
line" rule.
🪄 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: 7e86a2d4-7ef9-4c99-8235-e161dca3814a
📒 Files selected for processing (7)
docs/get-started/quickstart-hermes.mddocs/inference/inference-options.mddocs/manage-sandboxes/messaging-channels.mddocs/project.jsondocs/reference/commands.mddocs/reference/troubleshooting.mddocs/versions1.json
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (6)
docs/manage-sandboxes/messaging-channels.md (6)
43-50:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd an introductory sentence under
## Channel Requirements.After
## Channel Requirements(Line [43]), you go directly into a table. Add a short introductory sentence before the table to meet the page-structure rule.As per coding guidelines, “Sections use H2 and H3, each starting with an introductory sentence.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` around lines 43 - 50, Under the "## Channel Requirements" heading add a single short introductory sentence (one line) immediately before the existing table that explains what the table lists (e.g., "The following table summarizes each messaging channel's required tokens and optional settings."); edit the markdown near the "## Channel Requirements" header and the table to insert that sentence so the section meets the H2 introductory-sentence guideline.
25-25:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winH1 does not match
title.pagein frontmatter.Your frontmatter sets
title.pageto"Set Up Messaging Channels with NemoClaw and OpenShell", but the page H1 is# Messaging Channels. Update the H1 to match the frontmatter value to satisfy the page-structure requirement.As per coding guidelines, “H1 heading matches the `title.page` frontmatter value.”Suggested fix
-# Messaging Channels +# Set Up Messaging Channels with NemoClaw and OpenShell🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` at line 25, The H1 heading text ("# Messaging Channels") does not match the frontmatter key title.page ("Set Up Messaging Channels with NemoClaw and OpenShell"); update the page H1 to exactly match the frontmatter value so the H1 equals "Set Up Messaging Channels with NemoClaw and OpenShell" (ensure casing/punctuation match the title.page string) — check the top-level H1 in this document and replace the existing "# Messaging Channels" with the exact title.page value.
73-82:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAvoid colons used as general punctuation before a code block.
Line [73] ends with
onboarding:followed by a code block, but the style rule says colons should only introduce a list. Replace the colon with a period (or restructure into “For scripted setup, ... onboarding.”) so the punctuation matches the rule.As per coding guidelines, “Colons should only introduce a list. Flag colons used as general punctuation between clauses.”Suggested fix
-For scripted setup, export the credentials and optional settings for the channels you want to enable before you run onboarding: +For scripted setup, export the credentials and optional settings for the channels you want to enable before you run onboarding.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` around lines 73 - 82, The sentence introducing the code block currently uses a colon as general punctuation ("For scripted setup, export the credentials and optional settings for the channels you want to enable before you run onboarding:"); change the colon to a period (or rephrase to end with "onboarding.") so it no longer uses a colon outside of a list; update the text immediately preceding the code block in messaging-channels.md (the "For scripted setup, export..." line) to the corrected punctuation.
180-185:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd/rename to a required “Next Steps” section at the bottom.
The file ends with
## Related Topicsbut the style guide requires a “Next Steps” section at the bottom that links to related pages. Consider renaming## Related Topicsto## Next Steps(your existing links would satisfy the intent).As per coding guidelines, “A ‘Next Steps’ section at the bottom links to related pages.”Suggested fix
-## Related Topics +## Next Steps🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` around lines 180 - 185, Rename the footer heading "## Related Topics" to "## Next Steps" and keep the existing bullet links unchanged so the section satisfies the style guide; locate the header string "## Related Topics" and update it to "## Next Steps" (the following bullets referencing Deploy NemoClaw, Architecture, and Commands remain as-is).
127-134:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAvoid colons used as general punctuation before a code block.
Line [127] ends with
rebuild:followed by a code block. Replace the colon with a period (or similar) to comply with the colon punctuation rule.As per coding guidelines, “Colons should only introduce a list. Flag colons used as general punctuation between clauses.”Suggested fix
-For Discord server access after onboarding, include the server settings when you add the channel and rebuild: +For Discord server access after onboarding, include the server settings when you add the channel and rebuild.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` around lines 127 - 134, The sentence that currently ends with "rebuild:" should not use a colon as general punctuation before the fenced code block; edit the sentence that precedes the Discord example (the line containing the word "rebuild:") to end with a period (or other non-colon punctuation) instead (e.g., change "rebuild:" to "rebuild."), leaving the subsequent code block unchanged so the guidance and example remain intact.
37-42:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd an introductory sentence under
## Prerequisites.After
## Prerequisites(Line [37]), you go directly into a bullet list. Add a one-sentence introduction before the list to follow the “H2 starts with an introductory sentence” structure rule.As per coding guidelines, “Sections use H2 and H3, each starting with an introductory sentence.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` around lines 37 - 42, Add a one-sentence introductory line immediately after the "## Prerequisites" heading that briefly explains what the prerequisites cover (e.g., "Before enabling messaging channels, ensure you have the following requirements in place.") so the section follows the H2-starts-with-an-introductory-sentence rule; place this new sentence above the existing bullet list that currently begins with "A machine where you can run `nemoclaw onboard`" to provide context for the three listed items.
🧹 Nitpick comments (1)
docs/manage-sandboxes/messaging-channels.md (1)
34-34: ⚡ Quick winReplace passive voice to keep active tone.
Line [34] uses passive voice: “
nemoclaw startis kept as a deprecated alias.” Rephrase to active voice (and ideally keep the subject explicit, e.g., the docs/CLI/NemoClaw “keeps” the alias).As per coding guidelines, “Active voice required. Flag passive constructions.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/manage-sandboxes/messaging-channels.md` at line 34, Change the passive sentence to an active construction: replace “`nemoclaw start` is kept as a deprecated alias.” with an explicit subject, e.g. “NemoClaw keeps `nemoclaw start` as a deprecated alias.” so the docs/CLI text uses active voice and names the subject (NemoClaw) rather than passive phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/manage-sandboxes/messaging-channels.md`:
- Around line 43-50: Under the "## Channel Requirements" heading add a single
short introductory sentence (one line) immediately before the existing table
that explains what the table lists (e.g., "The following table summarizes each
messaging channel's required tokens and optional settings."); edit the markdown
near the "## Channel Requirements" header and the table to insert that sentence
so the section meets the H2 introductory-sentence guideline.
- Line 25: The H1 heading text ("# Messaging Channels") does not match the
frontmatter key title.page ("Set Up Messaging Channels with NemoClaw and
OpenShell"); update the page H1 to exactly match the frontmatter value so the H1
equals "Set Up Messaging Channels with NemoClaw and OpenShell" (ensure
casing/punctuation match the title.page string) — check the top-level H1 in this
document and replace the existing "# Messaging Channels" with the exact
title.page value.
- Around line 73-82: The sentence introducing the code block currently uses a
colon as general punctuation ("For scripted setup, export the credentials and
optional settings for the channels you want to enable before you run
onboarding:"); change the colon to a period (or rephrase to end with
"onboarding.") so it no longer uses a colon outside of a list; update the text
immediately preceding the code block in messaging-channels.md (the "For scripted
setup, export..." line) to the corrected punctuation.
- Around line 180-185: Rename the footer heading "## Related Topics" to "## Next
Steps" and keep the existing bullet links unchanged so the section satisfies the
style guide; locate the header string "## Related Topics" and update it to "##
Next Steps" (the following bullets referencing Deploy NemoClaw, Architecture,
and Commands remain as-is).
- Around line 127-134: The sentence that currently ends with "rebuild:" should
not use a colon as general punctuation before the fenced code block; edit the
sentence that precedes the Discord example (the line containing the word
"rebuild:") to end with a period (or other non-colon punctuation) instead (e.g.,
change "rebuild:" to "rebuild."), leaving the subsequent code block unchanged so
the guidance and example remain intact.
- Around line 37-42: Add a one-sentence introductory line immediately after the
"## Prerequisites" heading that briefly explains what the prerequisites cover
(e.g., "Before enabling messaging channels, ensure you have the following
requirements in place.") so the section follows the
H2-starts-with-an-introductory-sentence rule; place this new sentence above the
existing bullet list that currently begins with "A machine where you can run
`nemoclaw onboard`" to provide context for the three listed items.
---
Nitpick comments:
In `@docs/manage-sandboxes/messaging-channels.md`:
- Line 34: Change the passive sentence to an active construction: replace
“`nemoclaw start` is kept as a deprecated alias.” with an explicit subject, e.g.
“NemoClaw keeps `nemoclaw start` as a deprecated alias.” so the docs/CLI text
uses active voice and names the subject (NemoClaw) rather than passive phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: d8860446-f8da-49dd-a763-33fecd87811e
📒 Files selected for processing (5)
docs/get-started/quickstart-hermes.mddocs/inference/inference-options.mddocs/manage-sandboxes/messaging-channels.mddocs/reference/commands.mddocs/reference/troubleshooting.md
✅ Files skipped from review due to trivial changes (4)
- docs/get-started/quickstart-hermes.md
- docs/inference/inference-options.md
- docs/reference/troubleshooting.md
- docs/reference/commands.md
2 participants
Summary
Daily release-prep documentation refresh for merged PRs from the past 24 hours.
This updates user-facing docs for Telegram mention-only mode, in-sandbox messaging shutdown, Hermes onboarding/runtime behavior, and compatible-endpoint smoke validation, then bumps the docs metadata to 0.0.33 after tag v0.0.32.
Related Issue
None.
Changes
TELEGRAM_REQUIRE_MENTIONfor Telegram group-chat replies indocs/manage-sandboxes/messaging-channels.mdanddocs/reference/commands.md.nemoclaw tunnel stopand deprecatednemoclaw stopdocs to explain that NemoClaw also attempts to stop the in-sandbox OpenClaw gateway and messaging polling.my-hermessandbox name, cross-agent same-name guard, agent type visibility innemoclaw list, Brave prompt omission, and supported prebaked Hermes integrations.inference.localsmoke check in inference options and troubleshooting.docs/versions1.jsonanddocs/project.jsonfrom 0.0.32 to 0.0.33 for daily release preparation.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Additional checks run:
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --dry-rungit diff --checkmake docspassed with the existing local version-switcher read message.npx prek run --all-filesandnpm testwere skipped for this doc-only automation run. Commit and pre-push hooks otherwise passed docs, lint, secret, and conversion checks until the localTest (skills YAML)hook failed becausevitest/configis not installed in this fresh worktree.Signed-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit