docs(cli): document coding-agent gateway bootstrap#409
Conversation
github-actions
Bot
added
size:XL
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThe PR revises documentation for persistent Claude Code, Codex, and Hermes integrations, replacing plugin-shim guidance with native MCP lifecycle clients, shared gateway behavior, trusted hook forwarding, installation and diagnosis commands, transparent-run semantics, and updated observability configuration. ChangesPersistent installation model
Hook contracts and forwarding
Hermes MCP integration
Plugin integrity and observability
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
willkill07
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 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`:
- Around line 52-57: Add a complete lead-in sentence immediately after the “What
You Get” heading and before the first bullet, such as “The CLI provides the
following:”. Keep the existing list items unchanged.
In `@docs/about-nemo-relay/release-notes/known-issues.mdx`:
- Around line 12-25: Add the required lead-in sentence, “These notes apply to
the NVIDIA NeMo Relay 0.6 release.”, immediately after the “NVIDIA NeMo Relay
0.6” heading and before its existing issue bullets.
In `@docs/nemo-relay-cli/codex.mdx`:
- Line 288: Rephrase the sentence containing “The required generated set” to
remove the awkward double modifier, while preserving the meaning that
SessionStart and UserPromptSubmit are required generated items.
In `@docs/nemo-relay-cli/plugin-installation.mdx`:
- Around line 192-195: Update the Windows Job Object notes in
docs/nemo-relay-cli/plugin-installation.mdx:192-195 and
docs/nemo-relay-cli/codex.mdx:117-119 to document the third outcome: if
breakaway is unavailable and the host rejects nested job assignment, persistent
bootstrap fails with an actionable error rather than running without
process-tree cleanup guarantees. Keep the existing scoped-to-host-job behavior
for hosts that permit nested assignment.
- Around line 336-337: Update the table header row near the “Removed internal
command” entries to use title case: capitalize each word in both headers,
“Removed Internal Command” and “Public Replacement,” matching the table-header
style used elsewhere on the page.
- Around line 186-190: Update the exactly-once delivery caveat in the documented
crash-consistency discussion to remove the dangling “below” reference. Make the
sentence self-contained while preserving its distinction between opt-in E2E
assertions for healthy and cold-start paths and unsupported arbitrary crash
scenarios.
In `@integrations/coding-agents/claude-code/README.md`:
- Around line 220-224: Clarify the recovery statement in the hook forwarding
documentation by identifying it as the installed/generated hook command. Update
the corresponding text near the source-hook explanation and the later recovery
section so `--forward-only` source hooks are not described as launching or
recovering Relay, while installed hooks retain their documented recovery
behavior.
In `@integrations/coding-agents/README.md`:
- Around line 73-142: In the “MCP bootstrap” paragraph, update the phrase
“Legacy generated mcp --agent <agent> entries” to hyphenate “legacy-generated,”
leaving the surrounding installation behavior and wording unchanged.
- Around line 236-271: In the hook-forwarding failure description, replace “may
be missing from telemetry” with “can be missing from telemetry” to express
possibility while preserving the surrounding fail-open behavior and wording.
In `@README.md`:
- Around line 116-118: Add a complete lead-in sentence, “For Hermes, run:”,
immediately before the fenced command block containing the nemo-relay hermes
example, without changing the command itself.
🪄 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: 2d846d0f-712e-4b9d-8bbe-44fe6dd52dad
📒 Files selected for processing (16)
README.mdcrates/cli/README.mddocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Rust / Test (windows-arm64)
🧰 Additional context used
📓 Path-based instructions (21)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxcrates/cli/README.mdREADME.mddocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxcrates/cli/README.mdREADME.mddocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxcrates/cli/README.mdREADME.mddocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/getting-started/quick-start/index.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
{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/index.mdxdocs/about-nemo-relay/release-notes/index.mdxREADME.mddocs/getting-started/installation.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdx
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update onlydocs/about-nemo-relay/release-notes/index.mdx,docs/about-nemo-relay/release-notes/highlights.mdx, anddocs/about-nemo-relay/release-notes/known-issues.mdxunless the release changes their route or entry points.
Preserve the existing MDX front matter and the JSX SPDX comment in the release-notes pages.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
**/*.{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:
crates/cli/README.mdREADME.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.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:
crates/cli/README.mdREADME.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 docs.
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 docs unless the source, platform, or legal guidance explicitly requires them.
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: 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
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references 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
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
{README.md,docs/**/*.{md,rst,txt},fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Search and update documentation source for references to the old version in
README.md,docs, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.md
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update entry-point docs when examples or reading paths change
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.
Files:
README.md
{crates/core/src/plugin/dynamic/**,crates/plugin/**,crates/worker/**,crates/worker-proto/**,crates/types/**,python/plugin/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Keep the stable boundary explicit: native plugins cross a C ABI, and worker plugins cross
grpc-v1.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{crates/core/src/plugin/dynamic/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Native and worker plugins are trusted extensions; document that native plugins are in-process and unsandboxed, and worker plugins provide process isolation but not a security sandbox.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{docs/build-plugins/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
When detailed dynamic plugin guides exist, keep Rust native, Python worker, and
grpc-v1protocol details on separate pages.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
docs/about-nemo-relay/release-notes/known-issues.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/known-issues.mdx: Inknown-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit it.
Inknown-issues.mdx, keep the complete fixed-item history recorded in earlier release-note pages.
Files:
docs/about-nemo-relay/release-notes/known-issues.mdx
🪛 LanguageTool
README.md
[uncategorized] ~128-~128: Ne zlefe ket bezañ ur c’hemmadur dre vlotaat amañ.
Context: ...nemo-relay-plugin@nemo-relay-local`. It does not trust unrelated user, > project, or...
(FAZ_KEMM)
integrations/coding-agents/README.md
[grammar] ~110-~110: Use a hyphen to join words.
Context: ...te each host's canonical payload. Legacy generated mcp --agent <agent> entries ...
(QB_NEW_EN_HYPHEN)
docs/nemo-relay-cli/basic-usage.mdx
[style] ~372-~372: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lay-config-profile. - --gateway-modesetsx-nemo-relay-gateway-mode. - --fail-...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/nemo-relay-cli/codex.mdx
[style] ~288-~288: The double modal “required generated” is nonstandard (only accepted in certain dialects). Consider “to be generated”.
Context: ...eway. ## Captured Events The required generated set includes SessionStart, `UserPromp...
(NEEDS_FIXED)
🔇 Additional comments (18)
README.md (1)
45-45: LGTM!Also applies to: 104-104, 120-120, 122-135, 299-300
crates/cli/README.md (1)
110-115: LGTM!docs/getting-started/installation.mdx (1)
64-74: LGTM!Also applies to: 234-245
docs/getting-started/quick-start/index.mdx (1)
29-29: LGTM!integrations/coding-agents/claude-code/README.md (3)
8-10: LGTM!Also applies to: 19-21, 56-64, 180-189, 202-208, 251-251, 274-277
31-35: 🎯 Functional CorrectnessThe
2.1.121floor matches the CLI gate and doctor remediation, includingalwaysLoadand the generated-hook-schema requirement.
311-311: 🎯 Functional Correctness
nemo-relay install claude-code --forceis valid.--forceis already wired into the install command and drives the fenced replacement path for existing Claude Code installs.> Likely an incorrect or invalid review comment.docs/about-nemo-relay/release-notes/index.mdx (1)
60-60: LGTM!docs/about-nemo-relay/release-notes/known-issues.mdx (1)
35-36: 🎯 Functional CorrectnessConfirm the removed Codex limitation is fixed before deleting it.
The prior note about first-request capture is gone, but the new 0.6 text documents
/modelsretries and readiness rather than explicitly guaranteeing first-provider-request capture. Verify the runtime behavior or retain the limitation with a versioned resolution note.As per path instructions, release notes and known issues must remain technically accurate and consistent with current behavior.
Source: Path instructions
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (1)
214-221: LGTM!Also applies to: 238-244
docs/nemo-relay-cli/about.mdx (1)
23-38: LGTM!Also applies to: 59-76
docs/nemo-relay-cli/plugin-installation.mdx (1)
2-51: LGTM!Also applies to: 61-72, 245-275, 284-291, 372-376
integrations/coding-agents/README.md (1)
26-39: LGTM!Also applies to: 55-58, 152-162, 173-197, 303-316
integrations/coding-agents/codex/README.md (1)
16-131: LGTM!Also applies to: 144-152, 163-165, 193-218, 256-268, 295-298, 313-326, 373-374, 387-415, 429-441
docs/nemo-relay-cli/codex.mdx (1)
17-31: LGTM!Also applies to: 51-59, 183-189, 199-199, 214-242, 323-343, 356-362
docs/nemo-relay-cli/basic-usage.mdx (1)
57-62: LGTM!Also applies to: 77-84, 98-128, 141-142, 335-336, 345-375, 384-384
docs/nemo-relay-cli/claude-code.mdx (1)
31-42: LGTM!Also applies to: 67-95, 146-158, 235-244
docs/nemo-relay-cli/hermes.mdx (1)
3-23: LGTM!Also applies to: 24-77, 78-109, 110-132, 133-148, 149-168, 169-173, 175-187, 188-201, 202-212
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
integrations/coding-agents/README.md (1)
203-206: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winIntroduce the agent configuration example.
The TOML block begins without explaining what readers should configure.
Proposed Fix
That layering applies to transparent runs. Persistent mode skips the project layer and merges only system and user configuration. +For example, configure agent commands as follows: + ```tomlAs per coding guidelines, “Introduce every code block with a complete sentence.”
🤖 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 `@integrations/coding-agents/README.md` around lines 203 - 206, Add a complete introductory sentence immediately before the TOML code block in the agent configuration section, clearly stating what readers should configure; keep the existing configuration content unchanged.Source: Coding guidelines
integrations/coding-agents/codex/README.md (1)
22-31: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winMove the installer behavior out of the file list.
nemo-relay install codexis a command, not a package file. Move Lines 29-31 into a paragraph after the list so the section accurately describes package contents.As per coding guidelines, lists must use parallel construction and contain one idea per item.
🤖 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 `@integrations/coding-agents/codex/README.md` around lines 22 - 31, Move the nemo-relay install codex description out of the package file list and place it in a paragraph immediately after the list. Keep the three package-file bullets focused on package contents, with parallel construction and one idea per item.Source: Coding guidelines
integrations/coding-agents/claude-code/README.md (1)
311-318: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winRemove source plugins before running the generated installer.
Both upgrade procedures activate a source-installed plugin immediately before invoking
nemo-relay install <host> --force, despite each guide warning that both installations can forward duplicate lifecycle payloads.
integrations/coding-agents/claude-code/README.md#L311-L318: uninstall the source plugin beforenemo-relay install claude-code --force, or keep this procedure entirely source-only.integrations/coding-agents/codex/README.md#L420-L429: do not re-add the source plugin beforenemo-relay install codex --force; remove it first or document a source-only upgrade path.As per path instructions, review documentation for technical accuracy and consistency.
🤖 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 `@integrations/coding-agents/claude-code/README.md` around lines 311 - 318, Update the upgrade procedures in integrations/coding-agents/claude-code/README.md lines 311-318 and integrations/coding-agents/codex/README.md lines 420-429 so source-installed plugins are removed before running the generated nemo-relay install command; alternatively, make each procedure explicitly source-only and omit the generated installer. Keep the documented upgrade steps technically consistent and ensure neither path activates duplicate plugin installations.Source: Path instructions
🤖 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/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx`:
- Around line 214-220: Update the documentation paragraph describing
build-backend mappings: state that a mapping is rejected only when its resolved
artifact violates direct module resolution, uniqueness, or equality with the
integrity-checked source.artifact. Remove the claim that Relay independently
rejects all custom mappings, while preserving the existing security rationale
and supported Python path forms.
---
Outside diff comments:
In `@integrations/coding-agents/claude-code/README.md`:
- Around line 311-318: Update the upgrade procedures in
integrations/coding-agents/claude-code/README.md lines 311-318 and
integrations/coding-agents/codex/README.md lines 420-429 so source-installed
plugins are removed before running the generated nemo-relay install command;
alternatively, make each procedure explicitly source-only and omit the generated
installer. Keep the documented upgrade steps technically consistent and ensure
neither path activates duplicate plugin installations.
In `@integrations/coding-agents/codex/README.md`:
- Around line 22-31: Move the nemo-relay install codex description out of the
package file list and place it in a paragraph immediately after the list. Keep
the three package-file bullets focused on package contents, with parallel
construction and one idea per item.
In `@integrations/coding-agents/README.md`:
- Around line 203-206: Add a complete introductory sentence immediately before
the TOML code block in the agent configuration section, clearly stating what
readers should configure; keep the existing configuration content unchanged.
🪄 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: ef6a329b-0815-48d7-852a-f04c9f6a24cf
📒 Files selected for processing (13)
README.mdcrates/cli/README.mddocs/about-nemo-relay/release-notes/known-issues.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (21)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxcrates/cli/README.mddocs/getting-started/installation.mdxREADME.mddocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxcrates/cli/README.mddocs/getting-started/installation.mdxREADME.mddocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
{crates/core/src/plugin/dynamic/**,crates/plugin/**,crates/worker/**,crates/worker-proto/**,crates/types/**,python/plugin/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Keep the stable boundary explicit: native plugins cross a C ABI, and worker plugins cross
grpc-v1.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{crates/core/src/plugin/dynamic/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Native and worker plugins are trusted extensions; document that native plugins are in-process and unsandboxed, and worker plugins provide process isolation but not a security sandbox.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{docs/build-plugins/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
When detailed dynamic plugin guides exist, keep Rust native, Python worker, and
grpc-v1protocol details on separate pages.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxcrates/cli/README.mddocs/getting-started/installation.mdxREADME.mddocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
{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/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxREADME.mddocs/about-nemo-relay/release-notes/known-issues.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/codex.mdx
**/*.{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:
crates/cli/README.mdREADME.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.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:
crates/cli/README.mdREADME.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 docs.
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 docs unless the source, platform, or legal guidance explicitly requires them.
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: 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
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references 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
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
crates/cli/README.mdREADME.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.md
{README.md,docs/**/*.{md,rst,txt},fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Search and update documentation source for references to the old version in
README.md,docs, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.md
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update entry-point docs when examples or reading paths change
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.
Files:
README.md
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update onlydocs/about-nemo-relay/release-notes/index.mdx,docs/about-nemo-relay/release-notes/highlights.mdx, anddocs/about-nemo-relay/release-notes/known-issues.mdxunless the release changes their route or entry points.
Preserve the existing MDX front matter and the JSX SPDX comment in the release-notes pages.
Files:
docs/about-nemo-relay/release-notes/known-issues.mdx
docs/about-nemo-relay/release-notes/known-issues.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/known-issues.mdx: Inknown-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit it.
Inknown-issues.mdx, keep the complete fixed-item history recorded in earlier release-note pages.
Files:
docs/about-nemo-relay/release-notes/known-issues.mdx
🪛 LanguageTool
docs/nemo-relay-cli/plugin-installation.mdx
[grammar] ~192-~192: Use a hyphen to join words.
Context: ...request. It does not keep a durable hook outbox or deduplication journal. The opt...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (20)
docs/about-nemo-relay/release-notes/known-issues.mdx (1)
14-24: LGTM!docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (1)
239-243: LGTM!README.md (1)
45-45: LGTM!Also applies to: 104-142, 306-307
crates/cli/README.md (1)
29-45: LGTM!Also applies to: 56-61, 114-119
docs/getting-started/installation.mdx (1)
64-74: LGTM!Also applies to: 234-245
docs/nemo-relay-cli/plugin-installation.mdx (1)
15-28: LGTM!Also applies to: 51-80, 88-246, 313-354, 356-378
integrations/coding-agents/README.md (2)
25-42: LGTM!Also applies to: 58-61, 76-196, 234-281, 304-315, 325-328
316-317: 📐 Maintainability & Code QualityClarify whether these E2E targets are optional locally or required in CI. “Opt-in” and “mandatory CI” conflict here, so the validation requirement is unclear.
docs/nemo-relay-cli/basic-usage.mdx (1)
109-142: LGTM!Also applies to: 293-296, 325-339, 348-377, 386-391
docs/nemo-relay-cli/claude-code.mdx (1)
31-42: LGTM!Also applies to: 67-95, 146-166, 183-183, 195-195, 206-210, 245-254
integrations/coding-agents/claude-code/README.md (1)
18-23: LGTM!Also applies to: 33-37, 58-66, 130-130, 172-230, 257-257, 281-309
docs/nemo-relay-cli/codex.mdx (1)
17-32: LGTM!Also applies to: 52-60, 95-171, 185-191, 201-201, 216-244, 288-313, 327-349, 363-368
integrations/coding-agents/codex/README.md (1)
16-21: LGTM!Also applies to: 33-132, 145-166, 194-219, 257-299, 314-418, 432-444
docs/nemo-relay-cli/hermes.mdx (7)
45-45: LGTM!
143-146: 📐 Maintainability & Code QualityCross-check
skill.loadmark description against Claude Code/Codex docs.The PR objective calls out "harmonized captured-event documentation with related skill-load and compaction guidance." This paragraph describes Hermes-specific
skill_view→skill.loadmark fields (data.skill_name, source/tool in metadata, no path retention). Confirm this wording is consistent with the equivalent skill-load event description indocs/nemo-relay-cli/claude-code.mdx/docs/nemo-relay-cli/codex.mdxfrom the same PR stack, so the "harmonized" guidance doesn't diverge across integrations.As per PR objectives, "Harmonized captured-event documentation with related skill-load and compaction guidance."
147-151: 🎯 Functional CorrectnessVerify the dual-span observability contract.
The claim that API-request hooks and gateway routing can each produce an independent observed span for the same provider call (a hook-observed span plus a gateway-observed span) is a significant behavioral contract for anyone consuming exported traces. Confirm this dual-emission behavior is intentional and accurately described (and not just an artifact that should instead be de-duplicated).
Source: Path instructions
80-83: 🎯 Functional CorrectnessGateway lifecycle wording is consistent with the bootstrap and recovery flow.
62-64: 🎯 Functional CorrectnessNo change needed.
102-107: 🎯 Functional CorrectnessMCP ownership matching is already handled in the config helpers.
owned_install_command()/owned_command_from_config()gate removal and migration on the Relay-owned MCP entry, thenstrip_owned_hooks()andremove_owned_mcp()remove the matching hooks, approvals, and generation fence.> Likely an incorrect or invalid review comment.
32-33: 🎯 Functional Correctness
Hermes Agent 0.18.2 or newermatches the enforced minimum. The shared Hermes descriptor sets the floor at0.18.2, and install/doctor use the centralized version validator.> Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
integrations/coding-agents/README.md (1)
180-205: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winDo not require an installer generation fence for
--forward-onlysource plugins.This section pairs the Claude source-plugin flow with installer-owned generation-fence requirements, but
--forward-onlyexplicitly bypassescapture_generation_guardincrates/cli/src/hooks/delivery.rs:23-137. Separate the guidance: source plugins use gateway verification without the installer fence; generated persistent hooks use the private fence. Otherwise this documents a protection the command does not enforce.🤖 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 `@integrations/coding-agents/README.md` around lines 180 - 205, Update the Claude source-plugin guidance around `nemo-relay hook-forward claude --forward-only` to state that source plugins use gateway verification on their lifecycle-data connection without requiring an installer-owned generation fence. Restrict generation-fence requirements to generated persistent hooks, and remove any wording that implies `--forward-only` enforces `capture_generation_guard`.
🤖 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.
Outside diff comments:
In `@integrations/coding-agents/README.md`:
- Around line 180-205: Update the Claude source-plugin guidance around
`nemo-relay hook-forward claude --forward-only` to state that source plugins use
gateway verification on their lifecycle-data connection without requiring an
installer-owned generation fence. Restrict generation-fence requirements to
generated persistent hooks, and remove any wording that implies `--forward-only`
enforces `capture_generation_guard`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 91dff172-1535-4bdc-aeb9-58cd5c7196c1
📒 Files selected for processing (2)
docs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Rust / Test (windows-arm64)
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{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:
integrations/coding-agents/README.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:
integrations/coding-agents/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
integrations/coding-agents/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 docs.
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 docs unless the source, platform, or legal guidance explicitly requires them.
Files:
integrations/coding-agents/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: 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
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references 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
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
integrations/coding-agents/README.md
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
integrations/coding-agents/README.mddocs/nemo-relay-cli/basic-usage.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
integrations/coding-agents/README.mddocs/nemo-relay-cli/basic-usage.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
integrations/coding-agents/README.mddocs/nemo-relay-cli/basic-usage.mdx
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/nemo-relay-cli/basic-usage.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/nemo-relay-cli/basic-usage.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/nemo-relay-cli/basic-usage.mdx
{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/nemo-relay-cli/basic-usage.mdx
🔇 Additional comments (2)
integrations/coding-agents/README.md (1)
275-277: LGTM!docs/nemo-relay-cli/basic-usage.mdx (1)
270-280: LGTM!Also applies to: 299-301
Signed-off-by: Will Killian <wkillian@nvidia.com> # Conflicts: # docs/configure-plugins/observability/opentelemetry.mdx # skills/nemo-relay-plugin-observability/references/openinference.md
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <wkillian@nvidia.com>
1a29bcc to
fbb596e
Compare
willkill07
changed the title
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/nemo-relay-cli/plugin-installation.mdx`:
- Around line 191-193: Hyphenate the compound modifier in the Relay delivery
limitation text, changing “durable hook outbox” to “durable hook-outbox” while
preserving the surrounding explanation.
In `@integrations/coding-agents/README.md`:
- Around line 156-162: Clarify both source-hook paragraphs in
integrations/coding-agents/README.md at lines 156-162 and 179-186 by separating
the installer-owned generation-fence limitation from the independent behavior
that --forward-only hooks never launch or recover Relay. Keep the existing
authentication and connection details unchanged.
🪄 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: 56fa514e-af0d-4c0c-b989-80e29e3baf2e
📒 Files selected for processing (11)
README.mdcrates/cli/README.mddocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (19)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/getting-started/quick-start/index.mdxcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mddocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/claude-code/README.mddocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/getting-started/quick-start/index.mdxcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mddocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/claude-code/README.mddocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/getting-started/quick-start/index.mdxcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mddocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/claude-code/README.mddocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
docs/**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands under
docs/change, run the targeted docs checks appropriate to the change.
Files:
docs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
{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/index.mdxdocs/nemo-relay-cli/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxREADME.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdx
**/*.{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:
crates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mdintegrations/coding-agents/claude-code/README.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:
crates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mdintegrations/coding-agents/claude-code/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
crates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mdintegrations/coding-agents/claude-code/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: 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 docs.
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 docs unless the source, platform, or legal guidance explicitly requires them.
Files:
crates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mdintegrations/coding-agents/claude-code/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: 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
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references 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
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
crates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/README.mdREADME.mdintegrations/coding-agents/claude-code/README.md
{crates/core/src/plugin/dynamic/**,crates/plugin/**,crates/worker/**,crates/worker-proto/**,crates/types/**,python/plugin/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Keep the stable boundary explicit: native plugins cross a C ABI, and worker plugins cross
grpc-v1.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{crates/core/src/plugin/dynamic/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Native and worker plugins are trusted extensions; document that native plugins are in-process and unsandboxed, and worker plugins provide process isolation but not a security sandbox.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{docs/build-plugins/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
When detailed dynamic plugin guides exist, keep Rust native, Python worker, and
grpc-v1protocol details on separate pages.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{README.md,docs/**/*.{md,rst,txt},fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Search and update documentation source for references to the old version in
README.md,docs, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.md
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update entry-point docs when examples or reading paths change
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.
Files:
README.md
🪛 LanguageTool
docs/nemo-relay-cli/plugin-installation.mdx
[grammar] ~192-~192: Use a hyphen to join words.
Context: ...request. It does not keep a durable hook outbox or deduplication journal. The opt...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (13)
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (2)
214-221: Narrow the build-backend claim to the enforced contract.This repeats the prior finding. Relay validates direct module resolution, uniqueness, and equality with the integrity-checked
source.artifact; it does not independently reject every custom build-backend mapping. State that mappings are rejected when their resolved artifact violates those checks.As per path instructions, review documentation for technical accuracy against the current API.
Source: Path instructions
238-244: LGTM!docs/getting-started/quick-start/index.mdx (1)
29-29: LGTM!docs/nemo-relay-cli/about.mdx (1)
23-38: LGTM!Also applies to: 59-76
crates/cli/README.md (1)
29-45: LGTM!Also applies to: 56-61, 114-119
docs/getting-started/installation.mdx (1)
64-74: LGTM!Also applies to: 234-245
docs/nemo-relay-cli/plugin-installation.mdx (1)
2-51: LGTM!Also applies to: 61-72, 81-190, 194-361, 372-376
integrations/coding-agents/README.md (1)
25-42: LGTM!Also applies to: 58-61, 76-155, 163-178, 187-205, 234-282, 305-329
integrations/coding-agents/codex/README.md (2)
16-70: LGTM!Also applies to: 84-445
71-76: 🎯 Functional CorrectnessActivation-snapshot budget numbers match the implementation.
integrations/coding-agents/claude-code/README.md (1)
8-23: LGTM!Also applies to: 33-38, 58-67, 130-131, 172-172, 183-230, 257-257, 281-283, 305-309, 318-318
docs/nemo-relay-cli/hermes.mdx (1)
3-229: LGTM!README.md (1)
45-45: LGTM!Also applies to: 86-91, 103-141, 305-306
Co-authored-by: lvojtku <lvojtku@nvidia.com> Signed-off-by: Will Killian <2007799+willkill07@users.noreply.github.com>
|
/merge |
3 participants
Overview
Documents the shared coding-agent gateway bootstrap and Hermes integration implemented by merged PR #395. This docs-only follow-up covers shared installation, lifecycle, capture, and troubleshooting entry points.
Details
Validation:
just docsjust docs-linkcheckuv run pre-commit run --files ...Where should the reviewer start?
Start with
docs/nemo-relay-cli/plugin-installation.mdx, then reviewdocs/nemo-relay-cli/hermes.mdx.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit