[Docs] Fix titles for multi-file examples that are rendered in the docs #23573
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Harry Mellor <[email protected]>
![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 aims to improve how titles for multi-file examples are generated for the documentation. The changes correctly extract the title from the first line of a markdown file and adjust the content inclusion to avoid duplicating the title. My review includes one high-severity suggestion to improve the robustness of file handling by specifying the encoding, which will prevent potential issues on different operating systems.
simon-mo
approved these changes
Aug 25, 2025
tc-mb
pushed a commit
to tc-mb/vllm
that referenced
this pull request
Aug 27, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: tc-mb <[email protected]>
epwalsh
pushed a commit
to epwalsh/vllm
that referenced
this pull request
Aug 28, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]>
xiao-llm
pushed a commit
to xiao-llm/vllm
that referenced
this pull request
Aug 28, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Xiao Yu <[email protected]>
zhewenl
pushed a commit
to zhewenl/vllm
that referenced
this pull request
Aug 28, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]>
zhewenl
pushed a commit
to zhewenl/vllm
that referenced
this pull request
Sep 3, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]>
FeiDaLI
pushed a commit
to FeiDaLI/vllm
that referenced
this pull request
Sep 25, 2025
…cs (vllm-project#23573) Signed-off-by: Harry Mellor <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README.mdin the case of multi-file examplesREADME.mdis included as a snippet in the generated example docs page