docs: clarify provider auth overrides#456
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (2)
📜 Recent review details⏰ Context from checks skipped due to timeout. (1)
🧰 Additional context used📓 Path-based instructions (7)**/*.mdx📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
Files:
**/*.{md,mdx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{md,markdown,mdx}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
{docs,examples}/**/*📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Files:
**/*📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
docs/**/*📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}⚙️ CodeRabbit configuration file
Files:
🪛 LanguageTooldocs/nemo-relay-cli/basic-usage.mdx[style] ~464-~464: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) 🔇 Additional comments (3)
WalkthroughThe documentation updates clarify transparent and persistent coding-agent integration lifecycles, provider upstream and credential resolution, hook forwarding semantics, correlation metadata, and ATIF export verification for Claude Code, Codex, and Hermes. ChangesCoding-agent workflows and observability
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/basic-usage.mdx`:
- Around line 187-190: Update the replacement OpenAI credential description near
the Codex ChatGPT OAuth handling to include OPENAI_API_KEY alongside
openai_auth_header and NEMO_RELAY_OPENAI_AUTH_HEADER. Ensure the documented
fallback accurately reflects that an available OPENAI_API_KEY causes the OAuth
token to be stripped and the configured credential forwarded upstream.
🪄 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: e472da16-c86d-4ff3-bbf3-6bc83d564f74
📒 Files selected for processing (3)
docs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (1)
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (7)
**/*.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/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.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/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.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/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.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/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.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/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.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/codex.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdx
🔇 Additional comments (5)
docs/nemo-relay-cli/basic-usage.mdx (2)
145-186: LGTM!Also applies to: 191-192
280-282: LGTM!docs/nemo-relay-cli/claude-code.mdx (2)
73-78: LGTM!
80-81: 📐 Maintainability & Code QualityRun
just docs-linkcheckfor both new guide links.The Claude Code and Codex guides both add links to the shared Provider Upstreams section. Validate both links with the repository-required documentation link checker.
docs/nemo-relay-cli/claude-code.mdx#L80-L81: validate the new Provider Upstreams link.docs/nemo-relay-cli/codex.mdx#L120-L121: validate the new Provider Upstreams link.Source: Coding guidelines
docs/nemo-relay-cli/codex.mdx (1)
113-118: LGTM!
github-actions
Bot
added
size:XL
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
85-96: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winInconsistent sub-step phrasing between ATOF and ATIF.
Step 2 (ATOF) issues sink configuration as a declarative instruction ("Add a file sink. You can set its..."), while step 3 (ATIF) explicitly frames its settings as optional ("Optionally set:" + bullets). Since both file/stream sinks are actually optional (per the earlier ATOF/ATIF toggle-only default), align the phrasing so readers don't assume the ATOF file sink is mandatory.
As per coding guidelines, lists should have "parallel sentence construction, one idea or action per item".
✏️ Suggested rewording
-2. Open **ATOF**. Toggle the section **[on]**. - - Add a file sink. You can set its `output_directory` to - `.nemo-relay/atof`, `filename` to `events.jsonl`, and `mode` to - `overwrite`. Add stream sinks to send the same events to remote collectors. +2. Open **ATOF**. Toggle the section **[on]**. + + Optionally configure a file sink: + - `output_directory` to `.nemo-relay/atof` + - `filename` to `events.jsonl` + - `mode` to `overwrite` + + Optionally add stream sinks to send the same events to remote collectors.🤖 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 85 - 96, Update the ATOF instructions in the Observability setup section so file and stream sink configuration is explicitly optional, matching the ATIF wording and preserving the toggle-only default. Use parallel sentence construction with one action per list item, without changing the configuration values or workflow.Source: Coding guidelines
🤖 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 around load.entrypoint and
source.manifest_root to clarify that standard src/ layouts are supported when
manifest_root is set to "src" and the entrypoint resolves directly to
source.artifact. Limit the rejection statement to custom build-backend mappings
that cannot directly resolve to the integrity-checked artifact, while preserving
the ambiguity and unsigned-sibling-module constraints.
In `@docs/configure-plugins/observability/openinference.mdx`:
- Around line 137-143: Update the observability projection documentation around
the described NeMo Relay behavior to remove the mention of legacy aggregate
*_json payload attributes. Retain the current behavior: objects and arrays are
emitted as JSON strings at their dotted field names, nested nulls remain, and
top-level null fields are omitted; keep the OpenInference metadata compatibility
attribute reference only if it is still current.
In `@docs/nemo-relay-cli/plugin-installation.mdx`:
- Around line 217-247: In the “Configuration and Credentials” section, expand
the first occurrences of HMAC and DACL by spelling out their full terms followed
by the acronyms in parentheses, while leaving subsequent technical behavior and
terminology unchanged.
In `@integrations/coding-agents/README.md`:
- Around line 76-146: Clarify the credential-forwarding paragraph so the managed
sidecar injects a forwarded provider key only after validating Relay’s private
per-user client proof, specifically for Codex requests. State that Claude Code
and Hermes use their genuine provider authorization and receive no injected key,
preserving the existing security-boundary explanation and related proof/header
behavior.
In `@skills/nemo-relay-plugin-observability/references/openinference.md`:
- Around line 23-38: Update the metadata projection statement in the
OpenInference documentation to distinguish LLM start spans from non-LLM start
spans: LLM starts must not project metadata, non-LLM starts must use
openinference.metadata, and end spans must continue using
openinference.metadata. Preserve the existing mark metadata mapping.
---
Outside diff comments:
In `@README.md`:
- Around line 85-96: Update the ATOF instructions in the Observability setup
section so file and stream sink configuration is explicitly optional, matching
the ATIF wording and preserving the toggle-only default. Use parallel sentence
construction with one action per list item, without changing the configuration
values or workflow.
🪄 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: 0ff8104e-6af0-40b6-b4d1-10268575907a
📒 Files selected for processing (30)
README.mdcrates/cli/README.mddocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/plugin-configuration-files.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.mdscripts/test-claude-plugin-e2e.shscripts/test-codex-plugin-e2e.shscripts/test-hermes-mcp-e2e.shskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
- GitHub Check: Rust / Test (windows-arm64)
- GitHub Check: Rust / Test (linux-amd64)
- GitHub Check: Rust / Test (linux-arm64)
- GitHub Check: Rust / Test (windows-amd64)
- GitHub Check: Rust / Test (macos-arm64)
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (22)
**/*.{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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mdskills/nemo-relay-get-started/references/cli-try-now.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mdskills/nemo-relay-get-started/references/cli-try-now.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mdskills/nemo-relay-get-started/references/cli-try-now.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mdskills/nemo-relay-get-started/references/cli-try-now.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mdskills/nemo-relay-get-started/references/cli-try-now.mdintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mddocs/configure-plugins/observability/atif.mdxskills/nemo-relay-plugin-observability/references/openinference.mddocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxskills/nemo-relay-get-started/references/cli-try-now.mddocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/claude-code/README.mddocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxintegrations/coding-agents/codex/README.mddocs/configure-plugins/observability/atof.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mddocs/configure-plugins/observability/atif.mdxskills/nemo-relay-plugin-observability/references/openinference.mddocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxskills/nemo-relay-get-started/references/cli-try-now.mddocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/claude-code/README.mddocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxintegrations/coding-agents/codex/README.mddocs/configure-plugins/observability/atof.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:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdscripts/test-claude-plugin-e2e.shdocs/configure-plugins/observability/atif.mdxskills/nemo-relay-plugin-observability/references/openinference.mddocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxscripts/test-hermes-mcp-e2e.shdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxskills/nemo-relay-plugin-observability/references/atof.mdREADME.mdcrates/cli/README.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxskills/nemo-relay-get-started/references/cli-try-now.mddocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxscripts/test-codex-plugin-e2e.shdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mddocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxintegrations/coding-agents/claude-code/README.mddocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxintegrations/coding-agents/codex/README.mddocs/configure-plugins/observability/atof.mdx
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}
⚙️ CodeRabbit configuration file
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}: Review automation changes for reproducibility, pinned versions where appropriate, secret handling, and consistency with the documented validation matrix.
Pay attention to commands that need generated native artifacts, FFI libraries, or platform-specific environment variables.
Files:
scripts/test-claude-plugin-e2e.shscripts/test-hermes-mcp-e2e.shscripts/test-codex-plugin-e2e.sh
**/*.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/configure-plugins/observability/atif.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/atof.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/configure-plugins/observability/atif.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/atof.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/configure-plugins/observability/atif.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/atof.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/configure-plugins/observability/atif.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/getting-started/quick-start/index.mdxREADME.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/atof.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/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/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.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
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
🧠 Learnings (1)
📚 Learning: 2026-07-14T02:53:59.997Z
Learnt from: willkill07
Repo: NVIDIA/NeMo-Relay PR: 415
File: docs/configure-plugins/observability/opentelemetry.mdx:98-113
Timestamp: 2026-07-14T02:53:59.997Z
Learning: In NeMo-Relay’s OpenTelemetry/OpenInference observability projection docs under docs/configure-plugins/observability/, document the projected-attribute contract as follows: (1) emit scalar top-level `data`/`metadata` fields as typed dotted OTLP attributes (for example, `nemo_relay.start.metadata.tenant`); (2) keep nested objects/arrays as JSON strings at their top-level OTLP attribute (rather than expanding them into nested OTLP attributes); and (3) do not reference the legacy `*_json` payload attributes (e.g., `data_json`, `metadata_json`, `input_json`) because they were intentionally removed as a breaking change.
Applied to files:
docs/configure-plugins/observability/atif.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atof.mdx
🪛 LanguageTool
docs/about-nemo-relay/release-notes/index.mdx
[grammar] ~42-~42: Ensure spelling is correct
Context: ... and implementation PRs. Go and the raw C FFI remain experimental and source-first. N...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
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)
docs/nemo-relay-cli/basic-usage.mdx
[style] ~464-~464: 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/about-nemo-relay/release-notes/known-issues.mdx
[style] ~66-~66: To strengthen your wording, consider replacing the phrasal verb “leave out”.
Context: ...sinks continue. - ATIF models steps and leaves out point-in-time marks. Use ATOF when you ...
(OMIT_EXCLUDE)
🔇 Additional comments (48)
docs/about-nemo-relay/release-notes/highlights.mdx (4)
3-38: LGTM!
39-85: LGTM!
86-110: LGTM!
111-128: LGTM!docs/about-nemo-relay/release-notes/index.mdx (3)
9-45: LGTM!
46-77: LGTM!
78-98: LGTM!docs/about-nemo-relay/release-notes/known-issues.mdx (3)
3-274: LGTM!
275-285: LGTM!
314-316: LGTM!docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (1)
238-243: LGTM!docs/configure-plugins/observability/atif.mdx (1)
31-31: LGTM!Also applies to: 303-303
docs/configure-plugins/observability/atof.mdx (3)
3-16: LGTM!Also applies to: 48-60, 69-106, 123-148, 168-175, 211-211, 243-329, 418-426
340-352: 🎯 Functional CorrectnessNo issue: Python exposes
sink_typeonAtofExporterConfig. The example matches the binding stub and tests, so notypealias is needed here.> Likely an incorrect or invalid review comment.
107-111: 🎯 Functional CorrectnessNo change needed.
docs/configure-plugins/observability/configuration.mdx (1)
38-40: LGTM!Also applies to: 85-86, 133-139, 157-157, 181-181, 199-199, 216-224, 276-328, 346-346, 355-424, 441-441
docs/configure-plugins/plugin-configuration-files.mdx (1)
42-48: LGTM!Also applies to: 103-109, 263-302, 366-374, 403-403
docs/configure-plugins/observability/opentelemetry.mdx (1)
29-29: LGTM!Also applies to: 60-60, 98-126, 218-218
skills/nemo-relay-plugin-observability/references/opentelemetry.md (1)
24-34: LGTM!scripts/test-claude-plugin-e2e.sh (1)
98-104: 📐 Maintainability & Code QualityMake E2E ATOF output deterministic.
These fixtures configure only
type = "file"and therefore rely on default output behavior, including a timestamped filename. If the harness validates or cleans a known artifact, runs can become nondeterministic.
scripts/test-claude-plugin-e2e.sh#L98-L104: set explicit output directory, filename, and mode, or confirm the harness discovers the default artifact.scripts/test-codex-plugin-e2e.sh#L146-L152: set explicit output directory, filename, and mode, or confirm the harness discovers the default artifact.scripts/test-hermes-mcp-e2e.sh#L125-L134: set explicit output directory, filename, and mode, or confirm the harness discovers the default artifact.As per path instructions, automation changes should remain reproducible and consistent with validation expectations.
Source: Path instructions
skills/nemo-relay-get-started/references/cli-try-now.md (1)
115-121: LGTM!skills/nemo-relay-plugin-observability/references/atof.md (1)
25-54: LGTM!Also applies to: 65-71
docs/configure-plugins/observability/openinference.mdx (1)
34-34: LGTM!Also applies to: 66-66, 126-136, 144-157, 227-227
README.md (4)
45-45: LGTM!
103-127: LGTM!
305-306: LGTM!
129-141: 📐 Maintainability & Code QualityCodex warning is fine as-is The README already links the Claude Code and Hermes docs in this section, and this warning is intentionally scoped to Codex hook trust and Windows behavior.
> Likely an incorrect or invalid review comment.crates/cli/README.md (3)
29-45: LGTM!
56-61: Consistent with gateway contract.The described shared gateway on
127.0.0.1:47632matches themcpsubcommand's documented bind address and readiness semantics.
114-119: LGTM!docs/getting-started/installation.mdx (2)
64-75: LGTM!
234-246: LGTM!docs/getting-started/quick-start/index.mdx (1)
29-29: LGTM!docs/nemo-relay-cli/about.mdx (2)
23-48: LGTM!
56-79: LGTM!docs/nemo-relay-cli/plugin-installation.mdx (5)
2-58: LGTM! SPDX header correctly uses the required{/* ... */}JSX comment delimiters, and the intro accurately scopes persistent integrations.
61-139: Consistent and well-specified.The
install all,--dry-run,--install-dir, and per-host "What Install Changes" content is internally consistent — the 10 listed Codex hook events match the "10 hooks" claim referenced elsewhere in this cohort (README.md,docs/nemo-relay-cli/about.mdx).
140-216: LGTM! Shared gateway lifecycle, generation-fence, and Windows Job Object behavior are consistent with the equivalent caveats inREADME.md.
248-359: LGTM! Diagnose, uninstall, and the compatibility/migration guidance (including theplugin-shimreplacement table) are technically consistent with the install/hook-trust behavior described earlier in this page.
361-378: LGTM!integrations/coding-agents/README.md (1)
25-42: LGTM!Also applies to: 58-61, 156-169, 180-205, 234-282, 305-329
docs/nemo-relay-cli/basic-usage.mdx (1)
57-62: LGTM!Also applies to: 77-84, 98-131, 141-142, 171-231, 333-335, 415-420, 438-467, 476-481
docs/nemo-relay-cli/claude-code.mdx (1)
31-42: LGTM!Also applies to: 67-86, 153-156, 190-190, 202-202, 213-217, 252-254
docs/nemo-relay-cli/codex.mdx (2)
17-26: LGTM!Also applies to: 36-82, 99-107, 142-218, 232-295, 354-419
27-34: 🎯 Functional CorrectnessTrust-gate issue link is off by scope.
openai/codex#21639tracks the Codex Desktop hook-trust regression. If you want the installer/wrapper trust-request gap specifically,openai/codex#21615is the narrower issue.> Likely an incorrect or invalid review comment.docs/nemo-relay-cli/hermes.mdx (1)
3-113: LGTM!Also applies to: 114-160, 161-202, 203-229
integrations/coding-agents/claude-code/README.md (1)
8-23: LGTM!Also applies to: 33-33, 58-66, 130-130, 172-172, 183-193, 206-213, 225-230, 257-257, 281-283, 305-309, 318-318
integrations/coding-agents/codex/README.md (1)
16-132: LGTM!Also applies to: 145-153, 164-166, 194-219, 257-269, 296-299, 314-329, 376-377, 390-418, 429-444
Signed-off-by: Will Killian <wkillian@nvidia.com>
8729dc8 to
09f1f2a
Compare
github-actions
Bot
added
size:M
|
/merge |
2 participants
Overview
Documents provider routing and credential-override behavior introduced by #440, alongside the updated Claude Code integration context.
Details
Validation:
just docsjust docs-linkcheckuv run pre-commit run --files ...Where should the reviewer start?
Start with
docs/nemo-relay-cli/basic-usage.mdx.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit