Skip to content

docs: remove duplicated content in README#443

Merged
kjw3 merged 2 commits intomainfrom
miyoungc-patch-3
Mar 19, 2026
Merged

docs: remove duplicated content in README#443
kjw3 merged 2 commits intomainfrom
miyoungc-patch-3

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Mar 19, 2026

Rephrase note about using CLI for long responses.

Summary by CodeRabbit

  • Documentation
    • Clarified guidance to use the CLI for long responses and noted the CLI prints complete output in the terminal (avoiding the TUI for large outputs).
    • Removed explicit documentation URLs, replacing them with references to the “NVIDIA Agent Toolkit” in overview and index content.

Rephrase note about using CLI for long responses.
@miyoungc miyoungc self-assigned this Mar 19, 2026
@miyoungc miyoungc added the documentation Improvements or additions to documentation label Mar 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

📝 Walkthrough

Walkthrough

Edited documentation across three files to remove an explicit NVIDIA docs URL and to simplify TUI/CLI guidance: README adjusted to remove an inline CLI code block from a TUI note and add a sentence clarifying the CLI prints full responses; two docs pages updated to replace a linked “NVIDIA Agent Toolkit” reference with plain text.

Changes

Cohort / File(s) Summary
README adjustments
README.md
Removed embedded CLI code block from the TUI note; moved/added a sentence stating the CLI prints complete responses and is preferable for long outputs.
Docs text cleanup
docs/about/overview.md, docs/index.md
Replaced explicit linked URL to the NVIDIA documentation with unlinked plain text "NVIDIA Agent Toolkit" while preserving surrounding descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through docs with nimble paws,
Cleared a link and tuned some clause,
Moved a note where it could be seen,
CLI prints wide — the TUI stays lean. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title references 'duplicated content in README' but the changes actually involve removing external documentation links across multiple files (README.md, docs/about/overview.md, and docs/index.md), not removing duplicated content within the README itself. Update the title to accurately reflect the main change, such as 'docs: remove NVIDIA Agent Toolkit documentation links' or 'docs: unlink NVIDIA Agent Toolkit references'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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 miyoungc-patch-3
📝 Coding Plan
  • Generate coding plan for human review comments

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: 2

🧹 Nitpick comments (3)
docs/index.md (1)

29-29: Consider hyphenating compound adjectives.

When "open source" modifies a noun, standard English style guides recommend hyphenating it as "open-source". This applies to "open-source models" in this line. While this is a pre-existing style choice rather than an error introduced by this PR, addressing it would align with conventional grammar.

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

In `@docs/index.md` at line 29, Change the compound adjective "open source models"
to the hyphenated form "open-source models" in the sentence that reads "It
installs the NVIDIA OpenShell runtime... and open source models like NVIDIA
Nemotron" inside the docs/index.md content so the phrase uses the standard
hyphenated compound-adjective form.
docs/about/overview.md (1)

25-25: Consider hyphenating compound adjectives.

This line contains "open source models" in two places. When "open source" modifies a noun, standard English style guides recommend hyphenating it as "open-source". While this is a pre-existing style choice rather than an error introduced by this PR, addressing it would align with conventional grammar.

🤖 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, Replace instances of the adjective phrase
"open source" with the hyphenated form "open-source" where it modifies a noun
(e.g., change both occurrences of "open source models" in the sentence that
references NVIDIA Nemotron and NVIDIA OpenShell to "open-source models") to
conform to standard compound-adjective style; ensure any other occurrences in
the same paragraph follow the same hyphenation rule.
README.md (1)

9-9: Consider hyphenating compound adjectives.

This line contains "open source reference stack" and "open source models". When "open source" modifies a noun, standard English style guides recommend hyphenating it as "open-source". While this is a pre-existing style choice, addressing it would align with conventional grammar.

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

