Skip to content

Conversation

@sjhddh
Copy link
Contributor

@sjhddh sjhddh commented Jan 23, 2026

Summary

  • Fix incorrect include path in the CPU installation documentation
  • The "Build image from source" section for Apple silicon was referencing cpu.arm.inc.md instead of cpu.apple.inc.md

Test Plan

  • Build the documentation locally with mkdocs build or mkdocs serve
  • Verify the Apple silicon section renders correctly without include errors

Risk

  • Very low risk: documentation-only change
  • Rollback: simple revert if needed

@github-actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors.

You ask your reviewers to trigger select CI tests on top of fastcheck CI.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

🚀

@mergify
Copy link

mergify bot commented Jan 23, 2026

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

@mergify mergify bot added documentation Improvements or additions to documentation cpu Related to CPU backends labels Jan 23, 2026
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 correctly fixes an include path in the CPU installation documentation for Apple silicon. By pointing to cpu.apple.inc.md instead of cpu.arm.inc.md, it ensures that the correct content is displayed for users on Apple silicon. This is a good documentation fix that improves accuracy. The change is correct and ready to be merged.

The "Build image from source" section for Apple silicon was incorrectly
referencing `cpu.arm.inc.md` instead of `cpu.apple.inc.md`. This fix
ensures the correct platform-specific instructions are included.

Signed-off-by: 7. Sun <jhao.sun@gmail.com>
@sjhddh sjhddh force-pushed the fix/docs-cpu-apple-include branch from 74deddb to a8a597d Compare January 23, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cpu Related to CPU backends documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant