Skip to content

Commit eb4f71b

Browse files
authored
docs: fix broken documentation links (#156)
#### Overview Align the docs source tree with the published Fern slugs and update internal links that were producing broken documentation routes. - [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 - Rename docs directories so their filesystem paths match the published slug paths, including About NeMo Relay, Supported Integrations, Observability Plugin, Adaptive Plugin, and Integrate into Frameworks. - Update internal docs links and contributor references to use the canonical slug paths. - Update the Rust library reference generator so generated module directory paths are slugified consistently. Validation: - Local internal Markdown route check: `missing=0` - `just docs` passes with zero errors. Fern still warns about old generated Rust API underscore URLs because this change intentionally does not add redirects. - Commit hooks passed, including docs markdown linkcheck. #### Where should the reviewer start? Start with `docs/index.yml` for the navigation/source-path alignment, then review `scripts/docs/generate_rust_library_reference.py` for the generated Rust reference path change. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Relates to: none ## Summary by CodeRabbit * **Documentation** * Reorganized docs and navigation to new consolidated sections (about, supported-integrations, integrate-into-frameworks, observability-plugin, adaptive-plugin) * Updated many internal links and cross-references (integrations, plugins, observability, adaptive) for consistent routing * Clarified Next Steps navigation and improved discoverability across integration and troubleshooting guides [![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/156?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) Signed-off-by: Will Killian <wkillian@nvidia.com>
1 parent 2cc76fb commit eb4f71b

56 files changed

Lines changed: 162 additions & 161 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ The pre-commit hooks do not currently enforce SPDX headers automatically, but re
325325
Before making significant changes, read through the documentation in
326326
[`docs/`](docs/), especially:
327327

328-
- [Architecture Overview](docs/about/architecture.mdx) -- runtime model and data flow
329-
- [Scopes](docs/about/concepts/scopes.mdx) -- scopes, handles, events, and runtime ownership
330-
- [Middleware](docs/about/concepts/middleware.mdx) -- execution ordering and middleware behavior
328+
- [Architecture Overview](docs/about-nemo-relay/architecture.mdx) -- runtime model and data flow
329+
- [Scopes](docs/about-nemo-relay/concepts/scopes.mdx) -- scopes, handles, events, and runtime ownership
330+
- [Middleware](docs/about-nemo-relay/concepts/middleware.mdx) -- execution ordering and middleware behavior
331331
- [API Reference](docs/reference/api/index.mdx) -- public surfaces across Rust, Python, and Node.js
332332

333333
The codebase follows a layered architecture: **Core (Rust)** provides the runtime, with bindings through **FFI (C, used by Go through CGo)**, **PyO3 (Python)**, **NAPI (Node.js)**, and **wasm-bindgen (WebAssembly)**. Each binding mirrors the full API surface.
File renamed without changes.
File renamed without changes.

docs/about/concepts/framework-integrations.mdx renamed to docs/about-nemo-relay/concepts/framework-integrations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,4 @@ Use these practices when applying the concept in application or integration code
151151
- Use mark events to fill visibility gaps rather than to model full execution
152152
spans.
153153
- Keep binding-level API details in the [API Reference](/reference/api) and
154-
deeper integration patterns in [Integrate into Frameworks](/integrate-frameworks/about).
154+
deeper integration patterns in [Integrate into Frameworks](/integrate-into-frameworks/about).
File renamed without changes.
File renamed without changes.

docs/about/concepts/plugins.mdx renamed to docs/about-nemo-relay/concepts/plugins.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,9 @@ through the same component lifecycle as other plugins:
150150
- Inspect the activation result if needed
151151

152152
Detailed adaptive configuration belongs in
153-
[Adaptive Configuration](/plugins/adaptive/configuration),
154-
[Adaptive Cache Governor (ACG)](/plugins/adaptive/acg), and
155-
[Adaptive Hints](/plugins/adaptive/adaptive-hints).
153+
[Adaptive Configuration](/adaptive-plugin/configuration),
154+
[Adaptive Cache Governor (ACG)](/adaptive-plugin/acg), and
155+
[Adaptive Hints](/adaptive-plugin/adaptive-hints).
156156

157157
### Observability
158158

@@ -163,7 +163,7 @@ disabled unless its section sets `enabled: true`, and subscriber names are
163163
inferred from the plugin namespace instead of exposed in public config.
164164

165165
Detailed observability plugin configuration belongs in
166-
[Observability Configuration](/plugins/observability/configuration).
166+
[Observability Configuration](/observability-plugin/configuration).
167167

168168
For the CLI gateway's `plugins.toml` discovery, precedence, merge, and editing
169169
rules, see [Plugin Configuration Files](/build-plugins/plugin-configuration-files).
File renamed without changes.

docs/about/concepts/subscribers.mdx renamed to docs/about-nemo-relay/concepts/subscribers.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,13 @@ of the canonical event stream.
134134

135135
### Agent Trajectory Interchange Format (ATIF) Exporter
136136

137-
The [Agent Trajectory Interchange Format (ATIF) exporter](/plugins/observability/atif)
137+
The [Agent Trajectory Interchange Format (ATIF) exporter](/observability-plugin/atif)
138138
collects lifecycle events and emits trajectory artifacts for offline analysis,
139139
replay, or debugging.
140140

141141
### Agent Trajectory Observability Format (ATOF) JSONL Exporter
142142

143-
The [Agent Trajectory Observability Format (ATOF) JSONL exporter](/plugins/observability/atof)
143+
The [Agent Trajectory Observability Format (ATOF) JSONL exporter](/observability-plugin/atof)
144144
writes the canonical event stream to a native filesystem path as one raw ATOF
145145
event per line.
146146

@@ -155,9 +155,9 @@ The OpenInference subscriber maps runtime events into OTLP traces using
155155
OpenInference semantics for model-centric observability.
156156

157157
Detailed setup, configuration, and API shape for these subscribers belongs in
158-
[Observability](/plugins/observability/about).
158+
[Observability](/observability-plugin/about).
159159
For configuration-driven setup, use the built-in
160-
[`observability` plugin](/plugins/observability/configuration)
160+
[`observability` plugin](/observability-plugin/configuration)
161161
to install ATOF, ATIF, OpenTelemetry, and OpenInference subscribers from one
162162
plugin component.
163163

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ Use these links to continue into adjacent concepts and workflows.
111111
- [NVIDIA NeMo documentation](https://docs.nvidia.com/nemo/index.html)
112112
- [NVIDIA NeMo Agent Toolkit documentation](https://docs.nvidia.com/nemo/agent-toolkit/latest/)
113113
- [NVIDIA NeMo Guardrails documentation](https://docs.nvidia.com/nemo-guardrails/index.html)
114-
- [Integrate into Frameworks](/integrate-frameworks/about)
115-
- [Adding Framework Scopes](/integrate-frameworks/adding-scopes)
116-
- [Wrapping Tool Calls](/integrate-frameworks/wrap-tool-calls)
117-
- [Wrapping LLM Calls](/integrate-frameworks/wrap-llm-calls)
114+
- [Integrate into Frameworks](/integrate-into-frameworks/about)
115+
- [Adding Framework Scopes](/integrate-into-frameworks/adding-scopes)
116+
- [Wrapping Tool Calls](/integrate-into-frameworks/wrap-tool-calls)
117+
- [Wrapping LLM Calls](/integrate-into-frameworks/wrap-llm-calls)
118118
- [Plugin Model](/build-plugins/basic-guide)

0 commit comments

Comments
 (0)