Public docs drift from shipped CLI, ABI v17, endpoints, registry counts, and benchmark scope
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 423
- Forks
- 53
- Avg merge
- 20h 26m
- Merged PRs (30d)
- 310
Description
Problem
The user-facing README and usage guide disagree with current source and current keyed public records:
README.mdinvokesbuild/examples/server, but the CMake target outputsbuild/examples/vllm-server.- README and
docs/USAGE.mddescribe ABI v10 with 19 exports, whileinclude/vllm.hdeclares ABI v17 and the current public surface. docs/USAGE.mdomits the conditional/v1/embeddingsand/v1/audio/transcriptionsroutes implemented inapi_server.cpp.- README says 25+, 28, and 30 architectures in different places, while the registry-bound
docs/FEATURES.mdchecker proves 35 registered and 27 gated. - README says every architecture is token-gated, although registered scaffold/oracle-blocked rows are explicitly documented.
- README's global throughput language conflates the passing
unsloth@890bdef727B grid with the current NVIDIA ModelOpt 27B and 35B grids that remain speed-pending.
Scope
Create one source-grounded documentation repair:
- Correct the quickstart/server executable path.
- Update ABI wording and the ABI evolution table through v17 from
include/vllm.h. - Add the shipped conditional embedding and transcription endpoints to
docs/USAGE.md. - Make README registry counts and gate wording agree with
docs/FEATURES.md. - Scope throughput claims to the exact checkpoint and keep current ModelOpt/35B gaps honest.
- Apply a human-language pass without adding new claims or benchmark numbers.
Do not compact docs/STATUS.md or docs/BENCHMARKS.md in this issue. Do not change code, checker semantics, lifecycle state, or accepted benchmark values.
CPU-only acceptance
python3 scripts/check-readme-structure.pypython3 scripts/check-public-doc-tables.pypython3 scripts/check-supported-models.pypython3 scripts/check-surface-coverage.py- Configure/build the CPU examples and prove
build/examples/vllm-server --help. - Stale-string scan finds no old ABI/count/path claims.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md and docs/USAGE.md, then verify ABI declarations in include/vllm.h, routes in api_server.cpp, and registry counts and gate wording in docs/FEATURES.md. Run the four listed Python checkers before configuring CPU examples and testing build/examples/vllm-server --help. Done means all checks pass and stale ABI, count, and path claims are absent without changing code, checker semantics, lifecycle state, or benchmark values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp, python
- Domain
- api, build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100