docs: update 0.3 release documentation#180
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
github-actions
Bot
added
size:M
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📜 Recent review details🧰 Additional context used📓 Path-based instructions (11){docs/**,README.md,CONTRIBUTING.md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,README.md,CONTRIBUTING.md,**/*.md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,README.md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,examples/**,README.md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
{docs/**,README.md,**/Cargo.toml,**/package.json,**/*.md}📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Files:
**/*.{md,mdx,py,sh,yaml,yml,toml,json}📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
**/*.mdx📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Files:
**/*.{html,md,mdx}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
docs/**/*.{md,mdx}📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
docs/**📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (1)
WalkthroughDocumentation-only PR updating NeMo Relay 0.3 release materials: new highlights and landing pages, clarified "Relay" runtime terminology, Node.js 24+ and CLI install guidance, non-blocking subscriber delivery/flush guidance, revised agent and OpenClaw support matrices, and a Fern redirect for a removed page. ChangesNeMo Relay 0.3 Release Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/about-nemo-relay/release-notes/known-issues.mdx`:
- Line 38: Change the heading "### Fixed In NeMo Relay 0.3" to use title case
for prepositions by making "In" lowercase; update the markdown heading to "###
Fixed in NeMo Relay 0.3" so it follows the project's title case convention.
- Line 46: The heading "### Fixed In Earlier Releases" should use title case
with the preposition lowercased; update the heading text "Fixed In Earlier
Releases" to "Fixed in Earlier Releases" so the token "In" is lowercase,
ensuring consistent title-case formatting in the document.
- Around line 14-36: Add a complete lead-in sentence immediately before the
bullet list that starts after "These notes apply to the NeMo Relay 0.3 release."
— replace the fragmentary context with a full introductory sentence such as "The
following known issues and limitations apply to NeMo Relay 0.3:" so the list has
a grammatical lead-in; update the text surrounding that sentence to ensure it
reads as a single coherent paragraph followed by the bullets.
In `@docs/nemo-relay-cli/about.mdx`:
- Around line 44-47: Update the Notes rows for Claude Code and Hermes Agent to
remove informal idioms ("wired up", "in place") and explicitly state which
capabilities are limited or hook-dependent: for Claude Code and Hermes Agent
replace those phrases with "supported" or "enabled" and add a brief clause like
"some guardrail or optimization hooks not implemented (e.g., {specific hook
names if known})" or "guardrail/optimization support is hook-dependent" so the
"⚠️ Partial" status matches the note; also ensure Codex and Cursor notes remain
explicit about missing hooks (e.g., mention "missing hooks under
`cursor-agent`") for consistency.
🪄 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: e0fe967f-7832-479c-b01e-a9211be48e59
📒 Files selected for processing (13)
README.mddocs/about-nemo-relay/concepts/subscribers.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/about-nemo-relay/release-notes/related-topics.mdxdocs/nemo-relay-cli/about.mdxdocs/reference/performance.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/about.mdxdocs/supported-integrations/openclaw-plugin.mdxfern/docs.ymlintegrations/openclaw/README.md
💤 Files with no reviewable changes (1)
- docs/about-nemo-relay/release-notes/related-topics.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Check / Run
- GitHub Check: Preview docs
🧰 Additional context used
📓 Path-based instructions (23)
{docs/**,README.md,CONTRIBUTING.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
{docs/**,README.md,CONTRIBUTING.md}: For docs-only changes, run targeted checks only if commands, package names, or examples changed. Usejust docsfor docs-site builds andjust docs-linkcheckwhen links changed
Run docs site build withjust docs
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
{docs/**,README.md,CONTRIBUTING.md,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Run docs link validation with
just docs-linkcheckwhen links change
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxintegrations/openclaw/README.mddocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
{docs/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify README and docs entry points still match current package names and paths for large or public-facing changes
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
{docs/**,examples/**,README.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Verify examples still run with documented commands for large or public-facing changes
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
{docs/**,README.md,**/Cargo.toml,**/package.json,**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Ensure renamed public surfaces are reflected consistently in manifests and docs for large or public-facing changes
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxintegrations/openclaw/README.mddocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
**/*.{md,mdx,py,sh,yaml,yml,toml,json}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxintegrations/openclaw/README.mddocs/about-nemo-relay/release-notes/index.mdxfern/docs.ymldocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
**/*.mdx
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
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.
MDX top-of-file SPDX comments must use {/* ... */} delimiters instead of HTML comment delimiters (Must-Fix)
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
**/*.{html,md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header in HTML and Markdown files using HTML comment syntax
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxintegrations/openclaw/README.mddocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update embedded documentation snippets, patch docs, and binding-support notes if examples or supported bindings changed
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdx
docs/**
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
just docsor./scripts/build-docs.sh htmlto regenerate ignored Fern API reference pages before validation for documentation site changes
Files:
docs/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.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/supported-integrations/about.mdxdocs/reference/performance.mdxdocs/about-nemo-relay/release-notes/highlights.mdxdocs/about-nemo-relay/release-notes/index.mdxdocs/about-nemo-relay/concepts/subscribers.mdxdocs/nemo-relay-cli/about.mdxdocs/resources/support-and-faqs.mdxdocs/supported-integrations/openclaw-plugin.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxREADME.md
docs/reference/**
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant reference documentation for any public API changes
Files:
docs/reference/performance.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:
integrations/openclaw/README.mdREADME.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:
integrations/openclaw/README.mdREADME.md
**/*.md
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Documentation must be updated if activation or usage changed
**/*.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 ...
Files:
integrations/openclaw/README.mdREADME.md
**/{docs,examples,**/*.md,*.patch,*.diff,.github,*.sh,*.yaml,*.yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, CI configuration, and patch artifacts when performing rename operations
Files:
integrations/openclaw/README.mdfern/docs.ymlREADME.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:
integrations/openclaw/README.mdREADME.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:
integrations/openclaw/README.mdREADME.md
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Files:
integrations/openclaw/README.mdREADME.md
**/*.{py,txt,toml,cfg,yaml,yml}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update Python package names and top-level module imports during coordinated rename operations
Files:
fern/docs.yml
{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
{README.md,docs/getting-started/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Update
README.md,docs/getting-started/, or binding-level READMEs if behavior differs by language or usage changed
Files:
README.md
README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update
README.mdto reflect current workspace members and top-level documentation when workspace structure changes
Files:
README.md
🪛 LanguageTool
docs/about-nemo-relay/release-notes/highlights.mdx
[style] ~37-~37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... for guardrails plugin configuration. - Added guardrail scopes for conditional guardr...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~71-~71: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t-in guardrails plugin documentation. - Added CI path filters, CLI draft release asse...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (14)
docs/resources/support-and-faqs.mdx (1)
85-87: LGTM!docs/about-nemo-relay/release-notes/highlights.mdx (1)
1-76: LGTM!docs/about-nemo-relay/release-notes/index.mdx (1)
1-64: LGTM!fern/docs.yml (1)
1-35: LGTM!README.md (2)
22-235: LGTM!
20-20:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse lowercase "is" for title case compliance.
Question headings should follow title case rules where auxiliary verbs like "is" are lowercase.
📝 Proposed fix
-## What Is NeMo Relay? +## What is NeMo Relay?As per coding guidelines: "Use title case consistently for technical documentation headings."
> Likely an incorrect or invalid review comment.docs/about-nemo-relay/concepts/subscribers.mdx (1)
1-205: LGTM!docs/reference/performance.mdx (1)
1-40: LGTM!docs/supported-integrations/about.mdx (1)
25-25: LGTM!docs/supported-integrations/openclaw-plugin.mdx (3)
16-21: LGTM!
30-30: LGTM!
252-257: LGTM!integrations/openclaw/README.md (2)
15-19: LGTM!
208-211: LGTM!
Signed-off-by: Will Killian <wkillian@nvidia.com>
Signed-off-by: Will Killian <2007799+willkill07@users.noreply.github.com>
Signed-off-by: Will Killian <2007799+willkill07@users.noreply.github.com>
|
Stoked for this one! |
|
/merge |
2 participants
Overview
Update the 0.3 release documentation so the release notes, README, and integration support pages reflect the current 0.3 feature set and compatibility notes.
Details
Where should the reviewer start?
Start with
docs/about-nemo-relay/release-notes/index.mdxanddocs/about-nemo-relay/release-notes/highlights.mdxfor the release note shape, then reviewREADME.mdanddocs/supported-integrations/openclaw-plugin.mdxfor the feature-support reconciliation.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
Documentation
New Features