Skip to content

docs: NVIDIA style guide pass on vLLM model-server docs#1455

Merged
lbliii merged 1 commit into
martas/1106from
martas/1106-style-guide
May 29, 2026
Merged

docs: NVIDIA style guide pass on vLLM model-server docs#1455
lbliii merged 1 commit into
martas/1106from
martas/1106-style-guide

Conversation

@lbliii
Copy link
Copy Markdown
Contributor

@lbliii lbliii commented May 29, 2026

Style-guide-only cleanup stacked on top of #1430. No content or meaning changes — this is purely an NVIDIA style-guide pass over the docs that #1430 introduces.

Fixes

File Fix
local-vllm.mdx e.g. → "for example" (×2); on/off slash → "on or off"; you've → "you have"
local-vllm-proxy.mdx typo extising → "existing"; disabled in through → "disabled through"; etc. → "and so on"
vllm.mdx you'd → "you would" (in the new <Note>)
responses_api_models/vllm_model/README.md removed exclamation mark

Scope notes

  • Scoped to content docs: describe local_vllm_model and extend docs for vllm_model #1430 adds/changes. Pre-existing violations in vllm.mdx (the Please…! line, HuggingFace spelling, bare [here] links) are out of scope for a style check of this PR.
  • Left heading-case and see → refer to untouched — both are inconsistent repo-wide, so changing only these pages would worsen consistency.

Targets martas/1106 so it merges into #1430 before that PR lands on main.

🤖 Generated with Claude Code

Style-guide-only cleanup on top of #1430. No content changes:

- Replace Latinisms (e.g., etc.) with plain English
- Remove contractions in technical prose (you'd, you've)
- Drop exclamation mark from vllm_model README
- Fix typos: "extising" -> "existing", "disabled in through" -> "disabled through"

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii lbliii merged commit af14561 into martas/1106 May 29, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant