Skip to content

Conversation

@DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Oct 26, 2025

Purpose

Missed in #27009

Test Plan

Test Result


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337 DarkLight1337 requested a review from hmellor October 26, 2025 09:37
@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 26, 2025
@mergify
Copy link

mergify bot commented Oct 26, 2025

Documentation preview: https://vllm--27530.org.readthedocs.build/en/27530/

@mergify mergify bot added the documentation Improvements or additions to documentation label Oct 26, 2025
Copy link
Contributor

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

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 fixes two broken links to GitHub Projects in the contributing guide by replacing a custom gh-project: scheme with full HTTPS URLs. My review suggests that while this fixes the links, a more maintainable approach would be to add support for the gh-project: scheme in the docs/mkdocs/hooks/url_schemes.py hook. This would centralize the link generation logic and keep the markdown source cleaner, addressing the root cause rather than applying a patch.

Comment on lines +19 to +21
- [Selected onboarding tasks](https://github.com/orgs/vllm-project/projects/6)
- [New model requests](https://github.com/vllm-project/vllm/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22new-model%22)
- [Models with multi-modal capabilities](gh-project:10)
- [Models with multi-modal capabilities](https://github.com/orgs/vllm-project/projects/10)
Copy link
Contributor

Choose a reason for hiding this comment

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

high

While this change fixes the immediate issue of broken links, it replaces the concise gh-project: scheme with hardcoded, absolute URLs. This can make the documentation harder to maintain, especially if the project structure changes or if these links need to be updated across multiple files.

A more robust solution would be to enhance the documentation build process to handle the gh-project: scheme. This could be done by updating the docs/mkdocs/hooks/url_schemes.py hook to resolve these custom links into the correct GitHub project URLs. This approach would centralize the logic for URL generation, improve maintainability, and keep the Markdown source clean and consistent.

@DarkLight1337 DarkLight1337 merged commit 8fb7b2f into vllm-project:main Oct 26, 2025
10 of 11 checks passed
@DarkLight1337 DarkLight1337 deleted the fix-project-links branch October 26, 2025 09:55
Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

Thanks for fixing, sorry I missed these!

xuhaolei pushed a commit to ZJU-REAL/EasySteer-vllm-v1 that referenced this pull request Oct 27, 2025
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 ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants