Skip to content

[doc] add mkdocs doc#18930

Merged
DarkLight1337 merged 4 commits intovllm-project:mainfrom
reidliu41:add-mkdocs-doc
May 30, 2025
Merged

[doc] add mkdocs doc#18930
DarkLight1337 merged 4 commits intovllm-project:mainfrom
reidliu41:add-mkdocs-doc

Conversation

@reidliu41
Copy link
Copy Markdown
Contributor

@reidliu41 reidliu41 commented May 30, 2025

  • add mkdocs doc for helping setup mkdocs env

Signed-off-by: reidliu41 <reid201711@gmail.com>
@reidliu41 reidliu41 requested a review from hmellor as a code owner May 30, 2025 01:31
@github-actions
Copy link
Copy Markdown

👋 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 can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

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.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label May 30, 2025
@DarkLight1337
Copy link
Copy Markdown
Member

I think it's better to simply expand the docs in https://docs.vllm.ai/en/latest/contributing/index.html#building-the-docs

Signed-off-by: reidliu41 <reid201711@gmail.com>
@reidliu41
Copy link
Copy Markdown
Contributor Author

sorry, miss that part, thanks for your remind.

Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) May 30, 2025 06:06
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label May 30, 2025
@DarkLight1337 DarkLight1337 merged commit 8f8900c into vllm-project:main May 30, 2025
40 of 42 checks passed
Copy link
Copy Markdown
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! A couple of comments that could be actioned in a follow up

```

Start the autoreloading MkDocs server:
> **Note:** Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could use an admonition here

Suggested change
> **Note:** Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+)
!!! note
Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+)


#### Verify Installation

Confirm that MkDocs is correctly installed::
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Confirm that MkDocs is correctly installed::
Confirm that MkDocs is correctly installed:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, updated in #18996

amitm02 pushed a commit to amitm02/vllm that referenced this pull request Jun 1, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: amit <amit.man@gmail.com>
amitm02 pushed a commit to amitm02/vllm that referenced this pull request Jun 1, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: amit <amit.man@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants