Skip to content

[None][docs] Fix broken SVG image links in legacy performance tuning guide - #15635

Closed
chfeng-cs wants to merge 1 commit into
NVIDIA:mainfrom
chfeng-cs:fix/docs-legacy-perf-svg-links
Closed

chfeng-cs wants to merge 1 commit into
NVIDIA:mainfrom
chfeng-cs:fix/docs-legacy-perf-svg-links

Conversation

@chfeng-cs

@chfeng-cs chfeng-cs commented Jun 25, 2026 •

Copy link
Copy Markdown

Description

Seven SVG image links in the legacy performance-tuning-guide docs were broken. The affected files live at: docs/source/legacy/performance/performance-tuning-guide/ , such as https://github.com/NVIDIA/TensorRT-LLM/blob/main/docs/source/legacy/performance/performance-tuning-guide/deciding-model-sharding-strategy.md

Each link used ../../media/<image>.svg, which resolves to: docs/source/legacy/media/ . This path does not exist.

The actual SVG files are at docs/source/media/. Because the guide is nested one level deeper than expected, the path was missing one ../ level.

Fix

Changed all 7 occurrences from ../../media/ → ../../../media/, which correctly resolves to docs/source/media/ where the files actually live.

Files changed:

File Links fixed
deciding-model-sharding-strategy.md 2 (Pipeline_Parallel_Vis.svg, Tensor_Parallelism_Vis.svg)
tuning-max-batch-size-and-max-num-tokens.md 5 (TRTLLM_Scheduler_Vis_1~4.svg, TRTLLM_Scheduler_Vis_Chunked_Context_1.svg)

No content changes — path corrections only.

Summary by CodeRabbit

  • Documentation
    • Updated several performance-tuning guide illustrations so images display correctly with the new document structure.
    • Adjusted figure placement and spacing in the affected sections for better readability.

…guide

The performance-tuning-guide docs used ../../media/ which resolved to a
non-existent docs/source/legacy/media/ directory. The SVG files live at
docs/source/media/, so the correct relative path is ../../../media/.

Signed-off-by: Ethan Feng <ethan.fengch@gmail.com>
@chfeng-cs
chfeng-cs requested a review from a team as a code owner June 25, 2026 16:57
@chfeng-cs
chfeng-cs requested review from QiJune and laikhtewari June 25, 2026 16:57
@coderabbitai

coderabbitai Bot commented Jun 25, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated embedded figure paths in two legacy performance tuning guide pages so the referenced images point to the current media directory.

Changes

Legacy performance guide image updates

Layer / File(s) Summary
Relative media path updates
docs/source/legacy/performance/performance-tuning-guide/deciding-model-sharding-strategy.md, docs/source/legacy/performance/performance-tuning-guide/tuning-max-batch-size-and-max-num-tokens.md
Embedded visualization links were updated from ../../media/... to ../../../media/... in the sharding guide and in the scheduler and chunked-context sections of the tuning guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the issue and fix, but it omits the template's Test Coverage and PR Checklist sections.
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.
Title check ✅ Passed The title accurately summarizes the main change: fixing broken SVG image links in the legacy performance tuning guide.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@chfeng-cs chfeng-cs changed the title [None][docs] Fix broken SVG image links in legacy performance tuning … [None][docs] Fix broken SVG image links in legacy performance tuning guide Jun 25, 2026
@github-actions

Copy link
Copy Markdown

@chfeng-cs this pull request has had no activity for more than 120 days. Is it still active? Please post an update when you can.

@karljang

karljang commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

Thank you for bringing this to our attention.
However, I’m closing this PR because it seems to have been superseded by #19007, which provides more coverage.

@karljang karljang closed this Nov 3, 2026
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