docs: resolve VDR documentation gaps

[willkill07]

Overview

Resolve the NeMo Relay 0.6 documentation gaps identified in the VDR preparation report.

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

Details

• Pin published Node.js installation examples to nemo-relay-node@0.6.0.
• Replace the stale versioned Build Plugins README link.
• Add factual positioning for OpenTelemetry GenAI conventions and observability or evaluation products, with links from the Overview and README.

Where should the reviewer start?

Review docs/about-nemo-relay/ecosystem.mdx for the new comparison, then the Node.js installation examples and README entry points.

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

• Relates to: none

Summary by CodeRabbit

• Documentation
  • Added an ecosystem guide explaining how NeMo Relay complements telemetry, observability, and evaluation tooling.
  • Linked the new ecosystem guidance from relevant introductory documentation.
  • Updated Build Plugins documentation links.
  • Standardized Node.js installation instructions to use nemo-relay-node@0.6.0 across the README and setup guides.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: c40a7a3d-1264-44c7-a0eb-cd06874135f8

📥 Commits

Reviewing files that changed from the base of the PR and between 396d04a and b8ab194.

📒 Files selected for processing (6)

• README.md
• crates/node/README.md
• docs/about-nemo-relay/ecosystem.mdx
• docs/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx

📜 Recent review details

⏰ Context from checks skipped due to timeout. (2)

• GitHub Check: Check / Run
• GitHub Check: Preview docs

🧰 Additional context used

📓 Path-based instructions (17)

**/*.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/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• docs/about-nemo-relay/ecosystem.mdx

**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Update README.md, fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change.

**/*.{md,mdx}: Prefer the documented public API, not internal shortcuts
Keep package names, repo references, and build commands current
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, and grpc-v1 protocol details on separate pages

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

Files:

• docs/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• crates/node/README.md
• docs/about-nemo-relay/ecosystem.mdx
• README.md

**/*.{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/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• crates/node/README.md
• docs/about-nemo-relay/ecosystem.mdx
• README.md

{docs,examples}/**/*

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

Update docs and examples.

Files:

• docs/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• docs/about-nemo-relay/ecosystem.mdx

**/*

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

**/*: Format changed files with the language-native formatter before the final lint/test pass.
If dynamic plugin behavior changed, use maintain-dynamic-plugins and include the native SDK, worker protocol, Python SDK, docs, packaging, and Codecov surfaces in the validation plan.
If code changes alter APIs, bindings, commands, paths, packaging behavior, observability/adaptive semantics, or documented best practices, update any dependent maintainer or consumer skills in the same branch.
During iteration, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

Files:

• docs/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• crates/node/README.md
• docs/about-nemo-relay/ecosystem.mdx
• README.md

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/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• docs/about-nemo-relay/ecosystem.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/about-nemo-relay/overview.mdx
• docs/getting-started/installation.mdx
• docs/getting-started/quick-start/nodejs.mdx
• docs/about-nemo-relay/ecosystem.mdx
• README.md

**/*.{md,rst,html,txt}

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

**/*.{md,rst,html,txt}: Always spell NVIDIA in all caps. Do not use Nvidia, nvidia, nVidia, nVIDIA, or NV.
Use an NVIDIA before a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol after NVIDIA when referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names with NVIDIA on first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms with s, not an apostrophe, such as GPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such as CPU, GPU, PC, API, and UI usually do not need to be spelled out for developer audiences.

Files:

• crates/node/README.md
• README.md

**/*.{md,rst,html}

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

Link the first mention of a product name when the destination helps the reader.

Files:

• crates/node/README.md
• README.md

**/*.{md,rst,txt}

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

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

Files:

• crates/node/README.md
• README.md

**/*.{md,rst}

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

**/*.{md,rst}: Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as "here" or "read more."
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Use can for possibility and reserve may for permission.
Use after for temporal relationships instead of once.
Prefer refer to over see when the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical docs.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented docs unless the source, platform, or legal guidance explicitly requires them.

Files:

• crates/node/README.md
• README.md

**/*.md

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

**/*.md: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Format code elements, commands, parameters, package names, and expressions in monospace
Format directories, file names, and paths in monospace using backticks
Use angle brackets inside monospace for variables inside paths, such as /home/<username>/.login
Format error messages and strings in quotation marks, keeping literal code strings in code formatting when clearer
Format UI buttons, menus, fields, and labels in bold
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use, sparingly and only when introducing the term
Use italics for publication titles
Format keyboard shortcuts in plain text, such as Press Ctrl+Alt+Delete
Use owner/repo link text for GitHub repositories, preferring [NVIDIA/NeMo](link) over prose references like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text
Avoid generic anchor text such as 'here,' 'this page,' and 'read more'
Include acronyms in link text when a linked term includes an acronym
Do not link long sentences or multiple sentences
Avoid links that pull readers away from a procedure unless the link is a p...

Files:

• crates/node/README.md
• README.md

crates/{python,ffi,node}/**/*

⚙️ CodeRabbit configuration file

crates/{python,ffi,node}/**/*: Treat binding changes as public API changes. Check for parity with the other language bindings, FFI ownership/lifetime safety,
callback error propagation, stable type conversion, and consistent async/stream semantics.
Flag changes that update one binding without corresponding tests or documentation for the same surface elsewhere.

Files:

• crates/node/README.md

{README.md,docs/**/*.{md,rst,txt},fern/**/*}

📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)

Search and update documentation source for references to the old version in README.md, docs, and fern directories, updating current-version install commands, package examples, and configuration examples to <next-version>

Files:

• README.md

{docs/**/*.md,README.md}

📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)

Update reference docs, language-binding docs, READMEs, and example documentation when the public surface or expected usage changes.

Files:

• README.md

{README.md,docs/index.md}

📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)

Update entry-point docs when examples or reading paths change

Files:

• README.md

README.md

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If documentation examples or commands in README.md change, run the targeted docs checks appropriate to the change.

Files:

• README.md

🔇 Additional comments (6)

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

34-35: 📐 Maintainability & Code Quality

Run just docs-linkcheck for all changed documentation links.

• docs/about-nemo-relay/overview.mdx#L34-L35: validate the new ecosystem subsection link and anchor.
• README.md#L24-L25: validate the new Ecosystem guide URL.
• README.md#L36-L36: validate the updated Build Plugins URL.

As per coding guidelines, if links in documentation change, run just docs-linkcheck.

Source: Coding guidelines

README.md (1)

217-217: LGTM!

crates/node/README.md (1)

62-62: LGTM!

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

197-197: LGTM!

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

22-22: LGTM!

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

52-55: 🎯 Functional Correctness

No change needed here. Relay already uses the same OTLP trace-span terminology elsewhere, so this wording is consistent.

			> Likely an incorrect or invalid review comment.

---

Walkthrough

Documentation now explains Relay’s relationship to telemetry and evaluation tooling, links to the ecosystem guide, updates the Build Plugins URL, and pins all documented Node.js package installs to nemo-relay-node@0.6.0.

Changes

Documentation and installation updates

Layer / File(s)	Summary
Ecosystem positioning guidance docs/about-nemo-relay/ecosystem.mdx, docs/about-nemo-relay/overview.mdx, README.md	Adds ecosystem guidance describing Relay’s role relative to telemetry conventions and observability or evaluation products, with links from introductory content.
Installation and documentation links README.md, crates/node/README.md, docs/getting-started/...	Pins Node.js installation commands to nemo-relay-node@0.6.0 and changes the Build Plugins link to the current non-versioned documentation URL.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title follows Conventional Commits and accurately summarizes the documentation-focused changes.
Description check	✅ Passed	The description matches the template well with overview, details, reviewer start, and checklist items filled in.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[github-actions]

Fern docs preview: https://nvidia-preview-pull-request-521.docs.buildwithfern.com/nemo/relay/dev

[willkill07]

/merge