docs: add compatibility guides and consolidate release notes - #538
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughThe documentation updates add NeMo Relay 0.5 → 0.6 migration guidance, establish a canonical support matrix, revise release and integration references, and restructure the glossary into a templated alphabetical definition-list page. ChangesRelease and migration documentation
Support matrix alignment
Glossary template and structure
Estimated code review effort: 3 (Moderate) | ~25 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/resources/glossary.mdx`:
- Around line 317-338: Alphabetize the glossary entries within each affected
letter section: in docs/resources/glossary.mdx lines 317-338, order N entries as
Native Dynamic Plugin, NeMo Guardrails, Next Function, then Non-Serializable
Data; at lines 166-174, place Experimental Binding before Explicit Lifecycle
API; and at lines 395-404, place Primary Binding before Priority. Preserve each
definition’s content while changing only entry order.
🪄 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: 41df3c6a-41a9-4e2e-8f41-93943632b61b
📒 Files selected for processing (5)
docs/about-nemo-relay/release-notes/known-issues.mdxdocs/reference/migration-guides.mdxdocs/reference/support-matrix.mdxdocs/resources/glossary.mdxdocs/supported-integrations/about.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 (9)
**/*.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.mdx
{docs,examples}/**/*
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update docs and examples.
Files:
docs/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.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/reference/support-matrix.mdxdocs/supported-integrations/about.mdxdocs/reference/migration-guides.mdxdocs/about-nemo-relay/release-notes/known-issues.mdxdocs/resources/glossary.mdx
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx
📄 CodeRabbit inference engine (.agents/skills/draft-release-notes/SKILL.md)
docs/about-nemo-relay/release-notes/{index,highlights,known-issues}.mdx: Update 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/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
🪛 LanguageTool
docs/reference/migration-guides.mdx
[style] ~77-~77: Consider using “who” when you are referring to people instead of objects.
Context: ...isible mark nodes. Review any consumers that assume step.model_name always identif...
(THAT_WHO)
docs/resources/glossary.mdx
[style] ~24-~24: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ists only when they add lookup value. - Use related links when readers should conti...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (7)
docs/reference/migration-guides.mdx (2)
9-12: 📐 Maintainability & Code QualityRun the required documentation checks before handoff.
This page adds internal and external links plus executable command examples. Run the documentation link checker and final repository validation before merging.
As per coding guidelines:
**/*.{md,mdx}requiresjust docs-linkcheckwhen documentation links change, and changed files must be formatted and validated withuv run pre-commit run --all-files.Source: Coding guidelines
1-7: LGTM!Also applies to: 14-34, 36-52, 54-61, 63-78, 80-94, 96-102, 104-110
docs/reference/support-matrix.mdx (2)
1-7: LGTM!Also applies to: 9-49, 63-87
51-61: 🎯 Functional CorrectnessThe CLI support wording is already consistent. README.md marks only Go and raw C FFI as experimental; the NeMo Relay CLI is listed as supported, matching the support matrix and known-issues page.
> Likely an incorrect or invalid review comment.docs/supported-integrations/about.mdx (1)
22-25: LGTM!docs/resources/glossary.mdx (2)
547-552: 📐 Maintainability & Code QualityAdded links point to existing docs pages.
12-39: 📐 Maintainability & Code QualityKeep the
@tpl:blocks — they’re source-only template metadata and don’t affect the rendered page.> Likely an incorrect or invalid review comment.
Signed-off-by: Will Killian <wkillian@nvidia.com>
exactlyallan
left a comment
exactlyallan
left a comment
There was a problem hiding this comment.
Additional areas to review:
- getting-started/installation#supported-platforms -> review and link to full support matrix
- nemo-relay-cli/about#agent-harness-support -> review and link to full support matrix
For future reference: there are lots of locations where support tables are listed. This might result in some being missed in future updates.
Signed-off-by: Will Killian <wkillian@nvidia.com>
willkill07
changed the title
github-actions
Bot
added
size:XL
|
/merge |
3 participants
Overview
Add canonical compatibility and migration guidance, and consolidate the NVIDIA NeMo Relay 0.6 release notes.
Details
just docs-linkcheck, andjust docs.Where should the reviewer start?
Start with
docs/reference/support-matrix.mdx,docs/reference/migration-guides.mdx, anddocs/about-nemo-relay/release-notes/index.mdx. Then review the Support Matrix links in the installation and CLI overview pages.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit