[None][doc] Fix broken links across example and test READMEs - #18379
[None][doc] Fix broken links across example and test READMEs#18379jlonge4 wants to merge 1 commit into
Conversation
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>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (5)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. WalkthroughThe pull request corrects documentation links and updates a release performance test reference across five Markdown files. ChangesDocumentation reference corrections
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to 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: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation 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 CoverageExplanation 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)
Comment |
brnguyen2
left a comment
There was a problem hiding this comment.
Approving — the comments below are optional touch-ups, not blockers.
Verified all three internal targets on disk (blog04_/blog08_ filenames, examples/scaffolding/token_budget_majority_vote.py via ../../, llm_args.py, llm_perf_core.yml) — they resolve. The description matches the diff.
One gap worth closing while you're in this file: README_release_test.md still points at three test lists that no longer exist, and tests/integration/test_lists/qa/README.md:56 still names llm_perf_full.yml. Those are the same rename you already fixed, not the "needs a prose rewrite" class you deferred.
| 1. **llm_perf_full.yml** - Release performance test | ||
| - [test_lists/qa/llm_perf_full.yml](../../test_lists/qa/llm_perf_full.yml) | ||
| 1. **llm_perf_core.yml** - Release performance test | ||
| - [test_lists/qa/llm_perf_core.yml](../../test_lists/qa/llm_perf_core.yml) |
There was a problem hiding this comment.
tests/integration/test_lists/qa/ currently contains only llm_perf_core.yml, llm_perf_disagg.yml, llm_perf_multinode.{yml,txt}, and llm_spark_perf.yml. So the three siblings of the link you fixed are still dead: llm_perf_cluster.yml (line 115), llm_perf_nim.yml (line 117), and llm_perf_sanity.yml (line 122). Fixing one entry in a list of four makes the rest look verified. Either update/remove them here or state in the PR description that they fall into the deferred stale-content group.
|
|
||
| 1. **llm_perf_full.yml** - Release performance test | ||
| - [test_lists/qa/llm_perf_full.yml](../../test_lists/qa/llm_perf_full.yml) | ||
| 1. **llm_perf_core.yml** - Release performance test |
There was a problem hiding this comment.
tests/integration/test_lists/qa/README.md:56 still documents llm_perf_full.yml as "Main performance test configuration" — same rename, one-line fix, and it belongs in this PR rather than a follow-up.
Dev Engineer Review
QA Engineer Review
tests/integration/defs/perf/README_release_test.md.Description
While following up on #18378, I scanned all 123
READMEfiles 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.examples/models/core/qwen/README.mdexamples/backends/trtllm/deployexamples/wide_ep/README.md(×2)blog4_→blog04_,blog8_→blog08_examples/auto_deploy/README.mdLlmArgslink truncated — missing thepyextensionllm_args.→llm_args.pytensorrt_llm/scaffolding/README.mdtensorrt_llm/scaffolding/examples/...../../tests/integration/defs/perf/README_release_test.mdllm_perf_full.ymlwas renamed in #7899llm_perf_full.yml→llm_perf_core.ymlThis 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:
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-compatibleorapi-breaking. Forapi-breaking, includeBREAKINGin 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.