-
-
Notifications
You must be signed in to change notification settings - Fork 11k
[Doc] Fix links to GH projects #27530
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.
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
[Doc] Fix links to GH projects #27530
Conversation
Signed-off-by: DarkLight1337 <[email protected]>
|
Documentation preview: https://vllm--27530.org.readthedocs.build/en/27530/ |
There was a problem hiding this 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.
| - [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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this 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!
Signed-off-by: DarkLight1337 <[email protected]>
Purpose
Missed in #27009
Test Plan
Test Result
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.