docs: align public surface with shipped interfaces - #346
docs: align public surface with shipped interfaces#346localai-org-maint-bot wants to merge 3 commits into
Conversation
FOLLOWING_AGENTS_PROTOCOL Following-Agents-Protocol: true AI-Assisted: true Assisted-by: Codex:gpt-5 [Codex]
FOLLOWING_AGENTS_PROTOCOL Following-Agents-Protocol: true AI-Assisted: true Assisted-by: Codex:gpt-5 [Codex]
FOLLOWING_AGENTS_PROTOCOL Following-Agents-Protocol: true AI-Assisted: true Assisted-by: Codex:gpt-5 [Codex]
|
This branch conflicts with git fetch origin main && git merge origin/mainThen, per conflicted file:
Anything under Sorry for the churn — removing a shared surface makes every in-flight branch pay once. After this merge your PR stops competing with other PRs for these files entirely, which is the point. |
|
Closing: this PR has itself drifted, and landing it would swap one wrong number for another. Its whole value is "the public docs state the right figures", and it is 258 commits behind. Measured against current
I tried to refresh the figures in place rather than close it, and stopped because they cannot be re-derived mechanically: a raw grep finds 69 Issue #342 stays open and is larger than this PR captured. On current Re-cutting against current main now, deriving each count from its own checker rather than carrying any figure forward. The structural work here — the spec and the README restructure — is good and will be reused rather than discarded. |
…ts (#342) Re-cut of #342 against current main after #346 was closed as itself drifted: that PR's whole value was "the numbers are right", and 258 commits on it claimed 35 architectures where the gate proves 37. Verified every #342 claim against source instead of carrying any forward, and most are already fixed. The ABI wording (v10/19 exports) is gone; README states v17 and 35 functions, matching VLLM_ABI_VERSION and the 35 VLLM_API declarations. The 28/30 architecture counts are gone; README says 37 and check-supported-models proves 37. The 31/35/37 "inconsistency" is not one -- they are three different quantities and FEATURES.md already explains the relationship. I had reported those as contradictory earlier in the session and that was wrong; it came from reading fragments out of a `grep -oE` rather than the lines they came from. What actually lands: docs/USAGE.md's endpoint table gains /v1/embeddings and /v1/audio/transcriptions, both registered in api_server.cpp and both TASK-CONDITIONAL -- embeddings only with an embedder attached (:1035), transcription only with a transcriber (:1049). The rows say so, because a reader who saw a bare row and got a 404 would reasonably conclude the docs were wrong rather than that the route is gated on the loaded model. #342 STAYS OPEN for the one claim that is still false and could not be fixed here: README invokes build/examples/server while the target sets OUTPUT_NAME vllm-server, so the quickstart fails for anyone who copies it. check-doc-checkpoint refuses a README edit unless a landing source moves with it, and its landing-source set contains examples/server/main.cpp and the top-level CMakeLists.txt but NOT examples/CMakeLists.txt -- the file that defines the binary name the README documents. Correcting it therefore needs either an unrelated file touched to satisfy the gate, or a change to the gate's landing-source set, and the latter is a checker-semantics change owing its own spec and red-before evidence. Left open rather than worked around. Gate: scripts/agent-preflight.sh rc=0, plus the issue's own acceptance list -- check-readme-structure, check-public-doc-tables, check-supported-models, check-surface-coverage and check-env-doc all OK. FOLLOWING_AGENTS_PROTOCOL Following-Agents-Protocol: true AI-Assisted: true Assisted-by: AGENT:claude-opus-5 [Claude Code]
Summary
vllm-serverbinaryunslothrevision890bdef7, while keeping NVIDIA ModelOpt 27B and current 35B gaps visibleCloses #342.
Source anchors
examples/CMakeLists.txt: targetserverhasOUTPUT_NAME vllm-serverinclude/vllm.h:VLLM_ABI_VERSION 17and the v11-v17 additionssrc/vllm/entrypoints/openai/api_server.cpp: conditional embeddings/transcription route registrationdocs/FEATURES.mdplusscripts/check-supported-models.py: 35 registered architectures and the gated distinctionsdocs/BENCHMARKS.md: passingunsloth@890bdef7grid vs speed-pending ModelOpt/current 35B gridsVerification
Passed on immutable head
e91fb3fa372bbf38c645252af7f57b83bd77b4da:python3 scripts/check-readme-structure.pypython3 scripts/check-public-doc-tables.pypython3 scripts/check-supported-models.pypython3 scripts/check-surface-coverage.pypython3 scripts/check-doc-checkpoint.py --base 5812b8b6 --head HEADgit diff 5812b8b6..HEAD --checkThe box has no CMake executable, so the CPU configure/build and
vllm-server --helpexecution from the spike could not run; no installation or download was attempted. The binary name is instead verified directly from CMake'sOUTPUT_NAMEand its registeredtest_server_helpcommand. Repository-wide readiness also retains two unchanged baseline failures: CMake-dependentcheck-test-registration, and unrelatedaudit-live-rowsdebt.