docs: clarify README quick start paths#289
Conversation
Signed-off-by: Allan Enemark <[email protected]>
Walkthrough
ChangesREADME Quick-Start Restructure
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
github-actions
Bot
added
size:M
![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 `@README.md`:
- Around line 152-202: Remove blank lines within the `[!TIP]` blockquote blocks
to fix MD028 (no-blanks-blockquote) violations. Within each blockquote that
starts with `> [!TIP]`, ensure all lines are continuous without empty lines
preceded by the `>` marker. Consolidate the text content so that each blockquote
reads as a continuous block of quoted text without internal line breaks.
🪄 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: 3b5c4616-c5c6-4beb-90a3-856c273009ef
📒 Files selected for processing (1)
README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (20)
**/*.{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.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.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.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.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.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.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:
README.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:
README.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:
README.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:
README.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:
README.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:
README.md
**/*.{html,md,mdx}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license header in HTML and Markdown files using HTML comment syntax
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
**/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,sh,toml,yaml,yml,md}
📄 CodeRabbit inference engine (AGENTS.md)
Keep SPDX headers on source, docs, scripts, and configuration files. The project is Apache-2.0.
Files:
README.md
**
⚙️ 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:
README.md
{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:
README.md
🪛 LanguageTool
README.md
[uncategorized] ~80-~80: Ger doublet «to to».
Context: ...Optionally set: - output_directory to .nemo-relay/atof - filename to events.jsonl - mode to `overwrit...
(GER_DOUBLET)
[uncategorized] ~86-~86: Ger doublet «to to».
Context: ...Optionally set: - output_directory to .nemo-relay/atif - filename_template to trajectory-{session_id}.json 4. Press...
(GER_DOUBLET)
🪛 markdownlint-cli2 (0.22.1)
README.md
[warning] 162-162: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 167-167: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🔇 Additional comments (4)
README.md (4)
20-36: LGTM!
64-106: LGTM!
107-122: LGTM!
226-228: LGTM!
| A successful run creates several outputs to inspect: | ||
|
|
||
| - `.nemo-relay/atof/events.jsonl`, the raw canonical event stream. | ||
| - `.nemo-relay/atof/events.jsonl` as the raw canonical event stream. | ||
| - One or more `.nemo-relay/atif/*.json` trajectory files for analysis and | ||
| evaluation workflows. | ||
|
|
||
| > [!TIP] | ||
| > If raw ATOF events exist but LLM spans are missing, provider traffic probably | ||
| > isn't flowing through the Relay gateway. If ATIF is missing, make sure the | ||
| > agent session or turn ended and the output directory is writable. Use | ||
| > [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) when you are ready for | ||
| > agent session or turn ended and the output directory is writable. | ||
|
|
||
| > [!TIP] | ||
| > Use [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) when ready for | ||
| > persistent host plugin installation, gateway configuration, exporter options, | ||
| > and agent-specific diagnostics. | ||
|
|
||
| ## Choose Your Next Path | ||
| > [!TIP] | ||
| > Start by trusting the raw Agent Trajectory Observability Format (ATOF) JSONL. | ||
| > It shows the lifecycle events Relay actually captured before anything is | ||
| > translated into Agent Trajectory Interchange Format (ATIF), OpenTelemetry, or | ||
| > OpenInference output. | ||
|
|
||
| Pick the row closest to what you are trying to do next. Refer to the corresponding documentation for more information. | ||
|
|
||
| | Goal | Start With | | ||
| |---|---| | ||
| | Observe Codex, Claude Code, Cursor, or Hermes locally | [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) | | ||
| | Instrument app-owned LLM or tool calls | [Quick Start](https://docs.nvidia.com/nemo/relay/getting-started/quick-start) | | ||
| | Use LangChain, LangGraph, Deep Agents, or OpenClaw | [Supported Integrations](https://docs.nvidia.com/nemo/relay/supported-integrations/about) | | ||
| | Build a framework or provider integration | [Integrate into Frameworks](https://docs.nvidia.com/nemo/relay/integrate-into-frameworks/about) | | ||
| | Export ATOF, ATIF, OpenTelemetry, or OpenInference | [Observability Plugin](https://docs.nvidia.com/nemo/relay/observability-plugin/about) | | ||
| | Package reusable middleware or exporters | [Build Plugins](https://docs.nvidia.com/nemo/relay/build-plugins/about) | | ||
| | Develop or test this repository from source | [CONTRIBUTING.md](CONTRIBUTING.md) | | ||
| ## Quick Start Applications | ||
|
|
||
| ## Application Quick Starts | ||
|
|
||
| If you own the code that calls the model or tool, install the binding for your | ||
| If writing the code that calls the model or tool, install the binding for the appropriate | ||
| language and route that boundary through Relay directly. | ||
|
|
||
| ### Application Trajectory | ||
|
|
||
| Install Relay for the application language: | ||
|
|
||
| ```bash | ||
| # Python | ||
| uv add nemo-relay | ||
|
|
||
| # Node.js | ||
| # Requires Node.js 24 or newer. | ||
| npm install nemo-relay-node | ||
|
|
||
| # Rust | ||
| cargo add nemo-relay | ||
| ``` | ||
|
|
||
| Then run the smallest workflow for that binding: | ||
| Then run a minimal example workflow for that binding: | ||
|
|
||
| - [Python Quick Start](https://docs.nvidia.com/nemo/relay/getting-started/quick-start/python) | ||
| - [Node.js Quick Start](https://docs.nvidia.com/nemo/relay/getting-started/quick-start/nodejs) | ||
| - [Rust Quick Start](https://docs.nvidia.com/nemo/relay/getting-started/quick-start/rust) | ||
|
|
||
| The Node.js package requires Node.js 24 or newer. | ||
|
|
There was a problem hiding this comment.
Fix Markdown linting violations in blockquotes.
Lines 162 and 167 contain blank lines inside blockquotes, which violates MD028 (no-blanks-blockquote). Remove the blank lines within the [!TIP] blocks to comply with Markdown formatting standards.
🔧 Proposed fix
> [!TIP]
> If raw ATOF events exist but LLM spans are missing, provider traffic probably
> isn't flowing through the Relay gateway. If ATIF is missing, make sure the
> agent session or turn ended and the output directory is writable.
-
> [!TIP]
> Use [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) when ready for
> persistent host plugin installation, gateway configuration, exporter options,
> and agent-specific diagnostics.
-
> [!TIP]
> Start by trusting the raw Agent Trajectory Observability Format (ATOF) JSONL.
> It shows the lifecycle events Relay actually captured before anything is
> translated into Agent Trajectory Interchange Format (ATIF), OpenTelemetry, or
> OpenInference output.The rest of the post-run output restructuring and new Applications section are well-organized and accurately reference the per-language binding packages and docs.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 162-162: Blank line inside blockquote
(MD028, no-blanks-blockquote)
[warning] 167-167: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🤖 Prompt for 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.
In `@README.md` around lines 152 - 202, Remove blank lines within the `[!TIP]`
blockquote blocks to fix MD028 (no-blanks-blockquote) violations. Within each
blockquote that starts with `> [!TIP]`, ensure all lines are continuous without
empty lines preceded by the `>` marker. Consolidate the text content so that
each blockquote reads as a continuous block of quoted text without internal line
breaks.
Source: Linters/SAST tools
|
/ok to test cfb8c77 |
willkill07
left a comment
willkill07
left a comment
There was a problem hiding this comment.
Overall this reads much better and provides a clearer structure to follow in the README! Just some small nits.
| > translated into Agent Trajectory Interchange Format (ATIF), OpenTelemetry, or | ||
| > OpenInference output. | ||
|
|
||
| ### 1. Install the CLI |
There was a problem hiding this comment.
I think these should all be indented to h4 (####) so they live structurally under Local Agent Trajectory
| > [!NOTE] | ||
| > Use `nemo-relay plugins edit` without `--project` only when you want these | ||
| > exporter settings in your user-level Relay config instead of this one project. | ||
| > Use `nemo-relay plugins edit` WITHOUT `--project` if needing to use these |
There was a problem hiding this comment.
prefer italics or bold to uppercase.
| > Use `nemo-relay plugins edit` WITHOUT `--project` if needing to use these | |
| > Use `nemo-relay plugins edit` _without_ `--project` if needing to use these |
| > [!TIP] | ||
| > If raw ATOF events exist but LLM spans are missing, provider traffic probably | ||
| > isn't flowing through the Relay gateway. If ATIF is missing, make sure the | ||
| > agent session or turn ended and the output directory is writable. Use | ||
| > [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) when you are ready for | ||
| > agent session or turn ended and the output directory is writable. | ||
|
|
||
| > [!TIP] | ||
| > Use [NeMo Relay CLI](https://docs.nvidia.com/nemo/relay/nemo-relay-cli/about) when ready for | ||
| > persistent host plugin installation, gateway configuration, exporter options, | ||
| > and agent-specific diagnostics. | ||
|
|
||
| ## Choose Your Next Path | ||
| > [!TIP] | ||
| > Start by trusting the raw Agent Trajectory Observability Format (ATOF) JSONL. | ||
| > It shows the lifecycle events Relay actually captured before anything is | ||
| > translated into Agent Trajectory Interchange Format (ATIF), OpenTelemetry, or | ||
| > OpenInference output. |
There was a problem hiding this comment.
Three tips in a row is a lot. Should any of these be moved or promoted to somewhere else?
2 participants
Summary
Testing
uv run pre-commit run --files README.mdjust docs-linkcheckjust docsSummary by CodeRabbit