docs: update messaging - #432
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughDocumentation and front-matter across Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (5)
docs/index.md (1)
6-6: Fix product-name casing in keywords.Use
NVIDIA(all caps) in keywords instead ofnvidia.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/index.md` at line 6, The keywords array in docs/index.md uses lowercase "nvidia"; update the entries inside the keywords list (the keywords array) to use "NVIDIA" in all-caps (e.g., change "nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA nemotron") so the product-name casing follows the guidelines.docs/about/release-notes.md (1)
23-23: Split this into one sentence per source line.This line contains two sentences; keep one sentence per line for docs diffs/readability.
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/about/release-notes.md` at line 23, The line "NVIDIA NemoClaw is available in early preview starting March 16, 2026. Use the following GitHub resources to track changes." contains two sentences on one line; split it into two lines so each sentence is on its own line—one line with "NVIDIA NemoClaw is available in early preview starting March 16, 2026." and a separate next line with "Use the following GitHub resources to track changes." in docs/about/release-notes.md.docs/about/overview.md (2)
6-6: Fix product-name casing in keywords.Use
NVIDIA(all caps) instead ofnvidiain this metadata entry.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 6, Update the keywords metadata array to use the correct vendor casing: replace the entries containing "nvidia" with "NVIDIA" (specifically change "nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA nemotron") in the keywords list so the metadata uses all-caps NVIDIA as required.
23-23: Use one sentence per source line in the overview paragraphs.Each of these lines contains multiple sentences; split them so each sentence is on its own line.
As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."
Also applies to: 25-25
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 23, The overview paragraph currently has multiple sentences on the same source line; split each sentence into its own source line so diffs are readable: place "NVIDIA NemoClaw is an open source reference stack that simplifies running [OpenClaw](https://openclaw.ai) always-on assistants safely." on one line, "It incorporates policy-based privacy and security guardrails, giving users control over their agents' behavior and data handling." on the next line, and "This enables self-evolving claws to run more safely in clouds, on prem, RTX PCs, and DGX Spark." on its own line (also apply the same one-sentence-per-line split to the similar sentence group referenced in the review).docs/about/how-it-works.md (1)
23-23: Avoid filler intro phrasing in the opening line.“This page explains …” is a generic lead-in. Start with concrete content instead. LLM pattern detected.
As per coding guidelines, "Filler introductions ("In this section, we will explore..."). Start with the content."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/how-it-works.md` at line 23, The opening sentence "This page explains the key concepts about NemoClaw at a high level." is a filler intro—remove or replace it with a concrete lead that immediately states the core idea; edit the document so the first line directly defines or summarizes NemoClaw (for example, begin with a concise statement about what NemoClaw does, its primary components, or its most important behavior) rather than using a generic phrase, and ensure subsequent paragraphs expand on those concrete points.
🤖 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/about/how-it-works.md`:
- Line 23: The opening sentence "This page explains the key concepts about
NemoClaw at a high level." is a filler intro—remove or replace it with a
concrete lead that immediately states the core idea; edit the document so the
first line directly defines or summarizes NemoClaw (for example, begin with a
concise statement about what NemoClaw does, its primary components, or its most
important behavior) rather than using a generic phrase, and ensure subsequent
paragraphs expand on those concrete points.
In `@docs/about/overview.md`:
- Line 6: Update the keywords metadata array to use the correct vendor casing:
replace the entries containing "nvidia" with "NVIDIA" (specifically change
"nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA
nemotron") in the keywords list so the metadata uses all-caps NVIDIA as
required.
- Line 23: The overview paragraph currently has multiple sentences on the same
source line; split each sentence into its own source line so diffs are readable:
place "NVIDIA NemoClaw is an open source reference stack that simplifies running
[OpenClaw](https://openclaw.ai) always-on assistants safely." on one line, "It
incorporates policy-based privacy and security guardrails, giving users control
over their agents' behavior and data handling." on the next line, and "This
enables self-evolving claws to run more safely in clouds, on prem, RTX PCs, and
DGX Spark." on its own line (also apply the same one-sentence-per-line split to
the similar sentence group referenced in the review).
In `@docs/about/release-notes.md`:
- Line 23: The line "NVIDIA NemoClaw is available in early preview starting
March 16, 2026. Use the following GitHub resources to track changes." contains
two sentences on one line; split it into two lines so each sentence is on its
own line—one line with "NVIDIA NemoClaw is available in early preview starting
March 16, 2026." and a separate next line with "Use the following GitHub
resources to track changes." in docs/about/release-notes.md.
In `@docs/index.md`:
- Line 6: The keywords array in docs/index.md uses lowercase "nvidia"; update
the entries inside the keywords list (the keywords array) to use "NVIDIA" in
all-caps (e.g., change "nvidia openshell" and "nvidia nemotron" to "NVIDIA
openshell" and "NVIDIA nemotron") so the product-name casing follows the
guidelines.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: dc7365b3-2020-43b0-b3ce-ff94b50795fc
📒 Files selected for processing (5)
README.mddocs/about/how-it-works.mddocs/about/overview.mddocs/about/release-notes.mddocs/index.md
drobison00
reviewed
Mar 19, 2026
|
|
||
| NemoClaw combines a lightweight CLI plugin with a versioned blueprint to move OpenClaw into a controlled sandbox. | ||
| This page explains the key concepts at a high level. | ||
| This page explains the key concepts about NemoClaw at a high level. |
There was a problem hiding this comment.
This seems out of place under the 'How NemoClaw' works section.
miyoungc
force-pushed
the
docs/update-messaging
branch
from
March 19, 2026 19:51
525b440 to
cb4ae77
Compare
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (4)
docs/index.md (1)
6-6: Use canonicalNVIDIAcapitalization in frontmatter keywords.The
keywordsvalues usenvidiain lowercase, which violates the project word list.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/index.md` at line 6, Update the frontmatter `keywords` array to use the canonical all-caps "NVIDIA" for any entries that currently use lowercase "nvidia" (e.g., change "nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA nemotron"); locate the `keywords` frontmatter in docs/index.md and perform a simple string-capitalization edit so the project word list rule ("NVIDIA must be all caps") is respected.docs/about/overview.md (3)
23-23: Split this line to one sentence per source line.This line contains multiple sentences in a single source line, which reduces diff readability.
As per coding guidelines, "One sentence per line in source (makes diffs readable)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 23, The paragraph beginning "NVIDIA NemoClaw is an open source reference stack..." contains multiple sentences on one source line; split it so each sentence appears on its own line (one sentence per source line) to improve diff readability—i.e., break after "...always-on assistants safely.", after "...data handling.", and after "...RTX PCs, and DGX Spark." so each sentence is its own line in the file.
6-6: NormalizeNVIDIAcasing inkeywords.
keywordsincludes lowercasenvidia, which is out of spec for the word list.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 6, The front-matter `keywords` array contains lowercase "nvidia" entries; update those keyword strings so "NVIDIA" is fully uppercase (e.g., change "nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA nemotron") ensuring the `keywords` key still holds a valid array and other keywords (like "nemoclaw overview" and "openclaw always-on assistants") remain unchanged.
25-25: Apply one-sentence-per-line formatting here as well.This line also combines multiple sentences on one source line.
As per coding guidelines, "One sentence per line in source (makes diffs readable)."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 25, The paragraph containing the sentence that starts "NemoClaw uses open source models, such as NVIDIA Nemotron..." should be reformatted so each sentence is on its own source line: split the combined sentence into separate lines (e.g., "NemoClaw uses open source models, such as [NVIDIA Nemotron](https://build.nvidia.com)." on one line, "It uses the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of the [NVIDIA Agent Toolkit](https://docs.nvidia.com/nemo/agent-toolkit/latest)." on the next, and "By combining open source models with built-in safety measures, NemoClaw simplifies and secures AI agent deployment." on its own line), keep links and punctuation unchanged, and ensure no line contains more than one sentence for better diffs.
🤖 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/about/overview.md`:
- Line 23: The paragraph beginning "NVIDIA NemoClaw is an open source reference
stack..." contains multiple sentences on one source line; split it so each
sentence appears on its own line (one sentence per source line) to improve diff
readability—i.e., break after "...always-on assistants safely.", after "...data
handling.", and after "...RTX PCs, and DGX Spark." so each sentence is its own
line in the file.
- Line 6: The front-matter `keywords` array contains lowercase "nvidia" entries;
update those keyword strings so "NVIDIA" is fully uppercase (e.g., change
"nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA
nemotron") ensuring the `keywords` key still holds a valid array and other
keywords (like "nemoclaw overview" and "openclaw always-on assistants") remain
unchanged.
- Line 25: The paragraph containing the sentence that starts "NemoClaw uses open
source models, such as NVIDIA Nemotron..." should be reformatted so each
sentence is on its own source line: split the combined sentence into separate
lines (e.g., "NemoClaw uses open source models, such as [NVIDIA
Nemotron](https://build.nvidia.com)." on one line, "It uses the [NVIDIA
OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of the [NVIDIA
Agent Toolkit](https://docs.nvidia.com/nemo/agent-toolkit/latest)." on the next,
and "By combining open source models with built-in safety measures, NemoClaw
simplifies and secures AI agent deployment." on its own line), keep links and
punctuation unchanged, and ensure no line contains more than one sentence for
better diffs.
In `@docs/index.md`:
- Line 6: Update the frontmatter `keywords` array to use the canonical all-caps
"NVIDIA" for any entries that currently use lowercase "nvidia" (e.g., change
"nvidia openshell" and "nvidia nemotron" to "NVIDIA openshell" and "NVIDIA
nemotron"); locate the `keywords` frontmatter in docs/index.md and perform a
simple string-capitalization edit so the project word list rule ("NVIDIA must be
all caps") is respected.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 9f2d8af6-1762-4621-a156-584095852cdd
📒 Files selected for processing (5)
README.mddocs/about/how-it-works.mddocs/about/overview.mddocs/about/release-notes.mddocs/index.md
✅ Files skipped from review due to trivial changes (2)
- docs/about/release-notes.md
- docs/about/how-it-works.md
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
9-9: Use hyphenated compound adjectives for “open-source.”On Line 9, both “open source reference stack” and “open source models” should be hyphenated in adjectival use for grammatical consistency.
Proposed edit
-NVIDIA NemoClaw is an open source reference stack that simplifies running [OpenClaw](https://openclaw.ai) always-on assistants safely. It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of [NVIDIA Agent Toolkit](https://docs.nvidia.com/nemo/agent-toolkit/latest), a secure environment for running autonomous agents, and open source models such as [NVIDIA Nemotron](https://build.nvidia.com). +NVIDIA NemoClaw is an open-source reference stack that simplifies running [OpenClaw](https://openclaw.ai) always-on assistants safely. It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of [NVIDIA Agent Toolkit](https://docs.nvidia.com/nemo/agent-toolkit/latest), a secure environment for running autonomous agents, and open-source models such as [NVIDIA Nemotron](https://build.nvidia.com).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 9, The README line contains unhyphenated adjectival phrases "open source reference stack" and "open source models"; update both to use the hyphenated compound adjective "open-source" (so replace those occurrences in README.md) to read "open-source reference stack" and "open-source models" for grammatical consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Line 9: The README line contains unhyphenated adjectival phrases "open source
reference stack" and "open source models"; update both to use the hyphenated
compound adjective "open-source" (so replace those occurrences in README.md) to
read "open-source reference stack" and "open-source models" for grammatical
consistency.
miyoungc
force-pushed
the
docs/update-messaging
branch
from
March 19, 2026 20:50
e3af593 to
cb4ae77
Compare
miyoungc
force-pushed
the
docs/update-messaging
branch
from
March 19, 2026 20:50
cb4ae77 to
58c8ac9
Compare
drobison00
approved these changes
Mar 19, 2026
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (3)
docs/index.md (1)
6-6: Fix product-name casing inkeywordsmetadata.The keyword values use incorrect casing (
nemoclaw,openclaw,nvidia openshell,nvidia nemotron).
Use canonical forms (NemoClaw,OpenClaw,NVIDIA,OpenShell) to match the docs word list.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)." and "NemoClaw, OpenClaw, and OpenShell must use correct casing."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/index.md` at line 6, Update the keywords metadata array so product names use the canonical casing: replace "nemoclaw" with "NemoClaw", "openclaw always-on assistants" with "OpenClaw always-on assistants" (or adjust the token to "OpenClaw" if you prefer single keywords), "nvidia openshell" with "NVIDIA OpenShell" (ensure NVIDIA is all caps) and "nvidia nemotron" with "NVIDIA Nemotron"; edit the keywords array defined as keywords: [...] in the docs/index.md frontmatter to apply these exact replacements.docs/about/overview.md (2)
6-6: Normalizekeywordscasing to the approved product names.
keywordscurrently uses lowercase variants (nemoclaw,openclaw,nvidia openshell,nvidia nemotron).
Please align with the approved casing in the style guide.As per coding guidelines, "NVIDIA must be all caps (not Nvidia, nvidia)." and "NemoClaw, OpenClaw, and OpenShell must use correct casing."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 6, Update the YAML `keywords` entry to use the approved product name casing: replace "nemoclaw" with "NemoClaw", "openclaw always-on assistants" with "OpenClaw always-on assistants" (or "OpenClaw" if trimming), and change "nvidia openshell" and "nvidia nemotron" to "NVIDIA OpenShell" and "NVIDIA Nemotron" respectively; ensure the `keywords` array preserves the same items but with exact casing and punctuation as per the style guide.
23-23: Split this into one sentence per line and use second person for reader-directed text.This line contains multiple sentences on one source line and uses third person ("users") while describing reader control.
Please break sentences onto separate lines and use "you" for reader-facing statements.As per coding guidelines, "One sentence per line in source (makes diffs readable)." and "Second person ('you') when addressing the reader."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/about/overview.md` at line 23, Split the sentence that begins with "NVIDIA NemoClaw is an open source reference stack..." into one sentence per source line, and rewrite reader-directed parts to use second person ("you") instead of "users" — e.g., turn "giving users control over their agents' behavior and data handling" into "giving you control over your agents' behavior and data handling." Ensure each sentence ends on its own line and preserve the original meaning about policy-based privacy/security guardrails and deployment targets (clouds, on prem, RTX PCs, and DGX Spark).
🤖 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/about/overview.md`:
- Line 6: Update the YAML `keywords` entry to use the approved product name
casing: replace "nemoclaw" with "NemoClaw", "openclaw always-on assistants" with
"OpenClaw always-on assistants" (or "OpenClaw" if trimming), and change "nvidia
openshell" and "nvidia nemotron" to "NVIDIA OpenShell" and "NVIDIA Nemotron"
respectively; ensure the `keywords` array preserves the same items but with
exact casing and punctuation as per the style guide.
- Line 23: Split the sentence that begins with "NVIDIA NemoClaw is an open
source reference stack..." into one sentence per source line, and rewrite
reader-directed parts to use second person ("you") instead of "users" — e.g.,
turn "giving users control over their agents' behavior and data handling" into
"giving you control over your agents' behavior and data handling." Ensure each
sentence ends on its own line and preserve the original meaning about
policy-based privacy/security guardrails and deployment targets (clouds, on
prem, RTX PCs, and DGX Spark).
In `@docs/index.md`:
- Line 6: Update the keywords metadata array so product names use the canonical
casing: replace "nemoclaw" with "NemoClaw", "openclaw always-on assistants" with
"OpenClaw always-on assistants" (or adjust the token to "OpenClaw" if you prefer
single keywords), "nvidia openshell" with "NVIDIA OpenShell" (ensure NVIDIA is
all caps) and "nvidia nemotron" with "NVIDIA Nemotron"; edit the keywords array
defined as keywords: [...] in the docs/index.md frontmatter to apply these exact
replacements.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 499cc6ce-6202-44bc-9948-21c7fba747d0
📒 Files selected for processing (5)
README.mddocs/about/how-it-works.mddocs/about/overview.mddocs/about/release-notes.mddocs/index.md
✅ Files skipped from review due to trivial changes (2)
- docs/about/release-notes.md
- docs/about/how-it-works.md
Merged
16 tasks
Ryuketsukami
pushed a commit
to Ryuketsukami/NemoClaw
that referenced
this pull request
Mar 24, 2026
* update messaging * bring the intro sentence back
jessesanford
pushed a commit
to jessesanford/NemoClaw
that referenced
this pull request
Mar 24, 2026
* update messaging * bring the intro sentence back
mafueee
pushed a commit
to mafueee/NemoClaw
that referenced
this pull request
Mar 28, 2026
wscurran
added
area: docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit