Skip to content

docs(changelog): fix broken Metrics Reference link - #432

Open
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/fix-changelog-metrics-link
Open

docs(changelog): fix broken Metrics Reference link#432
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/fix-changelog-metrics-link

Conversation

@LeonSGP43

@LeonSGP43 LeonSGP43 commented Aug 15, 2026

Copy link
Copy Markdown

What

The Metrics Reference link in the 0.2.0 release notes section of CHANGELOG.md points to docs/METRICS_REFERENCE.md, which no longer exists — the file now lives at docs/internal/metrics_reference.md.

Verification

$ ls docs/METRICS_REFERENCE.md
ls: docs/METRICS_REFERENCE.md: No such file or directory
$ ls docs/internal/metrics_reference.md
docs/internal/metrics_reference.md

Small docs correction submitted directly as a PR.

Signed-off-by: LeonSGP43 LeonSGP43@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Updated the metrics reference link in the 0.1.0 changelog entry.

The Metrics Reference link in the 0.2.0 release notes points to
docs/METRICS_REFERENCE.md, but the file now lives at
docs/internal/metrics_reference.md. Update the relative link so it
resolves again.

Signed-off-by: LeonSGP43 <LeonSGP43@users.noreply.github.com>
@LeonSGP43
LeonSGP43 requested a review from a team as a code owner August 15, 2026 04:19
@coderabbitai

coderabbitai Bot commented Aug 15, 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: f7717577-dfce-4394-a094-09f573d6f1c6

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad6744 and f008729.

📒 Files selected for processing (1)
  • CHANGELOG.md

Walkthrough

The 0.1.0 changelog entry now links to docs/internal/metrics_reference.md instead of docs/METRICS_REFERENCE.md.

Changes

Changelog update

Layer / File(s) Summary
Update metrics reference link
CHANGELOG.md
The Metrics Reference link uses the internal documentation path.

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

Merge Risk: ⚪ Minimal · up to f0087

This is a localized changelog link correction with no actionable merge-blocking risk remaining after normal checks and review.

Poem

A rabbit hops through changelog lines,
And finds the metrics path that shines.
The link now points where docs reside,
With tidy trails from side to side.
Thump, thump—reference verified!

🚥 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 clearly describes the changelog change: fixing the Metrics Reference link.
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.

Comment @coderabbitai help to get the list of available commands.

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.

1 participant