Skip to content

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Sep 17, 2025

  • Add the ability to skip API ref when building the docs locally to make it faster with API_AUTONAV_EXCLUDE=vllm (useful if you don't need the API ref for what you're doing)
  • Fix a sentence in /docs/getting_started/installation/python_env_setup.inc.md
  • Restructure the contributing README into the following structure to better match the order a new contributor is likely to need to know the information:
...

## Developing

Clone repo and editable install

### Linting

How to set up pre-commit

### Documentation

How to build the docs

### Testing

How to run the tests

...

@mergify mergify bot added the documentation Improvements or additions to documentation label Sep 17, 2025
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 significantly improves the contributor documentation by restructuring the contributing/README.md for better clarity and logical flow. It also introduces a useful feature to speed up local documentation builds by allowing the exclusion of API reference generation. The changes are well-thought-out and enhance the developer experience. I've found one area in the testing instructions that could be clarified to prevent confusion for new contributors.

Signed-off-by: Harry Mellor <[email protected]>
@punitvara
Copy link
Contributor

Yes contributing README looks much better and helpful now. If you want you can specifically mention steps before raising new PR. From setting up virtual env, run pre-commit to running any other pytest etc.

@vllm-bot vllm-bot merged commit 32baf1d into vllm-project:main Sep 18, 2025
14 checks passed
@hmellor hmellor deleted the docs-contributing branch September 18, 2025 05:58
845473182 pushed a commit to dsxsteven/vllm_splitPR that referenced this pull request Sep 18, 2025
…litPR into model_register

* 'model_register' of https://github.com/dsxsteven/vllm_splitPR: (138 commits)
  Retrieve `sliding_window` from text config in Gemma3 MM (vllm-project#25085)
  [Docs] Fix API Reference (vllm-project#25140)
  [Kernel] Better inf handling for grouped topk cu (vllm-project#24886)
  [CLI] Use streaming in CLI chat and completion commands (vllm-project#23769)
  [benchmark] add peak throughput metrics and plot (vllm-project#23867)
  [Spec Decode] Efficient padded speculation (vllm-project#24539)
  [V0 Deprecation] Remove more V0 tests (vllm-project#25117)
  [EPLB] Add EPLB support for hunyuan_v1 (vllm-project#23078)
  [XPU] Whisper model support on XPU Platform (vllm-project#25123)
  Mark prompt logprobs as incompatible with prompt embeds at API level (vllm-project#25077)
  [Model] enable data parallel for InternVL vision encoder (vllm-project#23909)
  [Kernels] Overlap shared experts with combine instead of dispatch (vllm-project#24254)
  [Bugfix][Qwen3-Next] add prefixes to shared_expert in qwen3-next and mlp in qwen2moe to successfully load ignored params in quantized models (vllm-project#24960)
  [Core][MM] Cleanup `MultiModalCache` (vllm-project#25006)
  [Docs] Clean up the contributing README (vllm-project#25099)
  [MM Encoder] Apply DP ViT for Qwen3-VL model series (vllm-project#24955)
  [Kernels] Enable DeepGEMM by default (vllm-project#24462)
  [V0 Deprecation] Skip PP test (vllm-project#25128)
  [V0 Deprecation] Remove misc V0 tests (vllm-project#25118)
  [V0 Deprecation] Remove V0 Tracing & Metrics tests (vllm-project#25115)
  ...
debroy-rh pushed a commit to debroy-rh/vllm that referenced this pull request Sep 19, 2025
FeiDaLI pushed a commit to FeiDaLI/vllm that referenced this pull request Sep 25, 2025
charlifu pushed a commit to ROCm/vllm that referenced this pull request Sep 25, 2025
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 10, 2025
choprahetarth pushed a commit to Tandemn-Labs/vllm that referenced this pull request Oct 11, 2025
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants