docs: simplify overview entry paths

[afourniernv]

Overview

Simplify the Overview so new users see the common Relay entry paths before framework, plugin, or contributor workflows.

• I confirm this contribution is my own work, or I have the right to submit it under this project's license.
• I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

• Limit the first-path chooser to coding-agent observation, application instrumentation, supported integrations, and observability configuration.
• Move framework integration, plugin authoring, and repository development into a separate advanced section.
• Replace the raw-capture procedure with brief ATOF and ATIF definitions; the existing Observability guide retains the first-export procedure.
• Replace the internal registry diagram with the external application-to-runtime-to-export flow and link every shown output to its setup guide.
• Validate with just docs-linkcheck, just docs, and uv run pre-commit run --all-files.

Where should the reviewer start?

Start with docs/about-nemo-relay/overview.mdx, especially "Choose Your First Path" and "How Relay Connects to Your Stack."

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

• Closes RELAY-616

Summary by CodeRabbit

• Documentation
  • Reframed the Relay overview around a shared runtime contract connecting applications, frameworks, observability tools, and guardrails.
  • Added separate integration guidance for applications and extensions, including connection boundaries and runtime-binding consistency.
  • Expanded guidance for exporting data through ATOF, ATIF, OpenTelemetry, and OpenInference.
  • Replaced the conceptual diagram with an updated flow showing applications, Relay, subscribers, exporters, and supported destinations.
  • Added the runtime model to the documentation table and removed the former Developer Background section.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: a6761db6-8949-49fe-ad5c-4d4321f86ceb

📥 Commits

Reviewing files that changed from the base of the PR and between da2d751 and 6d76ffb.

📒 Files selected for processing (1)

• docs/about-nemo-relay/overview.mdx

📜 Recent review details

🧰 Additional context used

📓 Path-based instructions (10)

**/*.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)

**/*.mdx: In MDX files, top-of-file comments must use JSX comment delimiters ({/* and */}); do not use HTML comments for MDX SPDX headers.
New or regenerated MDX files must use {/* ... */} for top-of-file SPDX comments.

Files:

• docs/about-nemo-relay/overview.mdx

{docs,examples}/**/*

📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)

Update docs and examples.

Files:

• docs/about-nemo-relay/overview.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, use maintain-dynamic-plugins and 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, prefer uv run pre-commit run --files <changed files...>.
Before review or handoff, run uv run pre-commit run --all-files.

**/*: Use release tags in raw Rust-compatible SemVer without a leading v; tags such as v0.1.0 are prohibited.
Use branch prefixes feat/, fix/, docs/, test/, or refactor/ according to the change purpose.
Every commit in a pull request must include a DCO Signed-off-by: sign-off.
Before submitting a pull request, ensure pre-commit hooks, relevant tests, target-specific builds, documentation updates, and a rebase on the latest main are complete.
Use commit messages in the form type: short description, with a valid type and a first line under 72 characters.

Files:

• docs/about-nemo-relay/overview.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/about-nemo-relay/overview.mdx

**/*.{md,mdx}

📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)

If links in documentation change, run just docs-linkcheck.

Use documented public APIs and stable wrapper commands in examples and user-facing documentation; do not rely on internal helpers.

**/*.{md,mdx}: Prefer the documented public API over internal shortcuts in documentation and examples.
Keep package names, repository references, and build commands current.
Contribution workflow documentation must require an issue before external contribution pull requests and note that NVIDIA contributors may use a GitHub or Linear issue.
Update entry-point documentation when examples or reading paths change.
Keep release-process and release-notes guidance in maintainer documentation such as RELEASING.md, rather than user-facing documentation pages or CHANGELOG.md.
Use stable user-facing wrappers at the scripts/ root in documentation and examples; reference namespaced helper paths only for internal maintenance documentation.
When detailed dynamic plugin guides exist, keep Rust native plugin examples, Python worker plugin examples, and grpc-v1 protocol details on separate pages.
Dynamic plugin manifests in documentation and examples should use compat.relay = ">=0.5,<1.0" unless deliberately narrower.
Render images, diagrams, tables, and other visual content at representative page widths, ensuring legibility and complete access without clipping; use responsive scaling, reflow, or overflow as appropriate and scope visual styling narrowly.
Dynamic plugin entry pages should link to native, worker, Rust example, Python example, and protocol pages when those pages exist.
Images, diagrams, tables, and custom visual content must remain legible and fully accessible at representative desktop and narrow page widths.
Release-policy documentation must point to GitHub Releases as the only release-history source of truth.
Run just docs when the documentation site changes; retain ./scripts/build-docs.sh html as the compatibility wrapper.

Files:

• docs/about-nemo-relay/overview.mdx

**/*.{md,mdx,py,go,js,ts}

📄 CodeRabbit inference engine (.agents/skills/maintain-observability/SKILL.md)

Examples and documentation must use each exporter's documented flush/deregister order before shutdown.

Files:

• docs/about-nemo-relay/overview.mdx

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Update relevant reference documentation when public behavior or APIs change.

Files:

• docs/about-nemo-relay/overview.mdx

**/*.{rs,py,go,js,jsx,ts,tsx,c,h,html,md,mdx,toml}

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Include the appropriate SPDX copyright and Apache-2.0 license header in every source file.

Files:

• docs/about-nemo-relay/overview.mdx

**/*.{md,mdx,rst}

📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)

**/*.{md,mdx,rst}: Use title case consistently for technical documentation headings and table headers; avoid quotation marks, ampersands, and exclamation marks in headings, while preserving official product, event, research, and whitepaper title case.
Format code elements, commands, parameters, package names, expressions, directories, file names, and paths in monospace; represent path placeholders with angle brackets inside monospace.
Format UI buttons, menus, fields, and labels in bold, and separate consecutive UI navigation labels with >.
Use quotation marks for error messages and strings when appropriate, italics for newly introduced terms and publication titles, and plain text for keyboard shortcuts.
Represent GitHub repositories with owner/repository link text, such as [NVIDIA/NeMo](link), rather than generic repository wording.
Introduce every code block with a complete sentence; do not let a code block complete or interrupt the grammar of surrounding prose; use syntax highlighting when supported.
Keep inline method, function, and class references consistent with nearby documentation; omit empty parentheses in prose when no call is shown.
Use descriptive link text matching the destination title when possible; avoid raw URLs, generic anchors, long-sentence links, and unnecessary links that distract from procedures.
Ensure lists have a complete lead-in sentence, more than one item, no more than two levels, parallel construction, one idea or action per item, and appropriate punctuation; use bullets for unordered items and numbers for ordered tasks.
Format definition lists with a bold term followed by a complete, parallel, punctuated definition.
Use tables for reference information, decision support, compatibility matrices, and comparable choices; flag one-row tables, missing captions or lead-ins, sentence-case headers where title case is expected, unexplained empty cells, and code or links that would be clearer as prose.
Write procedure steps as imperative ...

Files:

• docs/about-nemo-relay/overview.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/about-nemo-relay/overview.mdx

🔇 Additional comments (2)

docs/about-nemo-relay/overview.mdx (2)

16-20: LGTM!

Also applies to: 30-36, 64-67, 77-77, 79-79, 91-94, 96-96, 100-105, 123-123

---

49-50: 📐 Maintainability & Code Quality

Run the required documentation checks before handoff.

just and uv are unavailable, so the checks remain pending.

---

Walkthrough

The Relay overview now defines a shared runtime contract, expands application and extension guidance, documents export formats and runtime bindings, and replaces the conceptual diagram with an event-output flow.

Changes

Relay overview documentation

Layer / File(s)	Summary
Integration and export guidance docs/about-nemo-relay/overview.mdx	The overview defines shared request components and explains application instrumentation, framework integrations, observability exports, and ATOF lifecycle event formats.
Extension and runtime model guidance docs/about-nemo-relay/overview.mdx	The overview adds framework, plugin, and repository development paths. It documents managed execution, hook translation, gateway routing, runtime-binding status, and language parity.
Runtime output flow docs/about-nemo-relay/overview.mdx	The diagram now shows application code, agent harnesses, and frameworks feeding Relay, which sends outputs to subscribers, exporters, ATOF, ATIF, OpenTelemetry, and OpenInference destinations.

Estimated code review effort: 2 (Simple) | ~15 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title uses valid Conventional Commits syntax, uses the allowed docs type, states the main change, and is under 72 characters.
Description check	✅ Passed	The description includes all required sections, completed confirmations, change details, reviewer guidance, and a valid related issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[afourniernv]

/ok to test

[copy-pr-bot]

/ok to test

@afourniernv, there was an error processing your request: E1

See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/