[doc] add mkdocs doc#18930
Conversation
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
👋 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 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 🚀 |
|
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>
|
sorry, miss that part, thanks for your remind. |
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
hmellor
left a comment
There was a problem hiding this comment.
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+) |
There was a problem hiding this comment.
Could use an admonition here
| > **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:: |
There was a problem hiding this comment.
| Confirm that MkDocs is correctly installed:: | |
| Confirm that MkDocs is correctly installed: |
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: amit <amit.man@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: amit <amit.man@gmail.com>
Uh oh!
There was an error while loading. Please reload this page.