Forward-merge release/0.5 into main#385
Conversation
#### Overview Reorganize and expand NeMo Relay plugin documentation, including built-in component configuration and all four plugin authoring paths. - [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 - Group built-in component configuration under `Configure Plugins` and add configuration guides for model pricing, discoverable plugins, and component-specific settings. - Organize plugin authoring into language binding, native dynamic, and Rust/Python gRPC worker paths. - Add standalone examples, runtime discovery guidance, lifecycle cleanup, compatibility links, and backward-compatible configuration redirects. - Update navigation and entry-point documentation for the new hierarchy. #### Where should the reviewer start? Start with `docs/build-plugins/about.mdx`, `docs/configure-plugins/about.mdx`, and `fern/docs.yml`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes RELAY-317 - Closes RELAY-320 #### Validation - `just docs` - `just docs-linkcheck` - `uv run pre-commit run lychee` - Python, Node.js, and Rust documentation-fence syntax checks ## Summary by CodeRabbit * **Documentation** * Expanded and reorganized plugin documentation: Observability (ATOF/ATIF/exporters), Adaptive, NeMo Guardrails, PII redaction, and Model pricing. * Added new guides for discoverable plugins and dynamic plugin authorship, including Native Dynamic and gRPC Worker (protocol + Python/Rust examples). * Updated lifecycle, validation/initialization/teardown walkthroughs, and clarified semantics around exporters and pricing; removed an older “code examples” page. * **Chores** * Refreshed documentation navigation and standardized internal link paths, including new redirects to preserve older URLs. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) - https://github.com/lvojtku URL: NVIDIA#361
#### Overview Update the documentation-site release notes for NVIDIA NeMo Relay 0.5 and add a maintainer skill that gathers release evidence from Git history. - [x] I confirm this contribution is my own work, or I have the right to submit it under the project license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Replace the stale 0.4 release-note content with the 0.5 compatibility migrations, dynamic plugin capabilities, CLI diagnostics, and runtime and observability updates. - Preserve the complete fixed-item history recorded in the 0.3 and 0.4 release-note pages under release-labelled sections. - Add `draft-release-notes`, including a read-only Git evidence collector that compares release-note trees and groups commits for maintainer review. #### Where should the reviewer start? Start with `docs/about-nemo-relay/release-notes/known-issues.mdx` for the complete prior-release fix history, then review `.agents/skills/draft-release-notes/SKILL.md` and its evidence collector. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **Documentation** * Updated NeMo Relay release notes from **0.4** to **0.5**, including highlights, release scope/capabilities, and compatibility/migration changes. * Refreshed **known issues** and “Fixed in” notes for NeMo Relay **0.5**, plus reorganized prior-release sections. * **New Features** * Added a guided **Draft Release Notes** workflow to standardize evidence-based authoring, claim validation, and targeted MDX updates. * Introduced an evidence-collection helper that summarizes Git/doc changes between release references for use during drafting and review. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Bryan Bednarski (https://github.com/bbednarski9) - https://github.com/lvojtku URL: NVIDIA#362
#### Overview Generate complete API references for published NeMo Relay Rust crates and Python packages. - [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 - Include the published types, native plugin, worker protocol, and worker SDK crates in Rust reference generation. - Generate package-scoped Python references for both `nemo-relay` and `nemo-relay-plugin`; the latter renders its public worker SDK symbols. - Redirect the legacy PII Python-reference URL to its package-scoped location. #### Where should the reviewer start? Start with `scripts/docs/generate_python_library_reference.py` and `scripts/docs/generate_rust_library_reference.py`, which declare the generated package and crate surfaces. Validation: `just docs`; `uv run pre-commit run --all-files`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **New Features** * Enhanced the Python API reference generator to support multiple packages with package-aware URLs, navigation, and landing pages. * Expanded the Rust API reference generation to cover additional NeMo Relay crates. * **Documentation** * Updated documentation redirect rules, including restoration of the release-notes “related topics” redirect and added new generated API reference redirects, plus build plugin guide and CLI “about” redirects. * Updated the “Plugin Configuration Files” documentation route to the new path. * **Bug Fixes** * Fixed legacy documentation redirects (including the `pii-redaction` destination). Signed-off-by: Will Killian <wkillian@nvidia.com>
#### Overview Update documentation CODEOWNERS entries so NAT developers are requested alongside technical writers. - [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 - Add `@nvidia/NAT-developers` to the `docs/` and `fern/` ownership rules. - Preserve the existing technical-writer reviewer on both rules. #### Where should the reviewer start? Review `.github/CODEOWNERS`; it is the only changed file. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes RELAY-444 ## Summary by CodeRabbit * **Chores** * Updated documentation ownership rules for repo docs-related paths. * Added an additional owner for `docs/` and `fern/` to broaden review coverage. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Eric Evans II (https://github.com/ericevans-nv) URL: NVIDIA#384
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:XXL
WalkthroughThis PR reorganizes NeMo Relay documentation into a new "Configure Plugins" section and restructured "Build Plugins" (including new dynamic-plugins/native-dynamic/grpc-worker guides), updates release notes to version 0.5, retargets many cross-document links, updates navigation and redirects, adds a release-notes drafting skill/script, and updates doc-generation scripts and CODEOWNERS. ChangesDocumentation Restructure
Estimated code review effort: 3 (Moderate) | ~30 minutes API Reference Generation Scripts
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
willkill07
changed the title
willkill07
removed
lang:python
github-actions
Bot
added
size:XXL
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/configure-plugins/observability/atif.mdx (1)
128-193: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winHeading nesting places S3-specific field tables under "Multiple Destinations."
#### Connection Fieldsand#### Secret Credential Fields(both describing S3-specific fields likebucket,access_key_id,secret_access_key_var) immediately follow### Multiple Destinations, so they render as children of that section rather than of### S3-Compatible Storagewhere they topically belong. A reader could mistakenly think these fields only apply to multi-destination setups.♻️ Suggested restructuring
Move the
#### Connection Fieldsand#### Secret Credential Fieldssubsections to directly follow### S3-Compatible Storage(before### HTTP Endpoint Storage), so their heading hierarchy correctly reflects that they describe S3-Compatible Storage fields, not Multiple Destinations fields.🤖 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/configure-plugins/observability/atif.mdx` around lines 128 - 193, The S3-specific subsections are nested under the wrong parent heading in the ATIF docs, making `Connection Fields` and `Secret Credential Fields` appear as part of `Multiple Destinations` instead of `S3-Compatible Storage`. Move those two `####` sections so they sit directly under the `### S3-Compatible Storage` section, before the `### HTTP Endpoint Storage` section, and keep their content unchanged. Use the existing headings `Multiple Destinations`, `Connection Fields`, and `Secret Credential Fields` to relocate the blocks without altering the field descriptions.docs/configure-plugins/pii-redaction/configuration.mdx (1)
292-322: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winBold pseudo-headings break the document's heading hierarchy.
**Common PII**,**Structured Secrets**, and**Cloud Credentials**are used as visual sub-sections under## Detector Presets, but elsewhere in this same page (### Current Status,### Requirements,### CLI Editor Support) subsections use real Markdown headings. Bold text isn't picked up by TOC/anchor navigation or screen readers the way a heading is.As per coding guidelines, "Flag heading levels that skip hierarchy in rendered documentation for accessibility."
♻️ Proposed fix
-**Common PII** +### Common PII(repeat for
Structured SecretsandCloud Credentials)🤖 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/configure-plugins/pii-redaction/configuration.mdx` around lines 292 - 322, The pseudo-headings under Detector Presets are plain bold text instead of real Markdown headings, which breaks the document hierarchy and accessibility. Update the section labels in this MDX page so Common PII, Structured Secrets, and Cloud Credentials use proper heading syntax consistent with the existing ### subsections like Current Status and Requirements. Keep the detector lists underneath each heading unchanged and ensure the heading levels fit naturally under ## Detector Presets.Source: Coding guidelines
docs/configure-plugins/adaptive/configuration.mdx (1)
111-176: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winPython and Node.js examples in this section skip the initialize/clear lifecycle shown in the Rust example right below them.
The Rust snippet (lines 219-229) does register → validate → initialize → run work →
clear_plugin_configuration()→Ok(()). The Python snippet (line 142) just doesactive = asyncio.run(nemo_relay.plugin.initialize(plugin_config))with notry/finallyand nonemo_relay.plugin.clear(), and the Node snippet (lines 172-175) never callsplugin.clear()either. This is also inconsistent with the more specificacg.mdx/adaptive-hints.mdxpages, which show the full lifecycle (including cleanup) for all three languages. Readers copying the Python/Node examples here will miss teardown.♻️ Suggested Python fix to match the Rust/other-page lifecycle
-active = asyncio.run(nemo_relay.plugin.initialize(plugin_config)) +async def main(): + await nemo_relay.plugin.initialize(plugin_config) + try: + # Run instrumented application work here. + pass + finally: + nemo_relay.plugin.clear() + +asyncio.run(main())🤖 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/configure-plugins/adaptive/configuration.mdx` around lines 111 - 176, The Python and Node.js examples in this section omit the full register/validate/initialize/clear lifecycle shown in the Rust example and the related adaptive docs. Update the Python snippet around adaptive_config/plugin.initialize and the Node.js snippet around plugin.validate/plugin.initialize to include cleanup via the matching clear call in a try/finally-style flow so readers see how to tear down the plugin after use. Keep the examples aligned with the lifecycle used in the Rust snippet and the other adaptive pages, using the existing adaptiveConfig/pluginConfig and plugin.initialize/plugin.clear symbols.
🤖 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 @.agents/skills/draft-release-notes/scripts/collect_release_evidence.py:
- Around line 43-45: The resolve_ref helper is swallowing useful failure context
because run_git is called with rev-parse --verify --quiet, which can leave both
stdout and stderr empty on invalid refs. Update resolve_ref to detect this case
and raise a clearer error message that includes the ref being resolved and a
helpful hint, instead of relying on run_git’s generic RuntimeError. Keep the fix
localized to resolve_ref and, if needed, the run_git error handling path so
failures from git rev-parse remain informative.
In @.github/CODEOWNERS:
- Around line 10-12: Update the CODEOWNERS entries for the docs/ and fern/ paths
to use the lowercase team slug `@nvidia/nat-developers` instead of the mixed-case
`@nvidia/NAT-developers`, matching the canonical owner reference already used
elsewhere in CODEOWNERS so ownership assignment works reliably.
In `@docs/build-plugins/about.mdx`:
- Around line 61-65: Reorder the “Build a language binding plugin” checklist in
about.mdx so it matches the actual setup flow. Update the list referenced by the
build-plugins/language-binding section to place “Design Plugin Configuration”
before “Register Plugin Behavior,” then keep validation and code examples in the
correct order.
In `@docs/build-plugins/dynamic-plugins/about.mdx`:
- Around line 23-51: The manifest example in the dynamic plugins docs should be
labeled as macOS-specific because the shown shared-library path uses the .dylib
suffix. Update the surrounding text near the manifest example to clearly
indicate it applies only to macOS, and point readers to the Linux/Windows
variants elsewhere in the docs so they don’t copy an invalid path. Use the
manifest example section in about.mdx as the anchor for the wording change.
In `@docs/build-plugins/dynamic-plugins/native-dynamic/about.mdx`:
- Around line 23-51: The shared-library manifest example in the native dynamic
plugin docs is not platform-neutral because it hard-codes a .dylib path, so
update the example to be explicitly macOS-specific and make sure the surrounding
explanation in the about.mdx section points readers to the correct Linux and
Windows library extensions. Keep the manifest snippet and its artifact/library
fields aligned with the platform note so users copy the right path for their OS.
In
`@docs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdx`:
- Around line 93-95: The platform library filename guidance is incomplete
because it mentions only the extension suffixes instead of the full Cargo
artifact name. Update the text in the Rust native plugin example to tell readers
to use the complete target filename produced by Cargo for each platform, and
ensure the placeholder replacement guidance in the manifest fields reflects the
full artifact filename rather than just .dylib, .so, or .dll.
In `@docs/build-plugins/language-binding/register-behavior.mdx`:
- Around line 175-204: The register() implementation for the inject-header
plugin is masking invalid config by defaulting header_name and value to x-plugin
and enabled even though validate() already requires those fields. Remove the
fallback behavior in register() and read the validated config values directly so
PluginRegistrationContext only registers with explicit user-provided header_name
and value, keeping the behavior consistent with the contract.
In `@docs/configure-plugins/adaptive/acg.mdx`:
- Around line 163-173: The Rust example currently panics on plugin validation by
using assert! in the main flow instead of returning an error like the Python and
Node.js examples. Update the example around validate_plugin_config,
initialize_plugins, and main so validation failures are propagated through the
existing Result<(), Box<dyn std::error::Error>> return path rather than
triggering a panic, keeping the Rust snippet consistent with the other language
samples.
In `@docs/configure-plugins/observability/atof.mdx`:
- Around line 321-346: The “Common Configuration and Runtime Issues” section is
missing the `endpoints[i].field_name_policy` validation failure described
earlier in this doc. Update the issue list near the observability configuration
examples to include this failure mode alongside the other endpoint validation
errors, using the same terminology as the `AtofExporterConfig`/endpoint
validation docs so readers can find it consistently.
In `@docs/configure-plugins/plugin-configuration-files.mdx`:
- Around line 323-337: In the paragraph describing explicit defaults and
overrides, replace the term “readers” with the same user-facing role used
elsewhere in the doc, such as “users” or “operators,” so the sentence matches
the surrounding configuration-editing terminology. Update the wording in the
section that mentions NeMo Guardrails, PII Redaction, and dynamic-plugin fields,
keeping the rest of the explanation unchanged and consistent with the existing
config-model language.
In `@fern/docs.yml`:
- Around line 75-80: The wildcard redirect under the build plugin guides is
sending multiple old URLs into the language-binding configure namespace instead
of staying within the matching build-plugins content tree. Update the redirects
in docs.yml so the catch-all for build-plugins maps to the corresponding
docs/build-plugins subtree, or split the redirect rules by section; use the
existing basic-guide and :slug* entries as the places to adjust the target
destinations.
---
Outside diff comments:
In `@docs/configure-plugins/adaptive/configuration.mdx`:
- Around line 111-176: The Python and Node.js examples in this section omit the
full register/validate/initialize/clear lifecycle shown in the Rust example and
the related adaptive docs. Update the Python snippet around
adaptive_config/plugin.initialize and the Node.js snippet around
plugin.validate/plugin.initialize to include cleanup via the matching clear call
in a try/finally-style flow so readers see how to tear down the plugin after
use. Keep the examples aligned with the lifecycle used in the Rust snippet and
the other adaptive pages, using the existing adaptiveConfig/pluginConfig and
plugin.initialize/plugin.clear symbols.
In `@docs/configure-plugins/observability/atif.mdx`:
- Around line 128-193: The S3-specific subsections are nested under the wrong
parent heading in the ATIF docs, making `Connection Fields` and `Secret
Credential Fields` appear as part of `Multiple Destinations` instead of
`S3-Compatible Storage`. Move those two `####` sections so they sit directly
under the `### S3-Compatible Storage` section, before the `### HTTP Endpoint
Storage` section, and keep their content unchanged. Use the existing headings
`Multiple Destinations`, `Connection Fields`, and `Secret Credential Fields` to
relocate the blocks without altering the field descriptions.
In `@docs/configure-plugins/pii-redaction/configuration.mdx`:
- Around line 292-322: The pseudo-headings under Detector Presets are plain bold
text instead of real Markdown headings, which breaks the document hierarchy and
accessibility. Update the section labels in this MDX page so Common PII,
Structured Secrets, and Cloud Credentials use proper heading syntax consistent
with the existing ### subsections like Current Status and Requirements. Keep the
detector lists underneath each heading unchanged and ensure the heading levels
fit naturally under ## Detector Presets.
🪄 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: c30792e9-2e98-4196-9b01-944e035100a2
📒 Files selected for processing (72)
.agents/skills/draft-release-notes/SKILL.md.agents/skills/draft-release-notes/scripts/collect_release_evidence.py.github/CODEOWNERSREADME.mddocs/about-nemo-relay/architecture.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/about-nemo-relay/overview.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/build-plugins/about.mdxdocs/build-plugins/code-examples.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/build-plugins/language-binding/about.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/build-plugins/register-behavior.mdxdocs/configure-plugins/about.mdxdocs/configure-plugins/adaptive/about.mdxdocs/configure-plugins/adaptive/acg.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/configure-plugins/model-pricing.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/observability/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/pii-redaction/about.mdxdocs/configure-plugins/pii-redaction/configuration.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/contribute/runtime-contract-docs.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/getting-started/configuration.mdxdocs/getting-started/installation.mdxdocs/getting-started/prerequisites.mdxdocs/getting-started/quick-start/index.mdxdocs/index.ymldocs/instrument-applications/instrument-llm-call.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/reference/llm-request-intercept-outcomes.mdxdocs/reference/tool-execution-intercept-outcomes.mdxdocs/resources/support-and-faqs.mdxdocs/resources/troubleshooting/index.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/supported-integrations/deepagents.mdxdocs/supported-integrations/langchain.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/openclaw-plugin.mdxfern/docs.ymlscripts/docs/generate_python_library_reference.pyscripts/docs/generate_rust_library_reference.py
💤 Files with no reviewable changes (2)
- docs/build-plugins/code-examples.mdx
- docs/build-plugins/register-behavior.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 (26)
.agents/skills/**
⚙️ CodeRabbit configuration file
.agents/skills/**:Maintainer Skills
This directory is the maintainer-only skill set for developing NeMo Relay
itself.Use these skills for repository work such as:
- Changing core or binding APIs
- Maintaining integrations, packaging, CI, and docs
- Extending middleware or observability internals
- Validating library changes across bindings
Consumer-facing NeMo Relay usage skills live in the top-level
skills/
directory so they can be exported separately for integrators and end users.
Files:
.agents/skills/draft-release-notes/SKILL.md.agents/skills/draft-release-notes/scripts/collect_release_evidence.py
{.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:
.github/CODEOWNERSscripts/docs/generate_rust_library_reference.pyscripts/docs/generate_python_library_reference.py
**/*.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)
For documentation-site changes, run the docs build/validation flow (
just docsor./scripts/build-docs.sh html) so generated Fern API reference pages are refreshed before validation.In MDX files, top-of-file comments must use JSX comment delimiters
{/* ... */}for SPDX headers; do not use HTML comments
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxdocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxdocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
**/*.{rs,py,go,js,ts,jsx,tsx,md,mdx,toml,yaml,yml,html}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
All source files must include an SPDX license header using the comment syntax appropriate for the file type, with SPDX-FileCopyrightText for 2026 NVIDIA CORPORATION & AFFILIATES and SPDX-License-Identifier: Apache-2.0.
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxscripts/docs/generate_rust_library_reference.pydocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/index.ymldocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxfern/docs.ymldocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxREADME.mddocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxscripts/docs/generate_python_library_reference.pydocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
**/*.{rs,py,go,js,ts,md,mdx,toml,yaml,yml,json}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Avoid using
SONAR_IGNORE_START/SONAR_IGNORE_ENDexcept for documented false positives; keep the ignored block small, add a brief explanatory comment, and call it out in the PR description.
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxscripts/docs/generate_rust_library_reference.pydocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/index.ymldocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxfern/docs.ymldocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxREADME.mddocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxscripts/docs/generate_python_library_reference.pydocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
**/*.{md,mdx}: Keep package names, repository references, and build commands current in documentation and examples
Keep stable user-facing wrappers at thescripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxdocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxdocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxREADME.mddocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
{RELEASING.md,docs/**/*.md,docs/**/*.mdx}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in maintainer-facing docs such as RELEASING.md, not in user-facing docs pages or CHANGELOG.md
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxdocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxdocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
**
⚙️ CodeRabbit configuration file
**:AGENTS.md
This file provides guidance to agents, including Claude Code and OpenAI Codex, when working in this repository.
Project Overview
NeMo Relay is a multi-language agent runtime framework for execution scopes, lifecycle events, middleware, plugins, and observability around tool and LLM calls. The core runtime is Rust. Primary supported bindings are Rust, Python, and Node.js. Go and the raw C FFI are experimental and source-first.
The shared runtime model is:
- Scope stacks decide where work belongs and which scope-local behavior is visible.
- Middleware registries decide what guardrails and intercepts run around managed calls.
- Plugins install reusable runtime behavior from configuration.
- Events record runtime behavior in ATOF form.
- Subscribers and exporters consume events in-process or export them to ATIF, OpenTelemetry, OpenInference, or other backends.
Repository Structure
The repository layout separates the Rust runtime, language bindings,
documentation, integrations, and agent-facing skills.crates/ core/ # Rust core runtime crate, published as nemo-relay adaptive/ # Adaptive runtime primitives and plugin components python/ # PyO3 native extension for the Python package ffi/ # Raw C ABI layer used by downstream bindings such as Go node/ # NAPI Node.js binding and JavaScript/TypeScript entry points python/ nemo_relay/ # Python wrapper package: scopes, tools, LLM, middleware, typed helpers, plugins, adaptive helpers tests/ # Python tests go/ nemo_relay/ # Experimental Go CGo binding and tests fern/ # Fern documentation site scripts/ # Stable wrappers and helper scripts; build/test/docs entry points live in justfile skills/ # Published Codex/agent skills for NeMo Relay usage patternsPrerequisites
Insta...
Files:
docs/configure-plugins/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxscripts/docs/generate_rust_library_reference.pydocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/index.ymldocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxfern/docs.ymldocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxREADME.mddocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxscripts/docs/generate_python_library_reference.pydocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.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/adaptive/about.mdxdocs/getting-started/installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/supported-integrations/langchain.mdxdocs/about-nemo-relay/architecture.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/configure-plugins/about.mdxdocs/instrument-applications/instrument-llm-call.mdxdocs/configure-plugins/discoverable-plugins.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/instrument-applications/instrument-tool-call.mdxdocs/getting-started/prerequisites.mdxdocs/about-nemo-relay/ecosystem.mdxdocs/build-plugins/dynamic-plugins/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/about.mdxdocs/integrate-into-frameworks/wrap-tool-calls.mdxdocs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/native-dynamic/rust-native-plugin-example.mdxdocs/reference/tool-execution-intercept-outcomes.mdxdocs/configure-plugins/model-pricing.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/rust/about.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/configuration.mdxdocs/supported-integrations/deepagents.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/about-nemo-relay/overview.mdxdocs/supported-integrations/langgraph.mdxdocs/configure-plugins/pii-redaction/about.mdxdocs/build-plugins/language-binding/register-behavior.mdxdocs/configure-plugins/observability/about.mdxdocs/resources/troubleshooting/trace-incident-runbook.mdxdocs/build-plugins/language-binding/code-examples.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/index.ymldocs/about-nemo-relay/concepts/subscribers.mdxdocs/configure-plugins/nemo-guardrails/about.mdxdocs/resources/support-and-faqs.mdxdocs/build-plugins/about.mdxdocs/build-plugins/language-binding/about.mdxdocs/about-nemo-relay/concepts/plugins.mdxdocs/resources/troubleshooting/index.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/contribute/runtime-contract-docs.mdxdocs/configure-plugins/adaptive/adaptive-hints.mdxdocs/build-plugins/language-binding/advanced-configuration.mdxdocs/configure-plugins/nemo-guardrails/configuration.mdxdocs/configure-plugins/pii-redaction/configuration.mdxREADME.mddocs/configure-plugins/observability/opentelemetry.mdxdocs/build-plugins/language-binding/validate-configuration.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/adaptive/configuration.mdxdocs/integrate-into-frameworks/provider-response-codecs.mdxdocs/configure-plugins/adaptive/acg.mdxdocs/reference/llm-request-intercept-outcomes.mdx
docs/getting-started/**
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update
docs/getting-started/materials when usage or onboarding behavior changed.
Files:
docs/getting-started/installation.mdxdocs/getting-started/agent-runtime-primer.mdxdocs/getting-started/prerequisites.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/configuration.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: When drafting NeMo Relay release notes, 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 page roles:index.mdxshould provide the current-release summary, compatibility notes, scope, and curated feature links;highlights.mdxshould group notable changes by user-facing theme;known-issues.mdxshould record current limitations, compatibility migrations, current-release fixes, and the complete fixed-item history from earlier release-note pages.
Preserve the MDX front matter and the JSX SPDX comment in the release-notes pages.
State that the full release history is available in GitHub Releases, and do not create a changelog or GitHub Release body from this skill.
Verify each candidate claim against the changed public docs, API types, command help, or source before including it, prioritizing breaking changes, migrations, user-visible features, and ongoing support limitations.
Check product names, commands, package names, support claims, and links against the current repository before handing off the release-notes draft.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/reference/**
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update relevant pages under
docs/reference/when the public surface or expected usage changed.
Files:
docs/reference/tool-execution-intercept-outcomes.mdxdocs/reference/llm-request-intercept-outcomes.mdx
**/*.{rs,py,js,ts,mjs,c,h,md,toml,yml,yaml,sh,json,go}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source files, documentation, scripts, and configuration files.
Files:
scripts/docs/generate_rust_library_reference.pydocs/index.ymlfern/docs.ymlREADME.mdscripts/docs/generate_python_library_reference.py
**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
Follow Python naming conventions, including
snake_caseidentifiers and wrapper module API shapes.When changing the Python wrapper package, tests, or docs tooling, follow Ruff rules
E,F,W, andI, format with Ruff formatter (line length 120, double quotes), and satisfytytype checking.
Files:
scripts/docs/generate_rust_library_reference.pyscripts/docs/generate_python_library_reference.py
**/*.{rs,py,go,js,ts}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Use the naming conventions appropriate to each language: Rust
snake_case, C FFI exports prefixednemo_relay_, GoPascalCase, Node.jscamelCase, and Pythonsnake_case.
Files:
scripts/docs/generate_rust_library_reference.pyscripts/docs/generate_python_library_reference.py
**/*.{rs,py,go,js,ts,wasm}
📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)
Ensure binding-native wrappers expose the same observability configuration knobs and lifecycle behavior across Rust, Python, Go, Node.js, and WebAssembly.
Files:
scripts/docs/generate_rust_library_reference.pyscripts/docs/generate_python_library_reference.py
docs/about-nemo-relay/release-notes/known-issues.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
In
known-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit any of that history.
Files:
docs/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:
fern/docs.ymlREADME.md
**/*.{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:
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:
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:
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:
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:
README.md
**/README.md
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.Update binding-level README files when behavior differs by language.
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update
README.mdwhen the public surface or language-specific behavior changes.If docs-only changes modify commands, package names, or examples, run targeted checks such as
just docsorjust docs-linkcheckwhen links changed.
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
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-08T14:23:55.192Z
Learning: Run the read-only evidence-collection helper with explicit previous/current release refs and the target minor version when preparing release notes.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-08T14:23:55.192Z
Learning: Run `git diff --check`, `just docs`, and `just docs-linkcheck` to validate the draft, and preserve unrelated working-tree changes.
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-07-08T14:23:55.192Z
Learning: Use the helper’s output as an evidence index only; do not treat it as publication-ready copy.
🪛 ast-grep (0.44.1)
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py
[warning] 58-58: XPath query is request-/variable-derived; use parameterized XPath to prevent injection.
Context: VERSION_PATTERN.findall(content)
Note: [CWE-643] Improper Neutralization of Data within XPath Expressions ('XPath Injection').
(xpath-injection-python)
[error] 29-35: Command coming from incoming request
Context: subprocess.run(
["git", *args],
cwd=repo,
check=False,
capture_output=True,
encoding="utf-8",
)
Note: [CWE-78] Improper Neutralization of Special Elements used in an OS Command ('OS Command Injection').
(subprocess-from-request)
🪛 LanguageTool
docs/getting-started/quick-start/index.mdx
[style] ~14-~14: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...pplication owns the tool or LLM call. - Use a supported integration guide when a fr...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/build-plugins/dynamic-plugins/grpc-worker/grpc-worker-protocol.mdx
[style] ~127-~127: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d callbacks if initialization fails. 5. Relay removes proxy callbacks before it sends...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/build-plugins/language-binding/advanced-configuration.mdx
[style] ~184-~184: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...idate each unsupported enum or mode. 4. Validate unknown component-local fields and thei...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
README.md
[uncategorized] ~89-~89: Ger doublet «to to».
Context: ...Optionally set: - output_directory to .nemo-relay/atof - filename to events.jsonl - mode to `overwrit...
(GER_DOUBLET)
docs/integrate-into-frameworks/provider-response-codecs.mdx
[style] ~733-~733: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...o add the managed LLM boundary first. - Use [Observability](/configure-plugins/obse...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Ruff (0.15.20)
.agents/skills/draft-release-notes/scripts/collect_release_evidence.py
[error] 30-30: subprocess call: check for execution of untrusted input
(S603)
[error] 31-31: Starting a process with a partial executable path
(S607)
[warning] 39-39: Avoid specifying long messages outside the exception class
(TRY003)
scripts/docs/generate_python_library_reference.py
[warning] 378-378: Use list.extend to create a transformed list
(PERF401)
[warning] 382-382: Too many branches (14 > 12)
(PLR0912)
[warning] 437-437: Avoid specifying long messages outside the exception class
(TRY003)
|
/merge nosquash |
2 participants
Overview
Forward-merge the latest
release/0.5commits intomainwith branch history preserved. This manual forward merge addresses the conflict reported on #380.Details
mainhead.release/0.5head with a signed, two-parent merge commit.Where should the reviewer start?
Review merge commit
c4faa2ef, especially its two parents:e31ba9ebfrommainand0486d88bfromrelease/0.5.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Validation
just docsjust docs-linkcheckuv run pre-commit run --all-filesgit diff --check upstream/main..HEADThe docs checks passed with only the existing FDR 403 warning for the optional published-redirect comparison.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation