Skip to content

Fix empty Markdown links in system metrics reference - #3206

Merged
mdlinville merged 1 commit into
mainfrom
fix/system-metrics-empty-anchors
Sep 10, 2026
Merged

mdlinville merged 1 commit into
mainfrom
fix/system-metrics-empty-anchors

Conversation

@mdlinville

Copy link
Copy Markdown
Contributor

Description

models/ref/python/experiments/system-metrics.mdx contains two Markdown links with empty targets:

  • Disk OutSimilar to [Disk In]()
  • Network ReceivedSimilar to [Network Sent]()

Both now point at the corresponding in-page anchors (#disk-in, #network-sent).

Although the page lives under models/ref/, it is maintained by hand rather than generated from SDK docstrings, so the fix belongs here in the .mdx.

Fixing the English source lets the correction flow through the localization pipeline to the fr, ja, and ko copies, where the link checker currently reports the errors:

Errors in fr|ja|ko/models/ref/python/experiments/system-metrics.mdx
[ERROR] <error:> | Empty URL found but a URL must not be empty

Reported in #3168 (comment).

Testing

Text-only link target change; no build or behavior impact beyond the two links now resolving.

🤖 Generated with Claude Code

The Disk Out and Network Received descriptions cross-reference Disk In
and Network Sent with empty link targets, which the link checker flags
as errors in the localized copies (fr/ja/ko) of this page. Point both
links at the corresponding in-page anchors.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@mdlinville
mdlinville requested a review from a team as a code owner September 10, 2026 17:45
@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
wandb 🟢 Ready View Preview Sep 10, 2026, 5:48 PM

@github-actions

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 1 changed page: +0.0 (unchanged).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
models/ref/python/experiments/system-metrics.mdx 8.8 8.8 +0.0 +0.0 unchanged

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
models/ref/python/experiments/system-metrics.mdx 3 3 +0

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 34510126568

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-fix-system-metrics-empty-anchors.mintlify.site

@mdlinville
mdlinville merged commit 811b963 into main Sep 10, 2026
11 checks passed
@mdlinville
mdlinville deleted the fix/system-metrics-empty-anchors branch September 10, 2026 17:49

This branch was successfully deployed

1 active deployment
staging 321d7b67 Deployed Sep 10, 2026 by mintlify[bot]
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.

2 participants