KEMBAR78
[None][doc] Fix the link in the doc by Shixiaowei02 · Pull Request #7713 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

[None][doc] Fix the link in the doc #7713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Sep 16, 2025
Merged

[None][doc] Fix the link in the doc #7713

merged 2 commits into from
Sep 16, 2025

Conversation

@Shixiaowei02
Copy link
Collaborator

@Shixiaowei02 Shixiaowei02 commented Sep 15, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated the hyperlink under “Launching disaggregated servers on SLURM clusters” to point to the correct examples location.
    • Ensures readers are directed to the appropriate disaggregated SLURM example when following the docs.
    • No other content changes.

@Shixiaowei02
Update link for disaggregated inference benchmark scripts
7288d07 
Signed-off-by: Shi Xiaowei <39303645+Shixiaowei02@users.noreply.github.com>
@Shixiaowei02
Update link path for disaggregated inference scripts
b1eb1e5 
Signed-off-by: Shi Xiaowei <39303645+Shixiaowei02@users.noreply.github.com>
@Shixiaowei02 Shixiaowei02 requested a review from a team as a code owner September 15, 2025 07:10
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 15, 2025

📝 Walkthrough

Walkthrough

Updated a documentation hyperlink in docs/source/features/disagg-serving.md to point to a new examples path; no other content changes.

Changes

Cohort / File(s) Change summary
Docs link update
docs/source/features/disagg-serving.md		 Changed SLURM section link target from ../../scripts/disaggregated to ../../../examples/disaggregated/slurm; anchor text unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • byshiue

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description contains only the placeholder "@coderabbitai summary" and the untouched template text, so it does not provide a concrete Description, Test Coverage, or explicit details of the change; required information from the repository's description template is missing and reviewers cannot verify tests or rationale from the current body. The raw changes show a single hyperlink update in docs, but the PR body fails to state which file(s) changed, the exact link modification, or whether tests are needed. Because the description is largely incomplete relative to the required template, the check fails. Please replace the placeholder with a filled PR description that follows the template: describe the issue and solution, list the affected files, state the exact link change (e.g., ../../scripts/disaggregated → ../../../examples/disaggregated/slurm), indicate Test Coverage or "none required" with rationale, and confirm checklist items (coding guidelines, tests, CODEOWNERS, docs). After updating the body, request reviewers to re-evaluate and run CI if applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "[None][doc] Fix the link in the doc" is concise, follows the repository's ticket/type prefix pattern, and correctly summarizes the primary change (a documentation link fix) described in the diff, giving a reviewer immediate context about the main change. It is specific enough for history scanning and does not include extraneous file lists or emojis. Overall the title is on-topic and appropriate for this changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent 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 d5df0af and b1eb1e5.

📒 Files selected for processing (1)
  • docs/source/features/disagg-serving.md (1 hunks)
⏰ 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). (2)
  • GitHub Check: Check PR Checklist Resolution
  • GitHub Check: Pre-commit Check
🔇 Additional comments (1)
docs/source/features/disagg-serving.md (1)

172-172: Use a GitHub-absolute URL for the examples link.

Repo check: examples/disaggregated/slurm exists (benchmark/README.md), but Sphinx-built sites commonly don't include the repo's examples/ tree; switch the relative link to the GitHub "tree/main" path.

File: docs/source/features/disagg-serving.md:172

Apply:

-Please refer to [Disaggregated Inference Benchmark Scripts](../../../examples/disaggregated/slurm).
+Please refer to [Disaggregated Inference Benchmark Scripts](https://github.com/NVIDIA/TensorRT-LLM/tree/main/examples/disaggregated/slurm).

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

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

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

QiJune
QiJune approved these changes Sep 16, 2025
View reviewed changes
Copy link
Collaborator

@QiJune QiJune left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@QiJune
Copy link
Collaborator

QiJune commented Sep 16, 2025

/bot skip --comment "doc changes"

@QiJune QiJune enabled auto-merge (squash) September 16, 2025 01:11
@tensorrt-cicd
Copy link
Collaborator

PR_Github #18680 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18680 [ skip ] completed with state SUCCESS
Skipping testing for commit b1eb1e5

@QiJune QiJune merged commit 809c4d2 into NVIDIA:main Sep 16, 2025
8 of 9 checks passed
@Shixiaowei02 Shixiaowei02 deleted the user/xiaoweis/doc-patch branch September 16, 2025 05:51
@coderabbitai coderabbitai bot mentioned this pull request Sep 16, 2025
Merged
Wong4j pushed a commit to Wong4j/TensorRT-LLM that referenced this pull request Sep 20, 2025
@Shixiaowei02 @Wong4j
[None][doc] Fix the link in the doc (NVIDIA#7713)
2192f49 
Signed-off-by: Shi Xiaowei <39303645+Shixiaowei02@users.noreply.github.com>
MrGeva pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Sep 21, 2025
@Shixiaowei02 @MrGeva
[None][doc] Fix the link in the doc (NVIDIA#7713)
b740a36 
Signed-off-by: Shi Xiaowei <39303645+Shixiaowei02@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@QiJune QiJune QiJune approved these changes

@laikhtewari laikhtewari Awaiting requested review from laikhtewari laikhtewari is a code owner automatically assigned from NVIDIA/trt-llm-doc-owners

@chzblych chzblych Awaiting requested review from chzblych chzblych is a code owner automatically assigned from NVIDIA/trt-llm-doc-owners

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Shixiaowei02 @QiJune @tensorrt-cicd