Commit eb4f71b
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
[](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
File tree
- docs
- about-nemo-relay
- concepts
- release-notes
- adaptive-plugin
- build-plugins
- getting-started
- quick-start
- instrument-applications
- integrate-into-frameworks
- nemo-relay-cli
- observability-plugin
- reference
- resources
- troubleshooting
- supported-integrations
- scripts/docs
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
325 | 325 | | |
326 | 326 | | |
327 | 327 | | |
328 | | - | |
329 | | - | |
330 | | - | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
331 | 331 | | |
332 | 332 | | |
333 | 333 | | |
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
154 | | - | |
| 154 | + | |
File renamed without changes.
File renamed without changes.
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
150 | 150 | | |
151 | 151 | | |
152 | 152 | | |
153 | | - | |
154 | | - | |
155 | | - | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
156 | 156 | | |
157 | 157 | | |
158 | 158 | | |
| |||
163 | 163 | | |
164 | 164 | | |
165 | 165 | | |
166 | | - | |
| 166 | + | |
167 | 167 | | |
168 | 168 | | |
169 | 169 | | |
| |||
File renamed without changes.
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
134 | 134 | | |
135 | 135 | | |
136 | 136 | | |
137 | | - | |
| 137 | + | |
138 | 138 | | |
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
142 | 142 | | |
143 | | - | |
| 143 | + | |
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
| |||
155 | 155 | | |
156 | 156 | | |
157 | 157 | | |
158 | | - | |
| 158 | + | |
159 | 159 | | |
160 | | - | |
| 160 | + | |
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
| |||
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
118 | 118 | | |
0 commit comments