Skip to content

docs(cli): update Codex integration and delegation trace guidance#426

Merged
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
willkill07:wkk_docs/codex-encryption-guidance
Jul 16, 2026
Merged

docs(cli): update Codex integration and delegation trace guidance#426
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
willkill07:wkk_docs/codex-encryption-guidance

Conversation

@willkill07

@willkill07 willkill07 commented Jul 15, 2026

Copy link
Copy Markdown
Member

Overview

Updates the local Codex integration guide and documents the multi-agent delegation encryption behavior and its practical observability boundaries.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

  • Refreshes Codex prerequisites, gateway lifecycle and configuration scope, capture behavior, and safe installation guidance.
  • Explains what Relay can record for encrypted multi-agent delegation: the parent tool metadata and ciphertext, child routing fields, and child response; it cannot decrypt the delegated task.
  • Documents the available mitigation and the configuration, restore, and settings caveats.
  • Contains no implementation changes.
  • Breaking changes: none.

Validation:

  • just docs
  • just docs-linkcheck
  • targeted uv run pre-commit run --files docs/nemo-relay-cli/codex.mdx

Where should the reviewer start?

Start with docs/nemo-relay-cli/codex.mdx.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

@willkill07 willkill07 requested review from a team and lvojtku as code owners July 15, 2026 02:22
@github-actions github-actions Bot added size:S PR is small Documentation documentation-related labels Jul 15, 2026
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Updates documentation for Claude Code, Codex, and Hermes persistent or transparent integrations, shared gateway and hook behavior, ATIF/ATOF and OTLP configuration semantics, and supporting setup examples. Codex documentation also covers encrypted multi-agent delegation traces and cold-start behavior.

Changes

Coding-agent integration workflows

Layer / File(s) Summary
CLI onboarding and persistent installation
README.md, crates/cli/README.md, docs/getting-started/*, docs/nemo-relay-cli/plugin-installation.mdx, integrations/coding-agents/README.md
Adds Hermes support, documents persistent installation and diagnostics, and describes shared gateway lifecycle, hook trust, generation fencing, configuration, credentials, upgrades, and uninstall behavior.
Agent-specific runtime guidance
docs/nemo-relay-cli/{basic-usage,claude-code,codex,hermes}.mdx, integrations/coding-agents/{claude-code,codex}/README.md
Documents transparent-run isolation, MCP startup and reuse, host-specific hooks and provider routing, export verification, Codex delegation encryption, and Hermes lifecycle coverage.
Release notes and worker guidance
docs/about-nemo-relay/release-notes/*, docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
Updates release-note limitations and documents stricter Python entrypoint resolution and integrity-marker behavior.

Observability configuration and semantics

Layer / File(s) Summary
ATOF version 2 sink model
docs/configure-plugins/observability/atof.mdx, docs/configure-plugins/observability/configuration.mdx, skills/nemo-relay-plugin-observability/references/atof.md
Replaces legacy examples with file/stream sinks, header_env, validation rules, migration guidance, lifecycle flushing semantics, and updated Python, Node.js, and Rust examples.
OTLP projection semantics
docs/configure-plugins/observability/{openinference,opentelemetry}.mdx, skills/nemo-relay-plugin-observability/references/{openinference,opentelemetry}.md
Documents version 2 configuration, typed dotted lifecycle attributes, JSON serialization and null handling, removal of aggregate attributes, and attribute_mappings.
Configuration fixtures and merge behavior
docs/configure-plugins/plugin-configuration-files.mdx, scripts/test-*-e2e.sh, skills/nemo-relay-get-started/references/cli-try-now.md
Updates examples and E2E-generated TOML to version 2 sink configuration and clarifies recursive table merging versus array replacement.

Estimated code review effort: 4 (Complex) | ~60 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed Uses a valid Conventional Commits docs(cli) title and accurately summarizes the Codex integration and delegation trace docs update.
Description check ✅ Passed Includes the required Overview, Details, reviewer-start, and related-issues sections plus the checklist items, so it matches the template closely.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

@willkill07 willkill07 added this to the 0.6 milestone Jul 15, 2026
@willkill07 willkill07 self-assigned this Jul 15, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/nemo-relay-cli/codex.mdx (1)

44-49: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Run just docs-linkcheck. These new external links should be covered before merge.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/nemo-relay-cli/codex.mdx` around lines 44 - 49, Run just docs-linkcheck
and resolve any reported issues for the new external links in the transport
references, ensuring all three URLs pass link validation before merging.

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.

Outside diff comments:
In `@docs/nemo-relay-cli/codex.mdx`:
- Around line 44-49: Run just docs-linkcheck and resolve any reported issues for
the new external links in the transport references, ensuring all three URLs pass
link validation before merging.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 2bcecf44-c3fc-4277-ae08-431b8a58e9e9

📥 Commits

Reviewing files that changed from the base of the PR and between 0e88b25 and b324ac8.

📒 Files selected for processing (1)
  • docs/nemo-relay-cli/codex.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Check / Run
  • 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.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 as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ 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, and grpc-v1 protocol details on separate pages

If links in documentation change, run just docs-linkcheck.

Files:

  • docs/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/nemo-relay-cli/codex.mdx
{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

  • docs/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, use maintain-dynamic-plugins and 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, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

  • docs/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/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/nemo-relay-cli/codex.mdx

rapids-bot Bot pushed a commit that referenced this pull request Jul 15, 2026
#### Overview

Disable Codex multi-agent v2 when Codex runs through NeMo Relay so delegated task content remains readable to Relay observability instead of arriving as opaque encrypted content.

- [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license.
- [x] I searched existing issues and open pull requests, and this does not duplicate existing work.

#### Details

- Make `nemo-relay install codex` write `features.multi_agent_v2.enabled = false` alongside the managed provider and hooks configuration.
- Restore the user's previous multi-agent v2 setting on uninstall and preserve other fields in the `features.multi_agent_v2` table.
- Inject `features.multi_agent_v2.enabled=false` as a temporary Codex config override for transparent wrapped execution.
- Require the managed v2-disable setting in Codex provider installation checks.
- Add focused coverage for wrapped launch arguments, repeated installation, uninstall restoration, and uninstall without a backup.
- Keep documentation separate in companion PR #426.
- Validation: focused Codex launcher/installer tests, `just test-rust`, `cargo fmt --all -- --check`, `cargo clippy --workspace --all-targets -- -D warnings`, and `uv run pre-commit run --all-files` passed.
- Breaking changes: none.

#### Where should the reviewer start?

Start with `crates/cli/src/agents/codex/host.rs` for persistent install and rollback ownership, then `crates/cli/src/agents/codex/launch.rs` for the wrapped-execution override.

#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

- Relates to #425
- Closes RELAY-478




## Summary by CodeRabbit

* **New Features**
  * Codex configuration now explicitly disables the Multi-Agent v2 feature during installation and launch.
  * Existing Multi-Agent v2 settings are preserved and restored when configurations are uninstalled or refreshed.

* **Bug Fixes**
  * Removed installer-managed configuration entries cleanly when no backup is available.
  * Improved handling of Multi-Agent v2 settings across repeated installations and uninstallations.

Authors:
  - Will Killian (https://github.com/willkill07)

Approvers:
  - Alex Fournier (https://github.com/afourniernv)

URL: #427

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/nemo-relay-cli/codex.mdx (1)

45-48: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Run the required documentation link check.

This change adds three external documentation links. Run just docs-linkcheck before merge; the reported validation covers just docs and pre-commit but does not mention this required targeted check.

As per coding guidelines: “If links in documentation change, run just docs-linkcheck.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/nemo-relay-cli/codex.mdx` around lines 45 - 48, Run the required just
docs-linkcheck validation after adding the three external links, and resolve any
reported link failures before merging. Keep the documentation links unchanged
unless the check identifies an invalid target.

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.

Outside diff comments:
In `@docs/nemo-relay-cli/codex.mdx`:
- Around line 45-48: Run the required just docs-linkcheck validation after
adding the three external links, and resolve any reported link failures before
merging. Keep the documentation links unchanged unless the check identifies an
invalid target.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 64cb443f-06d0-43c0-bab7-483cfb6476ac

📥 Commits

Reviewing files that changed from the base of the PR and between b324ac8 and b4d9886.

📒 Files selected for processing (1)
  • docs/nemo-relay-cli/codex.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Check / Run
  • 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.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 as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ 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, and grpc-v1 protocol details on separate pages

If links in documentation change, run just docs-linkcheck.

Files:

  • docs/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/nemo-relay-cli/codex.mdx
{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

  • docs/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, use maintain-dynamic-plugins and 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, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

  • docs/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/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/nemo-relay-cli/codex.mdx
🔇 Additional comments (2)
docs/nemo-relay-cli/codex.mdx (2)

35-42: LGTM!

Also applies to: 51-58, 63-68


59-61: 🎯 Functional Correctness

Shared scope and rollback are already documented.
nemo-relay install codex writes the override to ~/.codex/config.toml, and uninstall restores or removes the Relay-managed entry.

			> Likely an incorrect or invalid review comment.

@mnajafian-nv mnajafian-nv left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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/codex.mdx`:
- Around line 49-54: Run the required just docs-linkcheck validation for the
links added in the documentation, and address any failures caused by these
changes while preserving the intended upstream references.
🪄 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: 6c91d2c1-9d80-41fe-a1d0-37d25eb951cb

📥 Commits

Reviewing files that changed from the base of the PR and between b4d9886 and ac73f4d.

📒 Files selected for processing (1)
  • docs/nemo-relay-cli/codex.mdx
📜 Review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Check / Run
  • 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.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 as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ 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, and grpc-v1 protocol details on separate pages

If links in documentation change, run just docs-linkcheck.

Files:

  • docs/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/nemo-relay-cli/codex.mdx
{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

  • docs/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, use maintain-dynamic-plugins and 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, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

  • docs/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/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/nemo-relay-cli/codex.mdx
🔇 Additional comments (4)
docs/nemo-relay-cli/codex.mdx (4)

33-47: LGTM!


56-61: LGTM!


67-76: LGTM!


62-65: 🎯 Functional Correctness

No issue: later enabled overrides are preserved

restore_multi_agent_v2_enabled only applies when the current config still has features.multi_agent_v2.enabled = false. If a user changes it after install, uninstall leaves that value untouched, so the docs wording is accurate.

			> Likely an incorrect or invalid review comment.

Comment thread docs/nemo-relay-cli/codex.mdx
@github-actions github-actions Bot added size:XL PR is extra large and removed size:S PR is small labels Jul 16, 2026
willkill07 added a commit to willkill07/NeMo-Relay that referenced this pull request Jul 16, 2026
Signed-off-by: Will Killian <wkillian@nvidia.com>

# Conflicts:
#	docs/about-nemo-relay/release-notes/index.mdx
#	docs/about-nemo-relay/release-notes/known-issues.mdx
willkill07 added a commit to willkill07/NeMo-Relay that referenced this pull request Jul 16, 2026
Signed-off-by: Will Killian <wkillian@nvidia.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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/configure-plugins/observability/openinference.mdx`:
- Around line 126-156: Update the OpenInference attribute projection description
to use event-scoped keys such as nemo_relay.start.metadata.tenant for start
metadata, and revise the alias example to target the corresponding current
nemo_relay.* attribute. Describe scalar fields as typed dotted OTLP attributes
and nested objects or arrays as JSON strings at their top-level attributes.
Remove the sentence documenting removed aggregate *_json attributes.

In `@docs/nemo-relay-cli/basic-usage.mdx`:
- Around line 399-404: Update the coverage statement following the guide links
to apply only to the agent-specific guides, excluding “Coding Agent
Installation.” Keep the existing claims about transparent run setup, gateway
routing, hook smoke tests, ATIF export verification, and troubleshooting missing
LLM lifecycle data for the applicable agent guides.

In `@integrations/coding-agents/README.md`:
- Around line 203-204: Update the exporter configuration instructions near the
persistent-mode layering explanation so they no longer direct persistent
installs to create `.nemo-relay/plugins.toml` in the skipped project layer.
Either scope those instructions explicitly to transparent runs or document the
supported system/user plugin configuration and corresponding `.nemo-relay/atif`
output for persistent mode.
- Around line 259-266: Update the hook forwarding documentation to state that
GuardrailRejected failures always return a non-zero status, regardless of
fail-closed configuration. Narrow the --fail-closed and NEMO_RELAY_FAIL_CLOSED
descriptions to ordinary transport and non-2xx forwarding failures, while
preserving the guidance for wrapper-generated and persistent hooks.
🪄 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: 590f512c-60af-43a2-a46d-f4b3953e028d

📥 Commits

Reviewing files that changed from the base of the PR and between ac73f4d and 593ee88.

📒 Files selected for processing (29)
  • README.md
  • crates/cli/README.md
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/atof.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • docs/getting-started/installation.mdx
  • docs/getting-started/quick-start/index.mdx
  • docs/nemo-relay-cli/about.mdx
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/hermes.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • integrations/coding-agents/README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/codex/README.md
  • scripts/test-claude-plugin-e2e.sh
  • scripts/test-codex-plugin-e2e.sh
  • scripts/test-hermes-mcp-e2e.sh
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-plugin-observability/references/opentelemetry.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
  • GitHub Check: Rust / Test (linux-arm64)
  • GitHub Check: Rust / Test (windows-amd64)
  • GitHub Check: Rust / Test (macos-arm64)
  • GitHub Check: Rust / Test (windows-arm64)
  • GitHub Check: Rust / Test (linux-amd64)
  • 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 spell NVIDIA in all caps. Do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol after NVIDIA when 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 with NVIDIA on 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 with s, not an apostrophe, such as GPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such as CPU, GPU, PC, API, and UI usually do not need to be spelled out for developer audiences.

Files:

  • skills/nemo-relay-plugin-observability/references/opentelemetry.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • integrations/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.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • integrations/coding-agents/codex/README.md
**/*.{md,rst,txt}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)

