docs: strengthen example coverage across runtime and integrations#303
docs: strengthen example coverage across runtime and integrations#303mnajafian-nv wants to merge 8 commits into
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:
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 (2)
📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🧰 Additional context used📓 Path-based instructions (12){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:
**⚙️ CodeRabbit configuration file
Files:
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}⚙️ CodeRabbit configuration file
Files:
🔇 Additional comments (2)
WalkthroughThe docs add minimal setup and verification guidance for quick-start, plugin configuration, observability, and supported integrations. Rust, Node.js, and Python quick-start pages were updated with revised run instructions and expected event output. ChangesDocumentation path updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 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)
Comment |
mnajafian-nv
changed the title
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
mnajafian-nv
force-pushed
the
docs/integration-example-coverage
branch
from
1774ac8 to
6695a3c
Compare
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
![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/build-plugins/plugin-configuration-files.mdx`:
- Around line 49-65: The shortest-path verification in
plugin-configuration-files.mdx is nondeterministic because discovery can still
pick up system or user plugins.toml files. Update the setup/check steps to use
the explicit --config flow with the config root and colocated plugins.toml, or
clearly state that all other plugin files must be absent; keep the guidance
consistent with the CLI Basic Usage path and the documented wrapper commands
like nemo-relay codex and nemo-relay run -- codex.
🪄 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: 2e1fee23-75bc-4da4-b132-09b639bff2d1
📒 Files selected for processing (9)
docs/build-plugins/plugin-configuration-files.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/getting-started/quick-start/python.mdxdocs/getting-started/quick-start/rust.mdxdocs/observability-plugin/about.mdxdocs/supported-integrations/deepagents.mdxdocs/supported-integrations/langchain.mdxdocs/supported-integrations/langgraph.mdx
📜 Review details
🧰 Additional context used
📓 Path-based instructions (12)
{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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.mdx
**/*.{html,md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header in HTML and Markdown files using HTML comment syntax
Files:
docs/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.mdx
**
⚙️ CodeRabbit configuration file
**:AGENTS.md
This file provides guidance to agents, including Claude Code and OpenAI Codex, when working in this repository.
Project Overview
NeMo Relay is a multi-language agent runtime framework for execution scopes, lifecycle events, middleware, plugins, and observability around tool and LLM calls. The core runtime is Rust. Primary supported bindings are Rust, Python, and Node.js. Go, WebAssembly, and the raw C FFI are experimental and source-first.
The shared runtime model is:
- Scope stacks decide where work belongs and which scope-local behavior is visible.
- Middleware registries decide what guardrails and intercepts run around managed calls.
- Plugins install reusable runtime behavior from configuration.
- Events record runtime behavior in ATOF form.
- Subscribers and exporters consume events in-process or export them to ATIF, OpenTelemetry, OpenInference, or other backends.
Repository Structure
The repository layout separates the Rust runtime, language bindings, documentation,
integration patches, and agent-facing skills.crates/ core/ # Rust core runtime crate, published as nemo-relay adaptive/ # Adaptive runtime primitives and plugin components python/ # PyO3 native extension for the Python package ffi/ # Raw C ABI layer used by downstream bindings such as Go node/ # NAPI Node.js binding and JavaScript/TypeScript entry points wasm/ # wasm-bindgen WebAssembly binding and JS wrappers python/ nemo_relay/ # Python wrapper package: scopes, tools, LLM, middleware, typed helpers, plugins, adaptive helpers tests/ # Python tests go/ nemo_relay/ # Experimental Go CGo binding and tests fern/ # Fern documentation site scripts/ # Stable wrappers and helper scripts; build/test/docs entry points live in justfile third_party/ # P...
Files:
docs/getting-started/quick-start/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.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/python.mdxdocs/supported-integrations/langgraph.mdxdocs/supported-integrations/langchain.mdxdocs/getting-started/quick-start/index.mdxdocs/getting-started/quick-start/nodejs.mdxdocs/observability-plugin/about.mdxdocs/build-plugins/plugin-configuration-files.mdxdocs/supported-integrations/deepagents.mdxdocs/getting-started/quick-start/rust.mdx
🪛 LanguageTool
docs/supported-integrations/deepagents.mdx
[style] ~90-~90: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ter this minimal path is working if you want to capture Deep Agents skill or subagent m...
(REP_WANT_TO_VB)
🔇 Additional comments (8)
docs/getting-started/quick-start/index.mdx (1)
21-36: LGTM!Also applies to: 133-134
docs/getting-started/quick-start/rust.mdx (1)
9-9: LGTM!Also applies to: 22-23, 40-42, 44-58, 60-125, 139-153
docs/getting-started/quick-start/nodejs.mdx (1)
40-41: LGTM!Also applies to: 90-91
docs/getting-started/quick-start/python.mdx (1)
55-57: LGTM!docs/supported-integrations/deepagents.mdx (1)
63-67: LGTM!Also applies to: 89-99
docs/supported-integrations/langchain.mdx (1)
91-98: LGTM!docs/supported-integrations/langgraph.mdx (1)
104-111: LGTM!docs/observability-plugin/about.mdx (1)
14-23: LGTM!Also applies to: 98-109
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
1 participant
Overview
Strengthens example coverage across the direct-runtime quick starts, plugin-managed observability setup, and maintained integration guides.
Details
plugins.tomlexample plus explicit success criteria for plugin-managed observability setup.Audited coverage kept unchanged in this PR:
Validation:
just docsjust docs-linkcheckPATH=$HOME/.local/nemo-relay-tools/bin:$PATH uv run pre-commit run --all-filesWhere should the reviewer start?
Start with
docs/getting-started/quick-start/index.mdx, then the Python, Node.js, and Rust quick starts, thendocs/build-plugins/plugin-configuration-files.mdx.Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit