docs: update 0.6 release notes#450
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughNeMo Relay documentation was updated for version 0.6 across release notes, coding-agent integrations, MCP gateway lifecycle, Observability configuration v2, ATOF/OTLP export semantics, dynamic plugins, skills, E2E fixtures, migration guidance, and known issues. ChangesNeMo Relay 0.6 documentation
Estimated code review effort: 4 (Complex) | ~60 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
github-actions
Bot
added
size:M
github-actions
Bot
added
size:XL
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/configure-plugins/observability/openinference.mdx`:
- Around line 126-150: Update the lifecycle projection documentation in
docs/configure-plugins/observability/openinference.mdx lines 126-150 to use
nemo_relay.start.metadata.* and nemo_relay.end.metadata.* for lifecycle
metadata, and update the alias example accordingly; keep the separate
OpenInference aggregate metadata attribute distinction. Apply the corresponding
namespace correction in
skills/nemo-relay-plugin-observability/references/openinference.md lines 26-32,
replacing openinference.metadata lifecycle references with the appropriate
nemo_relay.* prefixes.
In `@docs/nemo-relay-cli/plugin-installation.mdx`:
- Line 85: Update the Linux plugin path documentation in the plugin installation
table to use $HOME in the XDG_DATA_HOME fallback, replacing the tilde-based
fallback with ${XDG_DATA_HOME:-$HOME/.local/share} so the default path resolves
correctly.
In `@skills/nemo-relay-plugin-observability/references/opentelemetry.md`:
- Around line 27-32: Update the projected-attribute naming contract in the
OpenTelemetry documentation to state that scalar start/end data and metadata
children use typed dotted attributes such as nemo_relay.start.metadata.tenant,
while nested objects and arrays remain JSON strings at their own top-level
dotted attributes. Preserve the documented omission of top-level null fields and
removal of legacy *_json aggregate attributes.
🪄 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: 7921e366-4657-44e5-9dde-044f5ae94471
📒 Files selected for processing (29)
README.mdcrates/cli/README.mddocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/observability/atof.mdxdocs/configure-plugins/observability/configuration.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/getting-started/installation.mdxdocs/getting-started/quick-start/index.mdxdocs/nemo-relay-cli/about.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/hermes.mdxdocs/nemo-relay-cli/plugin-installation.mdxintegrations/coding-agents/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/codex/README.mdscripts/test-claude-plugin-e2e.shscripts/test-codex-plugin-e2e.shscripts/test-hermes-mcp-e2e.shskills/nemo-relay-get-started/references/cli-try-now.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/opentelemetry.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
- GitHub Check: Rust / Test (windows-arm64)
- GitHub Check: Rust / Test (linux-arm64)
- GitHub Check: Rust / Test (linux-amd64)
- GitHub Check: Rust / Test (macos-arm64)
- GitHub Check: Rust / Test (windows-amd64)
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (22)
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
In MDX files, top-of-file comments must use JSX comment delimiters (
{/*to open and*/}to close); do not use HTML comments for MDX SPDX headers
Files:
docs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/atof.mdx
**/*.{md,mdx}
📄 CodeRabbit inference engine (AGENTS.md)
Update
README.md,fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.
**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such asRELEASING.md, not as user-facing docs pages orCHANGELOG.md
Keep stable user-facing wrappers atscripts/root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, andgrpc-v1protocol details on separate pagesIf links in documentation change, run
just docs-linkcheck.
Files:
docs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mddocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxREADME.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxcrates/cli/README.mddocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.mddocs/configure-plugins/observability/atof.mdx
**/*.{md,markdown,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Add the SPDX license header to all Markdown/MDX documentation files using the HTML comment block form.
Files:
docs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mddocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxREADME.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxcrates/cli/README.mddocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.mddocs/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.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/atof.mdx
**/*
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, usemaintain-dynamic-pluginsand include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, preferuv run pre-commit run --files <changed files...>.
Before review or handoff, runuv run pre-commit run --all-files.
Files:
docs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxskills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdscripts/test-hermes-mcp-e2e.shscripts/test-claude-plugin-e2e.shskills/nemo-relay-get-started/references/cli-try-now.mddocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxscripts/test-codex-plugin-e2e.shREADME.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxcrates/cli/README.mddocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxintegrations/coding-agents/codex/README.mddocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.mddocs/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.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxdocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/atof.mdx
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/getting-started/quick-start/index.mdxdocs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdxdocs/getting-started/installation.mdxdocs/configure-plugins/observability/opentelemetry.mdxREADME.mddocs/nemo-relay-cli/about.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/atif.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/nemo-relay-cli/claude-code.mdxdocs/nemo-relay-cli/basic-usage.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/configure-plugins/observability/configuration.mdxdocs/nemo-relay-cli/codex.mdxdocs/nemo-relay-cli/plugin-installation.mdxdocs/nemo-relay-cli/hermes.mdxdocs/configure-plugins/plugin-configuration-files.mdxdocs/configure-plugins/observability/atof.mdx
{crates/core/src/plugin/dynamic/**,crates/plugin/**,crates/worker/**,crates/worker-proto/**,crates/types/**,python/plugin/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Keep the stable boundary explicit: native plugins cross a C ABI, and worker plugins cross
grpc-v1.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{crates/core/src/plugin/dynamic/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**,docs/build-plugins/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
Native and worker plugins are trusted extensions; document that native plugins are in-process and unsandboxed, and worker plugins provide process isolation but not a security sandbox.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
{docs/build-plugins/**,examples/rust-native-plugin/**,examples/python-grpc-worker-plugin/**}
📄 CodeRabbit inference engine (.agents/skills/maintain-dynamic-plugins/SKILL.md)
When detailed dynamic plugin guides exist, keep Rust native, Python worker, and
grpc-v1protocol details on separate pages.
Files:
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mdREADME.mdcrates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mdREADME.mdcrates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Spell
NVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mdREADME.mdcrates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.md
**/*.{md,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mdREADME.mdcrates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring[NVIDIA/NeMo](link)over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...
Files:
skills/nemo-relay-plugin-observability/references/opentelemetry.mdskills/nemo-relay-plugin-observability/references/openinference.mdskills/nemo-relay-plugin-observability/references/atof.mdskills/nemo-relay-get-started/references/cli-try-now.mdREADME.mdcrates/cli/README.mdintegrations/coding-agents/codex/README.mdintegrations/coding-agents/claude-code/README.mdintegrations/coding-agents/README.md
{.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-hermes-mcp-e2e.shscripts/test-claude-plugin-e2e.shscripts/test-codex-plugin-e2e.sh
{README.md,docs/**/*.{md,rst,txt},fern/**/*}
📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Search and update documentation source for references to the old version in
README.md,docs, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.md
{docs/**/*.md,README.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.
Files:
README.md
{README.md,docs/index.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Update entry-point docs when examples or reading paths change
Files:
README.md
README.md
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
If documentation examples or commands in
README.mdchange, run the targeted docs checks appropriate to the change.
Files:
README.md
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update onlydocs/about-nemo-relay/release-notes/index.mdx,docs/about-nemo-relay/release-notes/highlights.mdx, anddocs/about-nemo-relay/release-notes/known-issues.mdxunless the release changes their route or entry points.
Preserve the existing MDX front matter and the JSX SPDX comment in the release-notes pages.
Files:
docs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/about-nemo-relay/release-notes/known-issues.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/known-issues.mdx: Inknown-issues.mdx, preserve every prior fixed-item bullet under release-labeled subsections; do not summarize, deduplicate, or omit it.
Inknown-issues.mdx, keep the complete fixed-item history recorded in earlier release-note pages.
Files:
docs/about-nemo-relay/release-notes/known-issues.mdx
🧠 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/opentelemetry.mdxdocs/configure-plugins/observability/openinference.mdxdocs/configure-plugins/observability/atif.mdxdocs/configure-plugins/observability/configuration.mdxdocs/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 (28)
docs/configure-plugins/observability/atif.mdx (1)
31-31: LGTM!Also applies to: 303-303
docs/configure-plugins/observability/atof.mdx (1)
3-16: LGTM!Also applies to: 48-60, 69-113, 123-148, 168-175, 211-211, 243-264, 281-329, 340-352, 371-373, 392-399, 418-426
docs/configure-plugins/observability/configuration.mdx (1)
38-40: LGTM!Also applies to: 85-86, 133-139, 157-157, 181-181, 199-199, 216-224, 276-328, 345-424, 441-441
scripts/test-claude-plugin-e2e.sh (1)
98-104: LGTM!scripts/test-codex-plugin-e2e.sh (1)
146-152: LGTM!scripts/test-hermes-mcp-e2e.sh (1)
125-131: LGTM!docs/configure-plugins/observability/openinference.mdx (1)
34-34: LGTM!Also applies to: 66-66, 154-156, 227-227
docs/configure-plugins/observability/opentelemetry.mdx (1)
29-29: LGTM!Also applies to: 60-60, 98-126, 218-218
docs/configure-plugins/plugin-configuration-files.mdx (1)
42-51: LGTM!Also applies to: 103-112, 263-302, 368-374, 403-403
docs/build-plugins/dynamic-plugins/grpc-worker/python/about.mdx (1)
214-220: LGTM!Also applies to: 238-244
skills/nemo-relay-get-started/references/cli-try-now.md (1)
115-124: LGTM!skills/nemo-relay-plugin-observability/references/atof.md (1)
25-54: LGTM!Also applies to: 65-69
skills/nemo-relay-plugin-observability/references/openinference.md (1)
23-25: LGTM!Also applies to: 33-38
docs/about-nemo-relay/release-notes/index.mdx (1)
82-93: LGTM!docs/about-nemo-relay/release-notes/known-issues.mdx (1)
28-44: LGTM!Also applies to: 264-265
docs/nemo-relay-cli/hermes.mdx (1)
3-229: LGTM!docs/nemo-relay-cli/plugin-installation.mdx (1)
2-58: LGTM!Also applies to: 67-84, 86-281, 290-359, 370-378
integrations/coding-agents/README.md (1)
25-42: LGTM!Also applies to: 58-61, 76-146, 156-169, 180-205, 234-282, 305-329
integrations/coding-agents/claude-code/README.md (1)
8-23: LGTM!Also applies to: 33-33, 58-66, 130-130, 172-172, 183-193, 206-213, 225-230, 257-257, 281-283, 305-309, 318-318
integrations/coding-agents/codex/README.md (1)
16-132: LGTM!Also applies to: 145-153, 164-166, 194-219, 257-269, 296-299, 314-329, 376-377, 390-418, 429-444
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/getting-started/installation.mdx (1)
64-74: LGTM!Also applies to: 234-245
docs/getting-started/quick-start/index.mdx (1)
29-29: LGTM!docs/nemo-relay-cli/about.mdx (1)
23-38: LGTM!Also applies to: 59-76
docs/nemo-relay-cli/basic-usage.mdx (1)
57-62: LGTM!Also applies to: 77-84, 98-142, 338-343, 361-390, 399-404
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-82: LGTM!Also applies to: 99-107, 142-218, 232-238, 248-248, 263-291, 350-360, 374-396, 409-415
Signed-off-by: Will Killian <wkillian@nvidia.com> # Conflicts: # docs/nemo-relay-cli/codex.mdx
Signed-off-by: Will Killian <wkillian@nvidia.com> # Conflicts: # docs/nemo-relay-cli/basic-usage.mdx
Signed-off-by: Will Killian <wkillian@nvidia.com>
4368b17 to
334a65f
Compare
github-actions
Bot
added
size:L
|
/merge |
2 participants
Overview
Update all NVIDIA NeMo Relay release-note pages for 0.6 from the complete set of PRs merged after tag
0.5.0, excluding forward merges. The notes now pair precise migration guidance with relevant documentation and originating PRs, while keeping the prose approachable for both people and agents.Details
0.5.0, including all nine PRs labeledbreaking.#NNNas the PR link text.Validation:
uv run pre-commit run --all-filesjust docsjust docs-linkcheckgit diff --check0.5.0and current upstreammain0.5.0Where should the reviewer start?
Start with
docs/about-nemo-relay/release-notes/known-issues.mdxto review the linked migration warnings and fix-history boundary. Then reviewdocs/about-nemo-relay/release-notes/highlights.mdxfor capability grouping and tone.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
attribute_mappings), owned dynamic-plugin hosting lifecycle, and experimental Switchyard routing.