Spell NVIDIA in all caps. Do not use Nvidia, nvidia, or NV.

Files:

  • skills/nemo-relay-plugin-observability/references/opentelemetry.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • integrations/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.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once.
Prefer refer to over see when 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.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • integrations/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.md
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • integrations/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 as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ 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, and grpc-v1 protocol details on separate pages

If links in documentation change, run just docs-linkcheck.

Files:

  • skills/nemo-relay-plugin-observability/references/opentelemetry.md
  • docs/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • integrations/coding-agents/codex/README.md
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/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.md
  • docs/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • integrations/coding-agents/codex/README.md
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/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, use maintain-dynamic-plugins and 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, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

  • skills/nemo-relay-plugin-observability/references/opentelemetry.md
  • scripts/test-claude-plugin-e2e.sh
  • docs/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • scripts/test-hermes-mcp-e2e.sh
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • skills/nemo-relay-plugin-observability/references/openinference.md
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • skills/nemo-relay-get-started/references/cli-try-now.md
  • scripts/test-codex-plugin-e2e.sh
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • crates/cli/README.md
  • skills/nemo-relay-plugin-observability/references/atof.md
  • README.md
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • integrations/coding-agents/claude-code/README.md
  • integrations/coding-agents/README.md
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • integrations/coding-agents/codex/README.md
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/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.sh
  • scripts/test-hermes-mcp-e2e.sh
  • scripts/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/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/configure-plugins/observability/atof.mdx
{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

  • docs/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/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/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/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/getting-started/quick-start/index.mdx
  • docs/about-nemo-relay/release-notes/index.mdx
  • docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
  • docs/configure-plugins/observability/atif.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/getting-started/installation.mdx
  • README.md
  • docs/about-nemo-relay/release-notes/known-issues.mdx
  • docs/nemo-relay-cli/about.mdx
  • docs/nemo-relay-cli/hermes.mdx
  • docs/configure-plugins/plugin-configuration-files.mdx
  • docs/nemo-relay-cli/basic-usage.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/nemo-relay-cli/claude-code.mdx
  • docs/nemo-relay-cli/codex.mdx
  • docs/nemo-relay-cli/plugin-installation.mdx
  • docs/configure-plugins/observability/atof.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 only docs/about-nemo-relay/release-notes/index.mdx, docs/about-nemo-relay/release-notes/highlights.mdx, and docs/about-nemo-relay/release-notes/known-issues.mdx unless 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.mdx
  • docs/about-nemo-relay/release-notes/known-issues.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-v1 protocol 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, and fern directories, 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.md change, 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: In known-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit it.
In known-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.mdx
  • docs/configure-plugins/observability/opentelemetry.mdx
  • docs/configure-plugins/observability/openinference.mdx
  • docs/configure-plugins/observability/configuration.mdx
  • docs/configure-plugins/observability/atof.mdx
🪛 LanguageTool
docs/nemo-relay-cli/basic-usage.mdx

[style] ~387-~387: 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/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 (53)
integrations/coding-agents/claude-code/README.md (2)

8-23: LGTM!

Also applies to: 58-66, 130-130, 172-172, 183-186, 192-193, 206-213, 225-230, 257-257, 305-309, 318-318


33-35: 🩺 Stability & Availability

Verify the alwaysLoad startup-barrier claim.

The documentation relies on alwaysLoad to guarantee MCP readiness before session hooks and gateway-dependent traffic. The upstream 2.1.121 description defines it as disabling tool-search deferral and keeping tools available, not explicitly as a startup/readiness barrier. (github.com)

  • integrations/coding-agents/claude-code/README.md#L33-L35: document the actual readiness mechanism or qualify this guarantee.
  • integrations/coding-agents/claude-code/README.md#L188-L191: avoid claiming Claude waits for MCP readiness unless this is verified for the supported version.
  • integrations/coding-agents/claude-code/README.md#L281-L283: ensure source-install guidance does not depend on unsupported alwaysLoad semantics.
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

docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (1)

214-221: LGTM!

Also applies to: 238-244

docs/getting-started/installation.mdx (2)

73-74: 📐 Maintainability & Code Quality

Run just docs-linkcheck for all changed link destinations.

  • docs/getting-started/installation.mdx#L73-L74: Validate the persistent installation guide route.
  • docs/getting-started/installation.mdx#L244-L245: Validate the Hermes Agent guide route.
  • docs/nemo-relay-cli/codex.mdx#L27-L32: Validate the upstream issue link; this occurrence was already flagged in a prior review.

As per coding guidelines, “If links in documentation change, run just docs-linkcheck.”

Source: Coding guidelines


64-71: LGTM!

Also applies to: 234-243

README.md (1)

45-45: LGTM!

Also applies to: 86-91, 103-141, 305-306

crates/cli/README.md (1)

29-45: LGTM!

Also applies to: 56-61, 114-119

docs/about-nemo-relay/release-notes/index.mdx (1)

60-60: LGTM!

docs/about-nemo-relay/release-notes/known-issues.mdx (1)

12-28: LGTM!

Also applies to: 38-39

docs/getting-started/quick-start/index.mdx (1)

29-29: LGTM!

docs/nemo-relay-cli/about.mdx (1)

23-29: LGTM!

Also applies to: 30-38, 59-60, 66-76

docs/nemo-relay-cli/plugin-installation.mdx (1)

2-58: LGTM!

Also applies to: 67-91, 93-139, 140-170, 171-216, 217-247, 248-281, 290-294, 295-312, 313-355, 356-359, 370-378

docs/nemo-relay-cli/basic-usage.mdx (1)

57-62: LGTM!

Also applies to: 77-84, 98-131, 141-142, 338-343, 361-390

docs/nemo-relay-cli/claude-code.mdx (1)

31-42: LGTM!

Also applies to: 67-95, 146-149, 183-183, 195-195, 206-210, 245-247

docs/nemo-relay-cli/codex.mdx (1)

17-25: LGTM!

Also applies to: 99-107, 142-218, 232-238, 248-248, 263-291, 337-356, 374-396, 410-415

docs/nemo-relay-cli/hermes.mdx (1)

3-24: LGTM!

Also applies to: 25-82, 83-113, 114-139, 140-160, 161-189, 190-202, 203-216, 217-229

integrations/coding-agents/README.md (1)

25-42: LGTM!

Also applies to: 58-61, 76-146, 156-169, 180-202, 234-258, 268-280, 305-329

docs/configure-plugins/observability/atof.mdx (11)

3-125: LGTM!


127-142: LGTM!


144-180: LGTM!


183-235: LGTM!


243-264: LGTM!


340-414: LGTM!


418-428: LGTM!


1-1: 🗄️ Data Integrity & Integration

Drop this note header_env is checked in validate() and again at activation, so the docs can keep the “before you validate or activate” wording.

			> Likely an incorrect or invalid review comment.

53-55: 🗄️ Data Integrity & Integration

No issue: validate() also resolves header_env. A missing or blank NEMO_RELAY_ATOF_AUTH_HEADER fails validation as well as activation.

			> Likely an incorrect or invalid review comment.

283-329: 🗄️ Data Integrity & Integration

No change needed for the Rust example. ObservabilityConfig::default() already sets version = 2, so this matches the TOML and Node.js examples.

			> Likely an incorrect or invalid review comment.

1-1: 🗄️ Data Integrity & Integration

Rust examples already inherit version = 2 from ObservabilityConfig::default(), so the explicit field is unnecessary.

			> Likely an incorrect or invalid review comment.
docs/configure-plugins/observability/configuration.mdx (8)

38-40: LGTM!


66-131: LGTM!


133-139: 🗄️ Data Integrity & Integration

Same "validate or activate" wording concern as atof.mdx.

This repeats the claim that NEMO_RELAY_ATOF_AUTH_HEADER must be set "before validation or activation," which shares one root cause with the atof.mdx#L53-55 finding — see the consolidated comment.


157-159: LGTM!


171-177: LGTM!


198-328: LGTM!


347-424: 🗄️ Data Integrity & Integration

Rust example omits version again — shares root cause with atof.mdx.

Same missing-version concern as atof.mdx#L283-329; see the consolidated comment.


432-443: LGTM!

docs/configure-plugins/plugin-configuration-files.mdx (5)

42-52: LGTM!


103-113: LGTM!


263-303: LGTM!


368-374: LGTM!


403-403: LGTM!

docs/configure-plugins/observability/atif.mdx (1)

31-31: LGTM!

Also applies to: 303-303

docs/configure-plugins/observability/opentelemetry.mdx (3)

29-30: LGTM!


60-60: LGTM! The projected-attribute documentation correctly follows the established contract for scalar dotted attributes, JSON-string nested values, null omission, and removal of legacy *_json attributes.

Also applies to: 98-126

Source: Learnings


218-218: LGTM!

skills/nemo-relay-plugin-observability/references/openinference.md (2)

23-38: LGTM! Content matches the OTLP projection contract (dotted scalar attributes, JSON-string nested values, no legacy *_json, attribute_mappings aliasing).

Source: Learnings


27-29: 🗄️ Data Integrity & Integration

No Separate LLM Start Metadata Mapping LLM start metadata is intentionally removed on start spans; only non-LLM start metadata and all end metadata are projected to openinference.metadata.

			> Likely an incorrect or invalid review comment.
skills/nemo-relay-plugin-observability/references/opentelemetry.md (1)

24-34: LGTM! Matches the documented OTLP projection contract for start/end metadata naming, JSON-string emission, and attribute_mappings.

Source: Learnings

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-69

docs/configure-plugins/observability/openinference.mdx (1)

34-34: LGTM!

Also applies to: 66-66, 110-124, 227-227

scripts/test-claude-plugin-e2e.sh (1)

98-104: 🎯 Functional Correctness

No change needed for the ATOF file sink configs. Each script already sets output_directory, filename, and mode, so the sink is explicit and deterministic as written.

			> Likely an incorrect or invalid review comment.

Comment thread docs/configure-plugins/observability/openinference.mdx Outdated
Comment thread docs/nemo-relay-cli/basic-usage.mdx Outdated
Comment thread integrations/coding-agents/README.md Outdated
Comment thread integrations/coding-agents/README.md Outdated
Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 force-pushed the wkk_docs/codex-encryption-guidance branch from d238234 to 1d03cd5 Compare July 16, 2026 20:02
@github-actions github-actions Bot added size:M PR is medium and removed size:XL PR is extra large labels Jul 16, 2026
@willkill07 willkill07 changed the title docs: document Codex multi-agent encryption workaround docs(cli): update Codex integration and delegation trace guidance Jul 16, 2026
@willkill07

Copy link
Copy Markdown
Member Author

/merge

@rapids-bot rapids-bot Bot merged commit f34b360 into NVIDIA:main Jul 16, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:M PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants