docs: broken links in benchmarking documentation

[JanelleCai]

Overview:

fix several broken links on this page, such as mocker backend and mocker directory

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

Summary by CodeRabbit

• Documentation
  • Updated links in benchmarking documentation to ensure proper navigation to referenced deployment guides, container documentation, backend examples, and other resources.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request updates documentation links in the benchmarking guide by replacing internal relative links with absolute GitHub URLs pointing to the main repository, affecting references to deployment utilities, examples, containers, and backend documentation.

Changes

Cohort / File(s)	Change Summary
Documentation Link Updates docs/benchmarks/benchmarking.md	Replaced 7 internal relative links with absolute GitHub URLs referencing deployment utilities, examples, container resources, and backend documentation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Links once hidden, now on display,
Pointing travelers the absolute way,
From docs to repos, the path is clear,
Our benchmark guide shines bright here! 🌟

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description is incomplete. While the Overview section provides context about the broken links, the Details and Where should the reviewer start sections are empty, and no Related Issues are referenced.	Fill in the Details section with specifics about which links were fixed and how. Add guidance under 'Where should the reviewer start' to direct reviewers to the modified documentation file.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: fixing broken links in benchmarking documentation, which is the core focus of the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @docs/benchmarks/benchmarking.md:
- Line 339: The README's "build.sh - Docker Image Builder" section documents
building and tagging (e.g., using --tag) but omits pushing the built image to a
container registry and instructions to update the deployment YAML; add a brief
step after the build instructions showing the standard docker push (or podman
push) workflow using the chosen tag and a short note telling users to set that
tag in the image field of benchmarks/incluster/benchmark_job.yaml (referencing
the build.sh - Docker Image Builder section and the --tag examples so users know
where to plug the tag).

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between daa1d74 and 274fe99.

📒 Files selected for processing (1)

• docs/benchmarks/benchmarking.md

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-09-04T19:03:06.643Z

Learnt from: biswapanda
Repo: ai-dynamo/dynamo PR: 2872
File: examples/multimodal/deploy/agg_qwen.yaml:53-60
Timestamp: 2025-09-04T19:03:06.643Z
Learning: In the dynamo repository, Kubernetes Custom Resources use `gpu: "1"` format for GPU resource limits and requests, not the standard Kubernetes `nvidia.com/gpu: 1` format. This applies to DynamoGraphDeployment resources and other dynamo CRs.

Applied to files:

• docs/benchmarks/benchmarking.md

📚 Learning: 2025-12-02T18:13:40.065Z

Learnt from: PeaBrane
Repo: ai-dynamo/dynamo PR: 4698
File: .github/workflows/container-validation-dynamo.yml:68-68
Timestamp: 2025-12-02T18:13:40.065Z
Learning: In the ai-dynamo/dynamo repository, backend-specific tests (vllm, sglang, trtllm) are intentionally excluded from the container-validation-dynamo.yml workflow using "not (vllm or sglang or trtllm)" because they run in a separate container-validation-backends.yml workflow that has dedicated jobs for each backend. This separation keeps framework-agnostic tests separate from backend-specific tests.

Applied to files:

• docs/benchmarks/benchmarking.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Mirror Repository to GitLab

🔇 Additional comments (6)

docs/benchmarks/benchmarking.md (6)

100-100: Confirm internal documentation links are intentional relative paths.

The file contains relative links to internal documentation pages (/docs/kubernetes/installation_guide.md on line 100 and /docs/kubernetes/README.md on line 328). These appear distinct from the resource links being fixed in this PR. Verify these are intentionally left as relative documentation links for internal cross-referencing, not broken links that also need fixing.

Also applies to: 328-328

---

329-329: No issues found. The link to deploy/utils/README.md correctly references PVC configuration documentation. The README contains comprehensive storage setup information including PVC manifest files, access mode configuration, and permissions documentation for server-side benchmarking.

---

100-100: All referenced paths exist and links are correctly formatted.

Verification confirms all seven link locations reference valid repository paths with correct GitHub URL formatting:

• deploy/utils/README.md and deploy/utils (file and directory variants appropriately used)
• examples/backends (directory reference)
• container/README.md (file reference)
• components/src/dynamo/mocker (directory reference used consistently)

The mixed use of directory-only and explicit file references is intentional and appropriate based on the target resources.

---

532-532: Mocker backend directory verification passed.

The mocker backend directory at components/src/dynamo/mocker exists with comprehensive documentation. The README.md provides detailed configuration options, multiple usage examples with command-line invocations, performance modeling guidance, and K8s deployment examples. All claims made in the benchmarking documentation about the mocker backend's capabilities (testing without GPU, development/debugging, benchmarking) are substantiated by the actual directory contents and configuration parameters.

---

103-103: The link to examples/backends is valid. The directory contains deployment documentation for DynamoGraphDeployments across multiple backend frameworks (vLLM, SGLang, TensorRT-LLM). Each backend's deploy/README.md provides comprehensive guidance on deploying with frontend service exposure, covering both aggregated and disaggregated deployment patterns.

---

100-100: Fix incorrect GitHub URL formats for directory paths.

Several links use blob/main/ for directories instead of files, which GitHub cannot render correctly. Four links need correction:

• Lines 103, 335 (examples/backends): Using blob/main/ for a directory. Clarify the intended deployment backend documentation or change to tree/main/ for directory browsing.
• Lines 532, 541 (components/src/dynamo/mocker): Using blob/main/ for a directory when a README.md file exists. Change to point to the file: blob/main/components/src/dynamo/mocker/README.md.

GitHub's blob/main/ path is for files only; use tree/main/ for directories or point to specific files within the directory.

⛔ Skipped due to learnings

Learnt from: biswapanda
Repo: ai-dynamo/dynamo PR: 2872
File: examples/multimodal/deploy/agg_qwen.yaml:53-60
Timestamp: 2025-09-04T19:03:06.643Z
Learning: In the dynamo repository, Kubernetes Custom Resources use `gpu: "1"` format for GPU resource limits and requests, not the standard Kubernetes `nvidia.com/gpu: 1` format. This applies to DynamoGraphDeployment resources and other dynamo CRs.

[hhzhang16]

Check the CodeRabbit comment but lgtm, thanks!