Skip to content

[None][doc] Fix broken links across example and test READMEs - #18379

Open
jlonge4 wants to merge 1 commit into
NVIDIA:mainfrom
jlonge4:fix/broken-readme-links
Open

[None][doc] Fix broken links across example and test READMEs#18379
jlonge4 wants to merge 1 commit into
NVIDIA:mainfrom
jlonge4:fix/broken-readme-links

Conversation

@jlonge4

@jlonge4 jlonge4 commented Aug 28, 2026

Copy link
Copy Markdown

Dev Engineer Review

  • Fixed six documentation links across example, scaffolding, and release-test README files.
  • No code, API, configuration, or behavior changes.
  • Internal links were verified on disk.
  • Corrected external links returned HTTP 200.
  • No regressions identified.

QA Engineer Review

  • No test functions were added, modified, or removed.
  • The change updates documentation only in tests/integration/defs/perf/README_release_test.md.
  • No test-list coverage update is required.
  • Verdict: sufficient.

Description

While following up on #18378, I scanned all 123 README files in the repo (503 links total: 236 repo-relative, 224 unique external URLs) and found a number of broken links. This PR fixes the six that are unambiguous, mechanical corrections.

File Problem Fix
examples/models/core/qwen/README.md Dead Dynamo deployment link — the same 404 fixed for DeepSeek-V3 in #18378 Point at examples/backends/trtllm/deploy
examples/wide_ep/README.md (×2) Tech blog filenames are zero-padded on disk blog4_blog04_, blog8_blog08_
examples/auto_deploy/README.md LlmArgs link truncated — missing the py extension llm_args.llm_args.py
tensorrt_llm/scaffolding/README.md Link written repo-root-relative, so it resolved to tensorrt_llm/scaffolding/examples/... Prefix with ../../
tests/integration/defs/perf/README_release_test.md llm_perf_full.yml was renamed in #7899 llm_perf_full.ymlllm_perf_core.yml

This is a documentation-only change — no code, API, or behavior is affected.

Not included here

The scan also surfaced ~12 broken links that are stale content rather than bad links — they point at files intentionally deleted by the legacy-TensorRT removals (#15763, #15918, #16369, #16610) and at test lists consolidated in #9714/#10657/#14952. Those need prose rewrites and maintainer decisions about intended replacements, so I've filed them separately rather than guessing at substitutions in this PR.

Test Coverage

No tests apply — documentation-only link changes. Each change was verified mechanically:

  • Repo-relative links: re-ran the link scan after the edits; the three internal fixes now resolve on disk (broken internal count went 19 → 16, with the remaining 16 all being the stale-content group above).
  • External URLs: all three fixed URLs return HTTP 200, and the originals were confirmed 404.

PR Checklist

Please review the following before submitting your PR:

  • PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.

  • PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.

  • Test cases are provided for new code paths (see test instructions)

  • If PR introduces API changes, an appropriate PR label is added - either api-compatible or api-breaking. For api-breaking, include BREAKING in the PR title.

  • Any new dependencies have been scanned for license and vulnerabilities

  • CODEOWNERS updated if ownership changes

  • Documentation updated as needed

  • Update tava architecture diagram if there is a significant design change in PR.

  • The reviewers assigned automatically/manually are appropriate for the PR.

  • Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

To see a list of available CI bot commands, please comment /bot help.

Fixes six broken links found by scanning all 123 README files in the repo:

- examples/models/core/qwen: dead Dynamo deployment link (same 404 as the
  DeepSeek-V3 README); the examples moved to examples/backends/trtllm/deploy
- examples/wide_ep: tech blog filenames are zero-padded (blog04_/blog08_)
- examples/auto_deploy: truncated LlmArgs path missing the .py extension
- tensorrt_llm/scaffolding: link was repo-root-relative instead of relative
  to the README's own directory
- tests/integration/defs/perf: llm_perf_full.yml was renamed to
  llm_perf_core.yml

All targets verified: internal links resolve on disk, external URLs return
HTTP 200.

Signed-off-by: Jlonge4 <josh.longenecker1@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

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: 9a9ddb0a-63cd-4bd6-a25b-e1f3a3eccb7d

📥 Commits

Reviewing files that changed from the base of the PR and between 5767bed and 27a7678.

📒 Files selected for processing (5)
  • examples/auto_deploy/README.md
  • examples/models/core/qwen/README.md
  • examples/wide_ep/README.md
  • tensorrt_llm/scaffolding/README.md
  • tests/integration/defs/perf/README_release_test.md

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


Walkthrough

The pull request corrects documentation links and updates a release performance test reference across five Markdown files.

Changes

Documentation reference corrections

Layer / File(s) Summary
Reference path updates
examples/auto_deploy/README.md, examples/models/core/qwen/README.md, examples/wide_ep/README.md, tensorrt_llm/scaffolding/README.md, tests/integration/defs/perf/README_release_test.md
Corrects source, deployment example, blog, and scaffolding links. Updates the release performance test reference from llm_perf_full.yml to llm_perf_core.yml.

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

Merge Risk: ⚪ Minimal · up to 27a76

This PR makes localized documentation link corrections without changing code or product behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: brnguyen2

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies a documentation change that fixes broken links across the affected README files. It follows the required [None][doc] format and is concise.
Description check ✅ Passed The description is complete and relevant. It explains the issue, lists each link correction, states that the change is documentation-only, documents verification steps, and includes the required check…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Description check

Explanation

The description is complete and relevant. It explains the issue, lists each link correction, states that the change is documentation-only, documents verification steps, and includes the required checklist with the review confirmation marked.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (5 skipped: 5 unsupported.)

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

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