docs: add coding-agent CLI guidance#97
Conversation
WalkthroughDocumentation-only PR introducing the experimental ChangesCoding-Agent CLI Gateway Documentation
🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 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)
Comment |
AjayThorve
force-pushed
the
docs/closed-harness-cli-support
branch
from
fe47319 to
caa64da
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@crates/cli/README.md`:
- Line 106: Update the heading "Benchmark And Eval Runs" to follow title case
rules by lowercasing the conjunction: change it to "Benchmark and Eval Runs" so
"and" is lowercase (adjust the heading text in the README where the heading
"Benchmark And Eval Runs" appears).
In `@docs/getting-started/cli.md`:
- Around line 160-161: Add a complete lead-in sentence immediately under the
"Next Steps" heading describing what the reader will find in the following links
(e.g., a short sentence like "The following guides walk you through advanced
setup and integration options:") so the bulleted list that includes "Advanced
Guide: Coding-Agent Gateway" has a prose introduction; update the paragraph text
directly above the existing list in docs/getting-started/cli.md near the "Next
Steps" heading.
In `@docs/integrate-frameworks/coding-agent-gateway.md`:
- Line 169: Replace the single-word lead "Example:" with a complete introductory
sentence that clearly introduces the following configuration code block (e.g.,
"The following example demonstrates how to configure the Coding Agent
Gateway:"); update the line containing "Example:" in the
docs/integrate-frameworks/coding-agent-gateway.md so the sentence succinctly
describes what the snippet shows and flows grammatically into the code block.
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: 1998f3a9-f344-4270-a7b2-ea335543d9ba
📒 Files selected for processing (11)
README.mdcrates/cli/README.mddocs/getting-started/cli.mddocs/getting-started/configuration.mddocs/getting-started/quick-start.mddocs/index.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-hermes.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (24)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as 'here' or 'read more.'
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/integrate-frameworks/coding-agent-cursor.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/integrate-frameworks/coding-agent-cursor.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mdcrates/cli/README.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/getting-started/quick-start.mddocs/integrate-frameworks/coding-agent-codex.mddocs/index.mddocs/getting-started/configuration.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.md
docs/integrate-frameworks/**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage of the integration changed
Files:
docs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/integrate-frameworks/coding-agent-cursor.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Relevant package or crate README.md files must be updated when examples or binding guidance changes
Files:
crates/cli/README.mdREADME.md
{README.md,docs/index.md,**/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation (README.md, docs/index.md, package READMEs, binding-level source READMEs) whenever public behavior changes
Files:
crates/cli/README.mddocs/index.mdREADME.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
{README.md,docs/index.md}: Update entry-point docs when examples or reading paths change
README.md or docs/index.md must be updated when entry points change
Files:
docs/index.mdREADME.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update README.md to reflect current workspace members and top-level documentation for changes affecting public behavior, bindings, examples, or workspace structure
Files:
README.md
🔇 Additional comments (10)
docs/getting-started/quick-start.md (1)
16-16: LGTM!docs/index.md (1)
59-59: LGTM!docs/integrate-frameworks/coding-agent-codex.md (1)
22-32: LGTM!Also applies to: 51-56, 67-76
README.md (1)
117-118: LGTM!Also applies to: 132-132, 167-167
crates/cli/README.md (1)
54-58: LGTM!Also applies to: 107-138, 142-164
docs/integrate-frameworks/coding-agent-claude-code.md (1)
15-21: LGTM!Also applies to: 43-48, 56-68
docs/integrate-frameworks/coding-agent-cursor.md (1)
24-30: LGTM!Also applies to: 51-56, 64-74
docs/getting-started/configuration.md (1)
54-107: LGTM!docs/integrate-frameworks/coding-agent-gateway.md (1)
1-347: LGTM!docs/getting-started/cli.md (1)
1-166: LGTM!
| nemo-flow run --agent codex --dry-run | ||
| ``` | ||
|
|
||
| ## Benchmark And Eval Runs |
There was a problem hiding this comment.
Use lowercase for conjunctions in title case headings.
The heading uses "Benchmark And Eval Runs" but standard title case rules require conjunctions like "and" to be lowercase unless they are the first or last word. As per coding guidelines, use title case consistently in technical documentation headings.
Proposed fix
-## Benchmark And Eval Runs
+## Benchmark and Eval Runs📝 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.
| ## Benchmark And Eval Runs | |
| ## Benchmark and Eval Runs |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@crates/cli/README.md` at line 106, Update the heading "Benchmark And Eval
Runs" to follow title case rules by lowercasing the conjunction: change it to
"Benchmark and Eval Runs" so "and" is lowercase (adjust the heading text in the
README where the heading "Benchmark And Eval Runs" appears).
|
|
||
| - [Advanced Guide: Coding-Agent Gateway](../integrate-frameworks/coding-agent-gateway.md) |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Add a lead-in sentence before the links list.
The "Next Steps" section jumps directly from the heading to a list of links without a prose introduction.
Suggested improvement
## Next Steps
+Refer to the following guides for detailed configuration and agent-specific setup:
+
- [Advanced Guide: Coding-Agent Gateway](../integrate-frameworks/coding-agent-gateway.md)As per coding guidelines, "All lists should have a complete lead-in sentence."
📝 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.
| - [Advanced Guide: Coding-Agent Gateway](../integrate-frameworks/coding-agent-gateway.md) | |
| ## Next Steps | |
| Refer to the following guides for detailed configuration and agent-specific setup: | |
| - [Advanced Guide: Coding-Agent Gateway](../integrate-frameworks/coding-agent-gateway.md) |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting-started/cli.md` around lines 160 - 161, Add a complete lead-in
sentence immediately under the "Next Steps" heading describing what the reader
will find in the following links (e.g., a short sentence like "The following
guides walk you through advanced setup and integration options:") so the
bulleted list that includes "Advanced Guide: Coding-Agent Gateway" has a prose
introduction; update the paragraph text directly above the existing list in
docs/getting-started/cli.md near the "Next Steps" heading.
| - `$XDG_CONFIG_HOME/nemo-flow/config.toml`, or | ||
| `~/.config/nemo-flow/config.toml` | ||
|
|
||
| Example: |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Use a complete lead-in sentence before the code block.
Replace the single-word "Example:" with a complete sentence that introduces the configuration example.
Suggested improvement
-Example:
+The following example shows a complete shared configuration:As per coding guidelines, "Introduce every code block with a complete sentence."
📝 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.
| Example: | |
| The following example shows a complete shared configuration: |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/integrate-frameworks/coding-agent-gateway.md` at line 169, Replace the
single-word lead "Example:" with a complete introductory sentence that clearly
introduces the following configuration code block (e.g., "The following example
demonstrates how to configure the Coding Agent Gateway:"); update the line
containing "Example:" in the docs/integrate-frameworks/coding-agent-gateway.md
so the sentence succinctly describes what the snippet shows and flows
grammatically into the code block.
Signed-off-by: Ajay Thorve <athorve@nvidia.com>
AjayThorve
force-pushed
the
docs/closed-harness-cli-support
branch
from
caa64da to
8886cfb
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/rust.md`:
- Around line 42-47: The "Install from a Package Manager" section currently
contains a source-checkout command ("cargo install --path
../NeMo-Flow/crates/cli") which is contradictory; replace that line with the
published-crate install command (e.g., "cargo install <crate-name>") or remove
it entirely, and if you still want to show source-checkout usage move the exact
"cargo install --path ../NeMo-Flow/crates/cli" snippet into the "Install from
Source" section; ensure the final package-manager example uses the correct
crates.io package name for the gateway CLI.
In `@docs/integrate-frameworks/coding-agent-gateway.md`:
- Line 119: The heading "Benchmark And Eval Runs" uses incorrect title casing
for the conjunction; update the heading text in the document from "Benchmark And
Eval Runs" to "Benchmark and Eval Runs" (locate the exact heading string
"Benchmark And Eval Runs" and replace it) so the heading follows consistent
title case rules across the docs.
In `@README.md`:
- Around line 116-117: Update the README sentence that currently reads
"Experimental CLI gateway docs are available for local coding-agent
observability." to make the first mention of the CLI docs a markdown link:
replace the plain phrase "experimental CLI gateway docs" with a link to the
canonical CLI gateway documentation page (e.g., the project docs path or URL for
the CLI gateway) so the first occurrence of that product/document is clickable;
keep the remainder of the sentence unchanged and ensure no subsequent duplicate
linking of the same phrase elsewhere.
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: b1fb57cb-d7d2-492d-a492-0516f84715f3
📒 Files selected for processing (13)
README.mdcrates/cli/README.mddocs/getting-started/cli.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-hermes.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (24)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as 'here' or 'read more.'
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mdcrates/cli/README.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-codex.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mdREADME.mddocs/getting-started/cli.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/configuration.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
{README.md,docs/index.md}: Update entry-point docs when examples or reading paths change
README.md or docs/index.md must be updated when entry points change
Files:
docs/index.mdREADME.md
{README.md,docs/index.md,**/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation (README.md, docs/index.md, package READMEs, binding-level source READMEs) whenever public behavior changes
Files:
docs/index.mdcrates/cli/README.mdREADME.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Relevant package or crate README.md files must be updated when examples or binding guidance changes
Files:
crates/cli/README.mdREADME.md
docs/integrate-frameworks/**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage of the integration changed
Files:
docs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-hermes.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update README.md to reflect current workspace members and top-level documentation for changes affecting public behavior, bindings, examples, or workspace structure
Files:
README.md
🔇 Additional comments (11)
crates/cli/README.md (1)
99-99: Previously flagged heading capitalization issue is still present.docs/getting-started/cli.md (1)
160-166: Previously flagged missing lead-in sentence before this list is still unresolved.docs/getting-started/configuration.md (1)
54-107: LGTM!docs/integrate-frameworks/coding-agent-codex.md (1)
22-29: LGTM!Also applies to: 51-56, 67-68, 75-76
docs/integrate-frameworks/coding-agent-claude-code.md (1)
15-22: LGTM!Also applies to: 43-48, 56-60, 67-68
docs/integrate-frameworks/coding-agent-cursor.md (1)
24-31: LGTM!Also applies to: 51-56, 64-66, 73-74
docs/integrate-frameworks/coding-agent-hermes.md (1)
20-28: LGTM!Also applies to: 50-55, 63-67, 74-75
docs/getting-started/quick-start.md (1)
16-16: LGTM!docs/index.md (1)
59-59: LGTM!docs/getting-started/installation.md (2)
50-52: LGTM!
106-111: LGTM!
| Use `--dry-run --print` to inspect the generated hook config, gateway | ||
| environment, gateway URL, and final command without launching the agent. | ||
|
|
||
| ## Benchmark And Eval Runs |
There was a problem hiding this comment.
Fix heading title case for conjunctions.
Change Benchmark And Eval Runs to Benchmark and Eval Runs for consistent title case.
As per coding guidelines, "Use title case consistently in technical documentation headings."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/integrate-frameworks/coding-agent-gateway.md` at line 119, The heading
"Benchmark And Eval Runs" uses incorrect title casing for the conjunction;
update the heading text in the document from "Benchmark And Eval Runs" to
"Benchmark and Eval Runs" (locate the exact heading string "Benchmark And Eval
Runs" and replace it) so the heading follows consistent title case rules across
the docs.
| The primary documentation track covers Rust, Python, and Node.js. Experimental | ||
| CLI gateway docs are available for local coding-agent observability. |
There was a problem hiding this comment.
Link the First Mention of CLI Gateway Documentation
Line 116 introduces the experimental CLI docs but does not link to the destination. Add a direct link at first mention to improve navigation.
As per coding guidelines, "Link the first mention of a product name when the destination helps the reader."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 116 - 117, Update the README sentence that currently
reads "Experimental CLI gateway docs are available for local coding-agent
observability." to make the first mention of the CLI docs a markdown link:
replace the plain phrase "experimental CLI gateway docs" with a link to the
canonical CLI gateway documentation page (e.g., the project docs path or URL for
the CLI gateway) so the first occurrence of that product/document is clickable;
keep the remainder of the sentence unchanged and ensure no subsequent duplicate
linking of the same phrase elsewhere.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
crates/cli/README.md (1)
100-100:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse lowercase for the conjunction in the title case heading.
The heading uses "Benchmark And Eval Runs" but title case requires conjunctions like "and" to be lowercase unless they are the first or last word.
Proposed fix
-## Benchmark And Eval Runs +## Benchmark and Eval RunsAs per coding guidelines, use title case consistently in technical documentation headings.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@crates/cli/README.md` at line 100, Change the heading text "Benchmark And Eval Runs" to use lowercase for the conjunction by replacing it with "Benchmark and Eval Runs" so the title-case heading follows the project's style; locate the heading string "Benchmark And Eval Runs" in the README and update it to "Benchmark and Eval Runs".README.md (1)
117-118:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winLink the first mention of CLI gateway documentation.
Line 118 introduces "experimental CLI gateway docs" but does not link to the destination. Add a direct link at first mention to improve navigation.
Proposed fix
-The primary documentation track covers Rust, Python, and Node.js. Experimental -CLI gateway docs are available for local coding-agent observability. +The primary documentation track covers Rust, Python, and Node.js. [Experimental +CLI gateway docs](https://nvidia.github.io/NeMo-Flow/getting-started/cli.html) are available for local coding-agent observability.As per coding guidelines, link the first mention of a product name when the destination helps the reader.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 117 - 118, Update the first mention of "experimental CLI gateway docs" in the README by turning that phrase into a Markdown link to the CLI gateway documentation (e.g., docs/cli-gateway.md or the canonical URL for the CLI gateway docs) so the first occurrence is directly clickable; edit the sentence containing the exact phrase "experimental CLI gateway docs" to wrap it in the link and keep the existing wording otherwise.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/cli.md`:
- Line 13: Update the three headings to use consistent title case by lowercasing
articles mid-title: change "Install The CLI" to "Install the CLI", "Use The
Wizard" to "Use the Wizard" (if not first/last word lowercase 'the'), and "Run
An Observed Agent" to "Run an Observed Agent"; locate and edit the heading
strings in the document (search for the exact heading text) to apply these
normalized title-case forms.
---
Duplicate comments:
In `@crates/cli/README.md`:
- Line 100: Change the heading text "Benchmark And Eval Runs" to use lowercase
for the conjunction by replacing it with "Benchmark and Eval Runs" so the
title-case heading follows the project's style; locate the heading string
"Benchmark And Eval Runs" in the README and update it to "Benchmark and Eval
Runs".
In `@README.md`:
- Around line 117-118: Update the first mention of "experimental CLI gateway
docs" in the README by turning that phrase into a Markdown link to the CLI
gateway documentation (e.g., docs/cli-gateway.md or the canonical URL for the
CLI gateway docs) so the first occurrence is directly clickable; edit the
sentence containing the exact phrase "experimental CLI gateway docs" to wrap it
in the link and keep the existing wording otherwise.
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: 7f6ee098-a22b-4815-bb79-995f3b2d90a3
📒 Files selected for processing (13)
README.mdcrates/cli/README.mddocs/getting-started/cli.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/index.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-hermes.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (24)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as 'here' or 'read more.'
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
{README.md,docs/index.md}: Update entry-point docs when examples or reading paths change
README.md or docs/index.md must be updated when entry points change
Files:
docs/index.mdREADME.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
{docs/**,examples/**,crates/adaptive/**,python/nemo_flow/**,go/nemo_flow/**,**/{example,component}.{ts,tsx,js,rs,py,go}}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Any new adaptive component kind must have documentation, examples, and binding coverage across all supported languages
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
{README.md,docs/index.md,**/README.md}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Update entry-point documentation (README.md, docs/index.md, package READMEs, binding-level source READMEs) whenever public behavior changes
Files:
docs/index.mdREADME.mdcrates/cli/README.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mdcrates/cli/README.mddocs/getting-started/cli.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/index.mddocs/getting-started/quick-start.mddocs/getting-started/rust.mddocs/getting-started/configuration.mddocs/getting-started/installation.mdREADME.mddocs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.mddocs/getting-started/cli.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update README.md to reflect current workspace members and top-level documentation for changes affecting public behavior, bindings, examples, or workspace structure
Files:
README.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Relevant package or crate README.md files must be updated when examples or binding guidance changes
Files:
README.mdcrates/cli/README.md
docs/integrate-frameworks/**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage of the integration changed
Files:
docs/integrate-frameworks/coding-agent-cursor.mddocs/integrate-frameworks/coding-agent-claude-code.mddocs/integrate-frameworks/coding-agent-gateway.mddocs/integrate-frameworks/coding-agent-codex.mddocs/integrate-frameworks/coding-agent-hermes.md
🪛 LanguageTool
docs/getting-started/rust.md
[style] ~28-~28: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... learning components. - nemo-flow-cli is a binary crate. Use `cargo install nemo...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (14)
docs/getting-started/rust.md (1)
28-29: LGTM!Also applies to: 42-47
crates/cli/README.md (1)
102-132: LGTM!docs/getting-started/quick-start.md (1)
16-16: LGTM!docs/index.md (1)
59-59: LGTM!README.md (1)
132-132: LGTM!Also applies to: 167-167
docs/integrate-frameworks/coding-agent-codex.md (1)
22-32: LGTM!Also applies to: 51-56, 67-77
docs/getting-started/installation.md (1)
50-52: LGTM!Also applies to: 106-110
docs/integrate-frameworks/coding-agent-cursor.md (1)
24-56: LGTM!Also applies to: 64-74
docs/integrate-frameworks/coding-agent-gateway.md (2)
119-119: Heading title case is still inconsistent.This is the same unresolved finding already raised earlier for this section heading.
169-169: Code block lead-in is still incomplete.This is the same unresolved finding already raised earlier (
Example:should be a complete sentence).docs/getting-started/cli.md (1)
153-155: The links list still needs a lead-in sentence.This is the same unresolved finding already raised earlier for the Next Steps section.
docs/integrate-frameworks/coding-agent-claude-code.md (1)
15-19: LGTM!Also applies to: 43-48, 56-68
docs/integrate-frameworks/coding-agent-hermes.md (1)
20-25: LGTM!Also applies to: 50-55, 63-75
docs/getting-started/configuration.md (1)
54-107: LGTM!
| CLI can configure supported agent hooks, start a short-lived gateway around one | ||
| agent run, run a long-running gateway, and diagnose local setup. | ||
|
|
||
| ## Install The CLI |
There was a problem hiding this comment.
Normalize heading title case for articles.
Headings capitalize The mid-title (Install The CLI, Use The Wizard, Run An Observed Agent), which is inconsistent with standard title case used elsewhere in the docs.
As per coding guidelines, "Use title case consistently in technical documentation headings."
Also applies to: 23-23, 48-48
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting-started/cli.md` at line 13, Update the three headings to use
consistent title case by lowercasing articles mid-title: change "Install The
CLI" to "Install the CLI", "Use The Wizard" to "Use the Wizard" (if not
first/last word lowercase 'the'), and "Run An Observed Agent" to "Run an
Observed Agent"; locate and edit the heading strings in the document (search for
the exact heading text) to apply these normalized title-case forms.
|
closing in favor of #98 |
1 participant
Overview
Adds user-facing documentation for the experimental Coding-Agent CLI, including setup, config layering, per-agent launch guidance, and benchmark/eval run examples.
Details
plugin.toml, and advancedrun/daemon commands.[exporters.*]config shape,plugin.tomlbehavior, and benchmark/eval run guidance.runfor deterministic scripted use.Validation:
just docspassed.git diff --checkpassed.lycheeskipped; the full lychee run fails on unchanged generated Rust API links indocs/reference/api/rust/_generated/nemo-flow-adaptive/....Where should the reviewer start?
Start with
docs/getting-started/cli.md, then reviewdocs/integrate-frameworks/coding-agent-gateway.mdfor the shared config and benchmark/eval guidance.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit