Skip to content

[Doc] Fix link errors and add section anchors - #13485

Merged
liqian79 merged 1 commit into
vllm-project:mainfrom
herizhen:fix_doc_link_main
Aug 4, 2026
Merged

liqian79 merged 1 commit into
vllm-project:mainfrom
herizhen:fix_doc_link_main

Conversation

@herizhen

@herizhen herizhen commented Aug 4, 2026 •

Copy link
Copy Markdown
Contributor

What this PR does / why we need it?

This PR fixes broken links in the documentation (such as the Docker installation guide link and the msmodelslim quantization method link) and adds explicit anchors ({: #5-online-service-deployment }) to the "5 Online Service Deployment" headers across various model tutorial files to ensure correct cross-referencing.

Does this PR introduce any user-facing change?

No, this is a documentation-only update.

How was this patch tested?

Verified that the links and anchors are correct.

@herizhen
herizhen requested review from LCAIZJ and Yikun as code owners August 4, 2026 10:22
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 4, 2026
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

👋 Hi! Thank you for contributing to the vLLM Ascend project. The following points will speed up your PR merge:‌‌

  • A PR should do only one thing, smaller PRs enable faster reviews.
  • Every PR should include unit tests and end-to-end tests ‌to ensure it works and is not broken by other future PRs.
  • Write the commit message by fulfilling the PR description to help reviewer and future developers understand.

If CI fails, you can run linting and testing checks locally according Contributing and Testing.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on improving the documentation quality by fixing broken or outdated links and adding consistent anchors to deployment sections. These changes ensure that users can reliably access external resources and navigate the documentation more effectively.

Highlights

  • Documentation Anchors: Added unique HTML anchors to 'Online Service Deployment' headers across multiple model tutorial files to improve navigation and cross-referencing.
  • Link Correction: Updated the Docker installation guide link in 'quick_start.md' to point to the correct 'get-started' path.
  • External Resource Update: Corrected the 'msmodelslim' documentation link in the 'DeepSeek-V3.1.md' tutorial to ensure accurate resource access.
New Features

🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates several documentation files to fix broken links (such as the Docker installation guide and the msmodelslim quantization method link) and adds explicit section anchors ({: #5-online-service-deployment }) to the "5 Online Service Deployment" headers across multiple model tutorial files. The reviewer pointed out that the PR title and description do not follow the repository's Pull Request Summary Style Guide and provided a compliant template to use.

Comment thread docs/source/quick_start.md
@herizhen herizhen changed the title [Doc] fix link error [Doc] Fix link errors and add section anchors Aug 4, 2026
Signed-off-by: herizhen <1270637059@qq.com>
@herizhen
herizhen force-pushed the fix_doc_link_main branch from 774141a to 5585f91 Compare August 4, 2026 10:51
@liqian79
liqian79 merged commit b80d4e6 into vllm-project:main Aug 4, 2026
15 checks passed
shenhui-cli added a commit to shenhui-cli/vllm-ascend that referenced this pull request Aug 5, 2026
…into vllm-new

# By shenhui-cli (8) and others
# Via GitHub (1) and shenhui-cli (1)
* 'vllm-new' of https://github.com/shenhui-cli/vllm-ascend: (34 commits)
  When the PR modifies any files in the CSRC folder, skip the test case filtering logic and execute all test cases by default.
  [MRV2][Bugfix] Fix two triton ops errors in model_runner_v2 num_nans_kernel and apply_panalties (vllm-project#13159)
  [Cherry-pick][main][Doc][BugFix] Update proxy script name in DeepSeek-V3.2 tutorial (from vllm-project#13537) (vllm-project#13575)
  [Refactor][quantization]remove mxfp_compat compatibility shim and inline dtype references (vllm-project#13447)
  [MTP][BugFix] Preserve MoE weight loaders during online updates (vllm-project#13337)
  [Feature][xlite] Support MLA and DSA (`DeepseekV3ForCausalLM`, `DeepseekV32ForCausalLM` and `GlmMoeDsaForCausalLM`) in the xlite adapter (vllm-project#13378)
  [BugFix][xlite] Fix DP metadata handling in XliteWrapper and pass down the max number of tokens across all DP ranks for collective communications. (vllm-project#11213)
  [Refactor][Ops] Move expert routing into router classes (vllm-project#13417)
  [Platform][Refactor] Refactor NPUPlatform for better organization and clarity (vllm-project#13484)
  [BugFix] fix fiaV2 contiguous err in GQA (vllm-project#13456)
  [feature][KV Offload] Support Sparse KV Cache Offload (vllm-project#13026)
  [Bugfix][MRV2]Skip D2H copy and synchronize when spec decode is not active (vllm-project#13382)
  [Bugfix] Change AscendSFAIndexerCacheSpec to inherit MLAAttentionSpec (vllm-project#12849)
  [BugFix][FusedMoE] Restore BF16 quant method initialization (vllm-project#13412)
  [Doc] Fix link errors and add section anchors (vllm-project#13485)
  [TEST]Revise the A3 case (vllm-project#13495)
  [CI] modify default cann_version and add build_type support in nightly (vllm-project#13480)
  [CI]Improve logging, optimize function-level recommendation algorithm, and add early exit for no product code changes (vllm-project#13472)
  This PR restricts the test case discovery scope to the following directories: tests/e2e/pull_request/ tests/ut/
  This PR restricts the test case discovery scope to the following directories: tests/e2e/pull_request/ tests/ut/
  ...

# Conflicts:
#	.github/workflows/scripts/test_selector.py
HMCCMH pushed a commit to hotTea123/vllm-ascend that referenced this pull request Aug 12, 2026
### What this PR does / why we need it?

This PR fixes broken links in the documentation (such as the Docker
installation guide link and the `msmodelslim` quantization method link)
and adds explicit anchors (`{: vllm-project#5-online-service-deployment }`) to the
"5 Online Service Deployment" headers across various model tutorial
files to ensure correct cross-referencing.

### Does this PR introduce _any_ user-facing change?

No, this is a documentation-only update.

### How was this patch tested?

Verified that the links and anchors are correct.


- vLLM version: v0.26.0
- vLLM main:
vllm-project/vllm@0351e9a

Signed-off-by: herizhen <1270637059@qq.com>
MmMmaru pushed a commit to jiaqi-lee/vllm-ascend that referenced this pull request Aug 19, 2026
### What this PR does / why we need it?

This PR fixes broken links in the documentation (such as the Docker
installation guide link and the `msmodelslim` quantization method link)
and adds explicit anchors (`{: vllm-project#5-online-service-deployment }`) to the
"5 Online Service Deployment" headers across various model tutorial
files to ensure correct cross-referencing.

### Does this PR introduce _any_ user-facing change?

No, this is a documentation-only update.

### How was this patch tested?

Verified that the links and anchors are correct.


- vLLM version: v0.26.0
- vLLM main:
vllm-project/vllm@0351e9a

Signed-off-by: herizhen <1270637059@qq.com>
shiqiangA pushed a commit to shiqiangA/vllm-ascend that referenced this pull request Aug 20, 2026
### What this PR does / why we need it?

This PR fixes broken links in the documentation (such as the Docker
installation guide link and the `msmodelslim` quantization method link)
and adds explicit anchors (`{: vllm-project#5-online-service-deployment }`) to the
"5 Online Service Deployment" headers across various model tutorial
files to ensure correct cross-referencing.

### Does this PR introduce _any_ user-facing change?

No, this is a documentation-only update.

### How was this patch tested?

Verified that the links and anchors are correct.


- vLLM version: v0.26.0
- vLLM main:
vllm-project/vllm@0351e9a

Signed-off-by: herizhen <1270637059@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants