[Docs] Enable some more markdown lint rules for the docs#28731
[Docs] Enable some more markdown lint rules for the docs#28731DarkLight1337 merged 1 commit intovllm-project:mainfrom
Conversation
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
|
Documentation preview: https://vllm--28731.org.readthedocs.build/en/28731/ |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enables several markdown linting rules (MD045, MD051, MD053) to enforce stricter formatting in the documentation. The changes include adding alternative text to images and removing unused link definitions across multiple documentation files. These modifications improve the accessibility and maintainability of the documentation. The changes are correct and align with the goal of improving documentation quality. I have no specific comments as the changes are well-executed and do not contain any high or critical severity issues.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| MD024: | ||
| siblings_only: true | ||
| MD033: false | ||
| MD045: false | ||
| MD046: false | ||
| MD051: false | ||
| MD052: false | ||
| MD053: false | ||
| MD059: false |
There was a problem hiding this comment.
The change re-enables markdownlint rule MD045 by removing MD045: false, but many existing docs still embed images with empty alt text via syntax like  (for example in docs/design/arch_overview.md and docs/design/paged_attention.md). Once MD045 is active, these files will fail linting and block the docs pipeline. Either add descriptive alt text across the repo or keep the rule disabled until the remaining violations are addressed.
Useful? React with 👍 / 👎.
github-actions
bot
added
the
ready
…t#28731) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: George D. Torres <gdavtor@gmail.com>
…t#28731) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
…t#28731) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
2 participants
Re-enable some markdown linting rules for more strictly formatted documentation