Doc: Use shell code-blocks and fix section headers
Follow up to https://github.com/vllm-project/vllm/pull/9132, https://github.com/vllm-project/vllm/pull/9256
- Fixing some wording and formatting
- Using
consoleinstead ofshellin code-blocks as listed here.
👋 Hi! Thank you for contributing to the vLLM project.
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 do one of these:
- Add
readylabel to the PR - Enable auto-merge.
🚀
Using console instead of shell in code-blocks as listed here.
Actually, I think bash is what you're looking for. console is intended to be used for terminal sections, and thus commands should be prefixed by the user/cwd, e.g. user@abc:~/vllm$
Using console instead of shell in code-blocks as listed here.
Actually, I think
bashis what you're looking for.consoleis intended to be used for terminal sections, and thus commands should be prefixed by the user/cwd, e.g.user@abc:~/vllm$
That's true @DarkLight1337, although in this case these commands are meant to be run in terminal, so I updated the commands to include a prompt symbol $ similar to how they're shown here