Skip to content

docs(user): fix broken links in observability page#240

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

docs(user): fix broken links in observability page#240
sbaum1994 merged 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/fix-observability-links

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Fixes broken links in docs/user/observability.md. They pointed to old paths; the real pages live under docs/user/metrics/.

Tested: verified each link target exists, ran ./tools/ci/check-docs (0 errors).

Refs: NO-REF

Several links pointed to pages that were moved under docs/user/metrics/
or never had the .md extension. Point them at the real files.

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 17, 2026 16:38
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated observability documentation links to reference new locations for metrics, gRPC proxy metrics, dashboards, and State Metrics Service metrics.

Changes

Observability documentation

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

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing broken links in the observability documentation page.
✨ 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 dcb1aff into NVIDIA:main Jul 20, 2026
7 checks passed
sbaum1994 pushed a commit that referenced this pull request Jul 20, 2026
docs/v0.6.0/observability.md carries the same broken links that
docs/user/observability.md had before #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>
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