In `@README.md` at line 9, Update the README sentence that currently reads "NVIDIA
NemoClaw is an open source reference stack..." to hyphenate compound adjectives:
change "open source reference stack" to "open-source reference stack" and "open
source models" to "open-source models" so both adjective phrases are
grammatically correct in the line containing "NVIDIA NemoClaw is an open source
reference stack that simplifies running... and open source models such as NVIDIA
Nemotron".
🤖 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/index.md`:
- Line 29: The phrase in docs/index.md uses "part of NVIDIA Agent Toolkit" which
is inconsistent with docs/about/overview.md; update the sentence referencing
"NVIDIA Agent Toolkit" (the line containing "NVIDIA OpenShell") to use the
definite article so it reads "part of the NVIDIA Agent Toolkit" to match the
other doc and maintain consistency across documentation.

In `@README.md`:
- Line 9: The sentence in README.md that reads "part of NVIDIA Agent Toolkit" is
inconsistent with docs/about/overview.md; update that phrase to "part of the
NVIDIA Agent Toolkit" in the README sentence mentioning "NVIDIA OpenShell" so
the definite article is added and documentation remains consistent.

---

Nitpick comments:
In `@docs/about/overview.md`:
- Line 25: Replace instances of the adjective phrase "open source" with the
hyphenated form "open-source" where it modifies a noun (e.g., change both
occurrences of "open source models" in the sentence that references NVIDIA
Nemotron and NVIDIA OpenShell to "open-source models") to conform to standard
compound-adjective style; ensure any other occurrences in the same paragraph
follow the same hyphenation rule.

In `@docs/index.md`:
- Line 29: Change the compound adjective "open source models" to the hyphenated
form "open-source models" in the sentence that reads "It installs the NVIDIA
OpenShell runtime... and open source models like NVIDIA Nemotron" inside the
docs/index.md content so the phrase uses the standard hyphenated
compound-adjective form.

In `@README.md`:
- Line 9: Update the README sentence that currently reads "NVIDIA NemoClaw is an
open source reference stack..." to hyphenate compound adjectives: change "open
source reference stack" to "open-source reference stack" and "open source
models" to "open-source models" so both adjective phrases are grammatically
correct in the line containing "NVIDIA NemoClaw is an open source reference
stack that simplifies running... and open source models such as NVIDIA
Nemotron".

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 32c83866-f32d-4722-a618-a2a1c643da00

📥 Commits

Reviewing files that changed from the base of the PR and between 3f852bc and be501f8.

📒 Files selected for processing (3)
  • README.md
  • docs/about/overview.md
  • docs/index.md

Comment thread docs/index.md

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 like [NVIDIA Nemotron](https://build.nvidia.com).
It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models like [NVIDIA Nemotron](https://build.nvidia.com).
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

Inconsistent article usage before "NVIDIA Agent Toolkit".

This line uses "part of NVIDIA Agent Toolkit" while docs/about/overview.md line 25 uses "part of the NVIDIA Agent Toolkit" (with "the"). For consistency across documentation, these references should match. The version with the definite article ("the NVIDIA Agent Toolkit") is grammatically preferable when referring to a specific product.

Proposed fix for consistency
-It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models like [NVIDIA Nemotron](https://build.nvidia.com).
+It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of the NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models like [NVIDIA Nemotron](https://build.nvidia.com).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models like [NVIDIA Nemotron](https://build.nvidia.com).
It installs the [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell) runtime, part of the NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models like [NVIDIA Nemotron](https://build.nvidia.com).
🧰 Tools
🪛 LanguageTool

[grammar] ~29-~29: Use a hyphen to join words.
Context: ... for running autonomous agents, and open source models like [NVIDIA Nemotron](htt...

(QB_NEW_EN_HYPHEN)

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

In `@docs/index.md` at line 29, The phrase in docs/index.md uses "part of NVIDIA
Agent Toolkit" which is inconsistent with docs/about/overview.md; update the
sentence referencing "NVIDIA Agent Toolkit" (the line containing "NVIDIA
OpenShell") to use the definite article so it reads "part of the NVIDIA Agent
Toolkit" to match the other doc and maintain consistency across documentation.

Comment thread README.md
<!-- end-badges -->

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, a secure environment for running autonomous agents, and open source models such as [NVIDIA Nemotron](https://build.nvidia.com).
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

Inconsistent article usage before "NVIDIA Agent Toolkit".

This line uses "part of NVIDIA Agent Toolkit" while docs/about/overview.md line 25 uses "part of the NVIDIA Agent Toolkit" (with "the"). For consistency across all documentation, consider adding the definite article to match the docs version.

Proposed fix for consistency
-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, 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 the NVIDIA Agent Toolkit, a secure environment for running autonomous agents, and open source models such as [NVIDIA Nemotron](https://build.nvidia.com).
🧰 Tools
🪛 LanguageTool

[grammar] ~9-~9: Use a hyphen to join words.
Context: ...d-badges --> NVIDIA NemoClaw is an open source reference stack that simplifies r...

(QB_NEW_EN_HYPHEN)


[grammar] ~9-~9: Use a hyphen to join words.
Context: ... for running autonomous agents, and open source models such as [NVIDIA Nemotron](...

(QB_NEW_EN_HYPHEN)

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

In `@README.md` at line 9, The sentence in README.md that reads "part of NVIDIA
Agent Toolkit" is inconsistent with docs/about/overview.md; update that phrase
to "part of the NVIDIA Agent Toolkit" in the README sentence mentioning "NVIDIA
OpenShell" so the definite article is added and documentation remains
consistent.

Copy link
Copy Markdown
Contributor

@kjw3 kjw3 left a comment

Choose a reason for hiding this comment

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

Let it rip 🤙

@kjw3 kjw3 merged commit 16fb337 into main Mar 19, 2026
4 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* docs: remove duplicated content in README 

Rephrase note about using CLI for long responses.

* rm link
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* docs: remove duplicated content in README 

Rephrase note about using CLI for long responses.

* rm link
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