Skip to content

Commit 973ef43

Browse files
authored
docs: update documentation URL (NVIDIA#174)
#### Overview Update NeMo Relay documentation links and docs metadata to point to the NVIDIA-hosted documentation site. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Replaced GitHub Pages documentation references with `https://docs.nvidia.com/nemo/relay` in the top-level README, package READMEs, and OpenClaw integration README. - Updated docs navigation text to use the NVIDIA NeMo Relay product name. - Added the Fern docs beta announcement metadata. Validation: not run; docs-only URL, navigation, and metadata updates. #### Where should the reviewer start? Start with `README.md` for the canonical documentation URL change, then `fern/docs.yml` for the docs-site metadata update. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **Documentation** * Migrated all documentation references to the official NVIDIA documentation site for improved accessibility and centralized maintenance. * Enhanced documentation navigation structure and section titles for better organization. * Added beta software status announcement to the documentation portal. [![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/NVIDIA/NeMo-Relay/pull/174?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) Authors: - Will Killian (https://github.com/willkill07) Approvers: - https://github.com/mnajafian-nv URL: NVIDIA#174
1 parent a3c552b commit 973ef43

13 files changed

Lines changed: 17 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ For source builds, testing, and contribution workflow, see [CONTRIBUTING.md](CON
118118

119119
## Documentation
120120

121-
End-user documentation lives at [nvidia.github.io/NeMo-Relay](https://nvidia.github.io/NeMo-Relay/).
121+
End-user documentation lives at [docs.nvidia.com/nemo/relay](https://docs.nvidia.com/nemo/relay).
122122

123123
The primary documentation track covers Rust, Python, and Node.js.
124124

crates/adaptive/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,4 +103,4 @@ of the adaptive pipeline.
103103

104104
## Documentation
105105

106-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
106+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,4 +132,4 @@ output_directory = "./atif"
132132

133133
## Documentation
134134

135-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay/
135+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
113113

114114
## Documentation
115115

116-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
116+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/ffi/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,4 +79,4 @@ applications should prefer the supported packages for those languages.
7979

8080
## Documentation
8181

82-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
82+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ are available at `nemo-relay-node/typed`, `nemo-relay-node/plugin`,
9595

9696
## Documentation
9797

98-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
98+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ with nemo_relay.scope.scope("demo-agent", nemo_relay.ScopeType.Agent) as handle:
7878

7979
## Documentation
8080

81-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
81+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

crates/wasm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,4 @@ are available at `nemo-relay-wasm/typed`, `nemo-relay-wasm/plugin`,
112112

113113
## Documentation
114114

115-
NeMo Relay Documentation: https://nvidia.github.io/NeMo-Relay
115+
NeMo Relay Documentation: https://docs.nvidia.com/nemo/relay

docs/about-nemo-relay/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { MermaidStyles } from "@/components/MermaidStyles";
99
SPDX-License-Identifier: Apache-2.0 */}
1010

1111

12-
NeMo Relay is a portable execution runtime for agent systems that already have a
12+
NVIDIA NeMo Relay is a portable execution runtime for agent systems that already have a
1313
framework, model provider, policy layer, or observability backend. It gives those
1414
systems one consistent way to describe what is happening when an agent crosses a
1515
request, tool, or LLM boundary.

docs/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
navigation:
55
- folder: ./about-nemo-relay
6-
title: "About NeMo Relay"
6+
title: "About NVIDIA NeMo Relay"
77
slug: about-nemo-relay
88
title-source: frontmatter
99
- folder: ./getting-started
1010
title: "Getting Started"
1111
slug: getting-started
1212
title-source: frontmatter
1313
- folder: ./nemo-relay-cli
14-
title: "NeMo Relay CLI"
14+
title: "NVIDIA NeMo Relay CLI"
1515
slug: nemo-relay-cli
1616
title-source: frontmatter
1717
- folder: ./supported-integrations

0 commit comments

Comments
 (0)