docs: fix stale naming and add Quick Start binding cards#188
Conversation
zhongxuanwang-nv
added
Improvement
|
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 (10)
💤 Files with no reviewable changes (1)
📜 Recent 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). (6)
🧰 Additional context used📓 Path-based instructions (24){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:
AGENTS.md📄 CodeRabbit inference engine (CLAUDE.md)
Files:
**/*.{md,rst,html,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.{md,rst,html}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Files:
**/*.md📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Files:
**/{docs,examples,**/*.md,*.patch,*.diff,.github,*.sh,*.yaml,*.yml}📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Files:
**/*.{md,rst,txt}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.{md,rst}📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
Files:
**/*.{rs,py,js,ts,tsx,jsx,go,md,sh,toml,yaml,yml,json,xml,html}📄 CodeRabbit inference engine (AGENTS.md)
Files:
{README.md,docs/getting-started/**/*.md}📄 CodeRabbit inference engine (.agents/skills/add-binding-feature/SKILL.md)
Files:
README.md📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
**/README.md📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
{README.md,docs/**/*.{md,rst,txt},fern/**/*}📄 CodeRabbit inference engine (.agents/skills/prepare-code-freeze/SKILL.md)
Files:
{.github/**,.gitlab-ci.yml,.pre-commit-config.yaml,justfile,scripts/**}⚙️ CodeRabbit configuration file
Files:
🧠 Learnings (1)📓 Common learnings🪛 markdownlint-cli2 (0.22.1).github/CODE_OF_CONDUCT.md[warning] 6-6: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 🔇 Additional comments (9)
WalkthroughThis PR updates NeMo Relay documentation and configuration across ten files to align terminology ("Flow" → "Relay"), expand integration discovery, and add a new quick-start navigation interface. Changes are limited to documentation, configuration, and MDX content with no code logic modifications. ChangesDocumentation Terminology and Quick-Start Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 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 |
github-actions
Bot
added
size:S
zhongxuanwang-nv
force-pushed
the
docs/general-small-fixes
branch
from
6275463 to
9850417
Compare
![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 @.github/CODE_OF_CONDUCT.md:
- Around line 6-7: Add a blank line immediately after the heading line "# NVIDIA
NeMo Relay Code of Conduct" so the heading is followed by an empty line to
satisfy MD022 linting; update the top of the file so the heading is separated
from the following paragraph "This project has adopted the [Contributor Covenant
Code of Conduct](https://docs.rapids.ai/resources/conduct/)." by one blank line.
🪄 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: 82f013bd-0953-4eb4-8549-589996826a19
📒 Files selected for processing (10)
.github/CODE_OF_CONDUCT.mdAGENTS.mdREADME.mddocs/about-nemo-relay/ecosystem.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/integrate-into-frameworks/non-serializable-data.mdxdocs/nemo-relay-cli/hermes.mdxdocs/resources/support-and-faqs.mdxintegrations/coding-agents/README.md
💤 Files with no reviewable changes (1)
- integrations/coding-agents/README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (24)
{.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/CODE_OF_CONDUCT.md
{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdx
{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxAGENTS.mddocs/about-nemo-relay/ecosystem.mdx
{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdx
{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdx
{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxAGENTS.mddocs/about-nemo-relay/ecosystem.mdx
**/*.{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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxAGENTS.mddocs/about-nemo-relay/ecosystem.mdx
**/*.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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxdocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.mdx
**/*.{html,md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header in HTML and Markdown files using HTML comment syntax
Files:
docs/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxAGENTS.mddocs/about-nemo-relay/ecosystem.mdx
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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxdocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxdocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/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/integrate-into-frameworks/non-serializable-data.mdxdocs/resources/support-and-faqs.mdxREADME.mddocs/nemo-relay-cli/hermes.mdxdocs/getting-started/quick-start/index.mdxdocs/integrate-into-frameworks/about.mdxdocs/about-nemo-relay/ecosystem.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:
README.mdAGENTS.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.mdAGENTS.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
**/*.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:
README.mdAGENTS.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:
README.mdAGENTS.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.mdAGENTS.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.mdAGENTS.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
**/README.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Update relevant crate or package README when that surface changed
Files:
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, andferndirectories, updating current-version install commands, package examples, and configuration examples to<next-version>
Files:
README.md
**/*.{rs,py,js,ts,tsx,jsx,go,md,sh,toml,yaml,yml,json,lock,Dockerfile,cmake}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, docs, scripts, and configuration files using Apache-2.0 license
Files:
README.mdAGENTS.md
AGENTS.md
📄 CodeRabbit inference engine (CLAUDE.md)
Document agent implementations in AGENTS.md with clear descriptions of functionality and usage
Files:
AGENTS.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Follow binding naming conventions: Rust and Python use snake_case, C FFI exports prefixed with nemo_relay_, Go uses PascalCase for public APIs, Node.js uses camelCase
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Preserve the shared runtime model across bindings - do not add behavior to one primary binding without considering Rust, Python, and Node.js parity
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Prefer documented public APIs and stable wrapper commands - do not rely on internal helpers in examples or user-facing docs
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Keep primary documentation focused on Rust, Python, and Node.js - treat Go, WebAssembly, and raw FFI as experimental and source-first unless binding-support guidance changes
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Keep async behavior on the existing tokio-based model - bindings should preserve callback and future lifetimes rather than blocking or hiding async work unexpectedly
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Do not hand-edit generated or packaged outputs unless the repository workflow expects them to be checked in - regenerate through documented recipe or script
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Scope stacks are hierarchical and always have a root scope - they establish parent-child event relationships, visibility for scope-local middleware and subscribers, cleanup boundaries, and concurrent request isolation
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Scope-local middleware and subscribers are owned by a scope and disappear when that scope closes - global registrations stay process-wide until removed
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Middleware is priority-ordered after merging global and visible scope-local entries
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Intercepts change the real execution path - request intercepts rewrite the request, execution intercepts wrap or replace the callback, stream execution intercepts handle streaming lifecycle behavior
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Guardrails either block execution or sanitize emitted observability payloads - sanitize guardrails do not rewrite the real callback arguments or return value
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Managed execution order is: conditional guardrails, request intercepts, sanitize-request guardrails for start events, execution intercepts, callback execution, then sanitize-response guardrails for end events
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Events use ATOF 0.1 as the canonical event format - scope events use start/end pairs; mark events record runtime checkpoints
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: LLM and tool event metadata belongs in the category profile, such as model_name, tool_call_id, and custom subtype fields
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Exporters can transform runtime events to ATIF trajectories, OpenTelemetry traces, or OpenInference-compatible output - root scope identity is used to isolate concurrent agents
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Rust is the source of truth for runtime behavior - binding APIs should mirror the Rust semantics unless a language-specific wrapper intentionally improves ergonomics
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Python wrapper modules live under python/nemo_relay/ - the native extension is built from crates/python with maturin
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Node.js public entry points include the main runtime package plus nemo-relay-node/typed, nemo-relay-node/plugin, and nemo-relay-node/adaptive
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Go uses the C FFI and requires the FFI library build before tests - just test-go handles the library path setup
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: WebAssembly includes Rust wasm-bindgen tests plus JS wrapper/package tests - just test-wasm runs both paths
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Use stable root-level wrapper scripts for patch-based integrations: ./scripts/bootstrap-third-party.sh, ./scripts/apply-patches.sh, ./scripts/generate-patches.sh
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: apply-patches.sh expects clean third-party checkouts - after editing an integration checkout, run ./scripts/generate-patches.sh to regenerate patch files and verify they apply to clean detached checkouts
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Update README.md, fern/, package READMEs, and binding-support notes when public behavior, package names, examples, or supported bindings change
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Keep release-process details in maintainer docs such as RELEASING.md - do not move release-history policy into user-facing docs or CHANGELOG.md
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Keep stable public wrappers at scripts/ root in docs and examples - reference namespaced helper paths only when documenting internal maintenance work
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Use branch prefixes from contributor docs: feat/, fix/, docs/, test/, or refactor/
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Use signed-off commits for PR work: git commit -s
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Before creating a PR, read .github/pull_request_template.md and use it as the PR body skeleton - preserve visible headings, checklist items, and related-issue guidance; fill the sections instead of replacing them
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: PR descriptions should include what changed, why, how it was tested, and any breaking changes within the repository template format
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Prefer repository just recipes over raw tool commands for build, test, and docs work - use raw cargo, pytest, go test, npm, or wasm-pack commands only for focused debugging or targeted single-test reruns
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Run tests for every language affected by a change - if touching Rust core runtime, middleware semantics, event shape, scope behavior, typed codecs, plugins, or observability, validate every affected binding
Learnt from: CR
Repo: NVIDIA/NeMo-Relay
Timestamp: 2026-05-29T21:06:25.828Z
Learning: Before review, prefer uv run pre-commit run --all-files when the change crosses languages or tooling - the hooks enforce SPDX headers, file hygiene, Ruff, ty, Markdown link checks, Cargo formatting/lints/audits, Go formatting/vet, and Node formatting
🪛 markdownlint-cli2 (0.22.1)
.github/CODE_OF_CONDUCT.md
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (8)
README.md (1)
30-30: LGTM!docs/about-nemo-relay/ecosystem.mdx (1)
52-53: LGTM!Also applies to: 59-63, 67-67
docs/resources/support-and-faqs.mdx (1)
85-87: LGTM!docs/integrate-into-frameworks/about.mdx (1)
57-58: LGTM!docs/integrate-into-frameworks/non-serializable-data.mdx (1)
30-31: LGTM!docs/nemo-relay-cli/hermes.mdx (1)
135-136: LGTM!docs/getting-started/quick-start/index.mdx (1)
10-42: LGTM!AGENTS.md (1)
230-235: LGTM!
zhongxuanwang-nv
force-pushed
the
docs/general-small-fixes
branch
from
32cf8c6 to
cd21430
Compare
zhongxuanwang-nv
force-pushed
the
docs/general-small-fixes
branch
from
cd21430 to
a7771d4
Compare
github-actions
Bot
added
lang:js
The Quick Start landing page was a single sentence with no in-page navigation. Add a CardGroup linking to the Python, Node.js, and Rust quick starts, matching the Card pattern used by the Concepts landing page so readers can route to a binding guide directly. Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
Several docs pages and the README still referred to the project as "NeMo Flow" after the rename to "NeMo Relay", including the ecosystem mermaid diagram node. Update the remaining references so the naming is consistent. Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
The bullet describing a `hermes/` Python plugin prototype pointed to a directory that does not exist (and was never tracked in git). It also contradicted the preceding bullet, which states Hermes does not require a static bundle and is configured through the setup wizard instead. Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
The Public API-based Integrations section claimed each integration under python/nemo_relay/integrations/ ships its own README files and co-located test suites. No such READMEs exist (none ever have), and the tests live under python/tests/integrations/. The inventory also listed only LangChain while langgraph/ and deepagents/ are shipped and documented. Point readers to the real docs (docs/supported-integrations/) and test location, and list all three integrations. Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
zhongxuanwang-nv
force-pushed
the
docs/general-small-fixes
branch
from
a7771d4 to
90ff2a2
Compare
github-actions
Bot
added
size:S
|
/merge |
2 participants
Overview
Documentation cleanup that removes stale "NeMo Flow" / "NAT" / "NeMo Agent
Toolkit" naming in favor of the current project name (NeMo Relay), refreshes the
Quick Start landing page with per-binding navigation, and corrects a few stale
integration notes. Docs-only; no runtime or public API behavior changes.
Details
docs/getting-started/quick-start/index.mdx): add a 3-columnCardGrouplinking to the Python, Node.js, and Rust Quick Start guides..github/CODE_OF_CONDUCT.md: title is now "NVIDIA NeMo Relay Code of Conduct".README.md,docs/integrate-into-frameworks/about.mdx,docs/integrate-into-frameworks/non-serializable-data.mdx,docs/nemo-relay-cli/hermes.mdx,docs/resources/support-and-faqs.mdx:replace leftover "NeMo Flow" references with "NeMo Relay".
docs/about-nemo-relay/ecosystem.mdx: rename theFlownode toRelayinthe architecture mermaid diagram.
AGENTS.md: refresh the public-API integration notes to list LangGraph andDeep Agents alongside LangChain, and point to
docs/supported-integrations/and
python/tests/integrations/.integrations/coding-agents/README.md: remove the stalehermes/nativeplugin bundle bullet.
Where should the reviewer start?
Start with the naming corrections, especially
.github/CODE_OF_CONDUCT.md(itwas mistakenly set to "NeMo Flow") and the mermaid node rename in
docs/about-nemo-relay/ecosystem.mdx. Then review the newCardGroupindocs/getting-started/quick-start/index.mdx. Validated withjust docs-linkcheck(0 errors; the only warning is the auth-gated redirects check being skipped).
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
New Features
Documentation