Skip to content

Commit 5306971

Browse files
committed
docs: fix Fern link validation issues
Signed-off-by: Will Killian <wkillian@nvidia.com>
1 parent e269921 commit 5306971

51 files changed

Lines changed: 172 additions & 902 deletions

Some content is hidden

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

.github/ISSUE_TEMPLATE/03-documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ body:
4040
description: Link to pages or list file paths. Enter N/A if you are not sure.
4141
placeholder: |
4242
- https://...
43-
- fern/...
43+
- fern/... or docs/...
4444
validations: {required: true}
4545
- type: textarea
4646
id: proposed_change

.github/workflows/fern-docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -390,6 +390,10 @@ jobs:
390390
git config user.name "github-actions[bot]"
391391
git config user.email "github-actions[bot]@users.noreply.github.com"
392392
git add -A
393+
if git diff --cached --quiet; then
394+
echo "No docs snapshot changes to commit."
395+
exit 0
396+
fi
393397
git commit -m "docs(fern): release version v${{ steps.version.outputs.tag }}
394398
395399
Automated documentation snapshot.

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ repos:
6767
- --no-progress
6868
- --include-fragments
6969
- --root-dir
70-
- /
70+
- .
7171
- --scheme
7272
- http
7373
- --scheme

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Minimum guidance:
154154
- Node.js binding or wrapper changes: `just test-node`.
155155
- Go binding or raw FFI changes: `just test-go` and the relevant Rust/FFI checks.
156156
- WebAssembly binding changes: `just test-wasm`.
157-
- Documentation site changes, including link or navigation changes: `just docs`. The recipe regenerates the ignored Fern API reference pages before validation.
157+
- Documentation site changes: `just docs`. Run docs link validation with `just docs-linkcheck` when links change. The recipes regenerate the ignored Fern API reference pages before validation.
158158
- Cross-language API changes: run the touched binding tests and update docs, package READMEs, and generated surfaces where applicable.
159159

160160
Before review, prefer `uv run pre-commit run --all-files` when the change crosses languages or tooling. The hooks enforce SPDX headers, file hygiene, Ruff, `ty`, Markdown link checks, Cargo formatting/lints/audits, Go formatting/vet, Node formatting, and public docstring checks.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Before opening a PR, check the following:
201201
2. The relevant reference docs are updated for any public API change.
202202
3. The relevant crate or package README is updated when that surface changed.
203203
4. Embedded documentation snippets, patch docs, and binding-support notes are updated if examples or supported bindings changed.
204-
5. For docs site changes, run `./scripts/build-docs.sh`; it regenerates ignored Fern API reference pages before validation.
204+
5. For docs site changes, run `just docs` (or `./scripts/build-docs.sh html` as a compatibility wrapper) — it regenerates ignored Fern API reference pages before validation.
205205

206206
For documentation-heavy changes, prefer small targeted commits so the history
207207
shows entry-point changes, reference changes, examples, and maintenance updates

docs/about/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-into-frameworks/about).
154+
deeper integration patterns in [Integrate into Frameworks](/integrate-frameworks/about).

docs/about/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](/adaptive-plugin/configuration),
154-
[Adaptive Cache Governor (ACG)](/adaptive-plugin/acg), and
155-
[Adaptive Hints](/adaptive-plugin/adaptive-hints).
153+
[Adaptive Configuration](/plugins/adaptive/configuration),
154+
[Adaptive Cache Governor (ACG)](/plugins/adaptive/acg), and
155+
[Adaptive Hints](/plugins/adaptive/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](/observability-plugin/configuration).
166+
[Observability Configuration](/plugins/observability/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).

docs/about/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](/observability-plugin/atif)
137+
The [Agent Trajectory Interchange Format (ATIF) exporter](/plugins/observability/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](/observability-plugin/atof)
143+
The [Agent Trajectory Observability Format (ATOF) JSONL exporter](/plugins/observability/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](/observability-plugin/about).
158+
[Observability](/plugins/observability/about).
159159
For configuration-driven setup, use the built-in
160-
[`observability` plugin](/observability-plugin/configuration)
160+
[`observability` plugin](/plugins/observability/configuration)
161161
to install ATOF, ATIF, OpenTelemetry, and OpenInference subscribers from one
162162
plugin component.
163163

docs/about/ecosystem.mdx

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-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)
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)
118118
- [Plugin Model](/build-plugins/basic-guide)

docs/about/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,13 @@ Use the reading path that matches your task:
6767
| Develop from source | [Development Setup](/contribute/development-setup) |
6868
| Understand the runtime model | [Concepts](/about-nemo-relay/concepts) |
6969
| Instrument an application | [Instrument Applications](/instrument-applications/about) |
70-
| Use a maintained integration | [Supported Integrations](/supported-integrations/about) |
71-
| Integrate a framework | [Integrate into Frameworks](/integrate-into-frameworks/about) |
70+
| Use a maintained integration | [Supported Integrations](/integrations/about) |
71+
| Integrate a framework | [Integrate into Frameworks](/integrate-frameworks/about) |
7272
| Observe a local coding-agent CLI | [NeMo Relay CLI](/nemo-relay-cli/about) |
7373
| Package reusable behavior | [Build Plugins](/build-plugins/about) |
74-
| Export traces or trajectories | [Observability](/observability-plugin/about) |
74+
| Export traces or trajectories | [Observability](/plugins/observability/about) |
7575
| Debug trace incidents | [Trace Incident Runbook](/resources/troubleshooting/trace-incident-runbook) |
76-
| Tune performance with adaptive behavior | [Adaptive](/adaptive-plugin/about) |
76+
| Tune performance with adaptive behavior | [Adaptive](/plugins/adaptive/about) |
7777
| Look up symbols | [APIs](/reference/api) |
7878

7979
## Conceptual Diagram

0 commit comments

Comments
 (0)