Docs: legacy performance-tuning guide has broken image links and dead anchor; kv_cache_manager.md links removed code
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 14.7k
- Forks
- 2.8k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 489
Description
Three docs issues found while reading the current docs tree:
-
docs/source/legacy/performance/performance-tuning-guide/tuning-max-batch-size-and-max-num-tokens.md+deciding-model-sharding-strategy.md: seven image links use../../media/…, which resolves todocs/source/legacy/media/— the SVGs actually live indocs/source/media/. All seven are broken on the rendered site. The same tuning guide also links#understanding-the-trt-llm-scheduler, which matches no heading. -
docs/source/legacy/reference/memory.md:127: links#activation-size, but the only matching heading is### 2. Activation size→#2-activation-size. -
docs/source/torch/kv_cache_manager.md:54-55: linkstensorrt_llm/_torch/pyexecutor/backend_registries/pytorch_model_registry.py, which no longer exists, and instructs readers to look atcreate_pytorch_model_based_executor, a function that no longer exists in the code (the KVCacheManager is now instantiated intensorrt_llm/_torch/pyexecutor/resource_manager.py).
Happy to send PRs for 1-2; for 3 the correct replacement target should be confirmed by a maintainer first.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two legacy performance-tuning Markdown files, docs/source/legacy/reference/memory.md, and docs/source/torch/kv_cache_manager.md; inspect the referenced headings, image paths, and Python entry points. Verify that all seven images and anchors resolve, then confirm with a maintainer which current resource-manager target should replace the removed registry link and function reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100