Skip to content

docs(v0.6.0): fix broken links in observability snapshot page#261

Merged
sbaum1994 merged 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-v0.6.0-observability-links
Jul 20, 2026
Merged

docs(v0.6.0): fix broken links in observability snapshot page#261
sbaum1994 merged 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-v0.6.0-observability-links

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

docs/v0.6.0/observability.md carries the same broken links docs/user/observability.md had before #240: they pointed to old paths, the real pages live under metrics/. This is a frozen version snapshot, normally left alone per docs/AGENTS.md, but fixed here at explicit request since #240 does not touch it.

Tested: verified each new link target exists on disk.

Refs: NO-REF

Summary by CodeRabbit

  • Documentation
    • Updated observability documentation links to match the latest Markdown file paths.
    • Corrected references for application statistics, service metrics, gRPC proxy metrics, example dashboards, and State Metrics Service metrics.

docs/v0.6.0/observability.md carries the same broken links that
docs/user/observability.md had before NVIDIA#240: they pointed to old
paths, the real pages live under metrics/. Applied the same fix to
this frozen version snapshot at explicit request.

JIRA: NO-REF
NVBug: none
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil
mesutoezdil requested a review from a team as a code owner July 20, 2026 13:05
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1c8c1f27-1340-4d47-b4a1-dae2179cf64b

📥 Commits

Reviewing files that changed from the base of the PR and between adfbbd8 and fc42594.

📒 Files selected for processing (1)
  • docs/v0.6.0/observability.md

📝 Walkthrough

Walkthrough

Updated observability documentation links to reference their new relative Markdown paths, including application statistics, service metrics, gRPC proxy metrics, example dashboards, and state metrics.

Changes

Observability documentation

Layer / File(s) Summary
Update observability link paths
docs/v0.6.0/observability.md
Updated links in the question table and application-level statistics section to use the new .md paths.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • NVIDIA/nvcf#240: Updates the same observability documentation links, including metrics and dashboard references.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing broken documentation links in the observability page.
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.

@pdmack

pdmack commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

This PR is one of four that together fix the lychee link check failures currently blocking CI on other PRs (e.g. #252). Verified locally: with #240, #241, #242, and #261 all applied, lychee --offline and fern check both pass with zero errors.

Note: broader broken-link issues remain visible via fern check --broken-links (14 additional errors in nav-tree resolution, pre-existing and out of scope here).

@sbaum1994 -- can you review and approve so these can merge?

@sbaum1994
sbaum1994 merged commit 5079d5c into NVIDIA:main Jul 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants