[Docs] Add a start tag to build.inc.md #26747
Conversation
|
Documentation preview: https://vllm--26747.org.readthedocs.build/en/26747/ |
![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 adds a mkdocs-snippets start tag to docs/getting_started/installation/cpu/build.inc.md to match an existing end tag. While this is a good intention, it introduces a rendering issue in the ARM CPU installation guide, as that guide includes the entire file instead of a snippet. My review includes a comment to fix this by updating the inclusion method in the related file, which will resolve the documentation bug.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds mkdocs-include-markdown-plugin tags to better structure the documentation. The changes are correct, but they highlight an existing issue where the ARM documentation includes a note specific to x86 machines. I've added a comment to remove this misleading information to improve the clarity of the installation instructions.
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
|
I don't quite get why was removed, could you elaborate further? |
|
Hi @DarkLight1337, this removal is to follow the Gemini advice: #26747 (comment) |
|
Shouldn't you add this back to the x86 section then? |
|
Oh, x86 section has this desc: |
DarkLight1337
left a comment
DarkLight1337
left a comment
There was a problem hiding this comment.
Ah I see now, thanks for pointing that out
|
We could migrate all this content directly into the arm doc now that it's the only one to use this file |
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: 1994 <1994@users.noreply.github.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: Dhruvil Bhatt <bhattdbh@amazon.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: bbartels <benjamin@bartels.dev>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: xuebwang-amd <xuebwang@amd.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: xuebwang-amd <xuebwang@amd.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io> Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.com>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
4 participants
starttag tobuild.inc.md, to form a pair with the bottom tag# --8<-- [end:extra-information]arm.inc.md. Only this file referenced it.cc @hmellor @DarkLight1337 PTAL