Skip to content

[Doc] Fix markdownlint findings in the serving API reference - #7111

Merged
hsliuustc0106 merged 1 commit into
vllm-project:mainfrom
MaxFreedomPollard:docs-serving-markdownlint
Sep 6, 2026
Merged

hsliuustc0106 merged 1 commit into
vllm-project:mainfrom
MaxFreedomPollard:docs-serving-markdownlint

Conversation

@MaxFreedomPollard

Copy link
Copy Markdown
Contributor

Purpose

docs/serving/ is the API reference for the OpenAI-compatible endpoints, and six of its fourteen pages fail the markdownlint-cli2 gate added in #6273. GitHub Actions skips that hook while the backlog is cleaned up, but it runs locally on every commit that touches these files, so anyone editing one of these pages today first has to clear unrelated findings. This clears all 131 findings in the directory: 122 table pipes without the surrounding space the compact style asks for, four runs of consecutive blank lines, two lists without a surrounding blank line, and three endpoint fences with no language, now labelled text, the tag these pages already use. git diff --ignore-all-space --ignore-blank-lines shows only those three labels and two table delimiter rows re-spaced to the compact style; everything else is whitespace.

Test Plan

npx [email protected] "docs/serving/*.md" with the repository's .markdownlint.yaml, the version the pre-commit hook pins.

vLLM Version: not applicable, documentation only.

vLLM-Omni Commit: 44d3ae1, main at the time of the change.

Test Result

Before: 131 findings across six files (audio_generate_api.md 35, video_stream_api.md 28, videos_api.md 23, image_edit_api.md 20, image_generation_api.md 19, streaming_video_output_api.md 6). After: none. The other eight pages in docs/serving/ already pass and are untouched.

Six of the fourteen pages under docs/serving/ fail the markdownlint-cli2
gate added in #6273, which GitHub Actions skips while the backlog is
cleaned up but which runs locally on every commit touching these files.
Clear all 131 findings in the directory: table pipes without the
surrounding space of the compact style, runs of blank lines, lists
without a surrounding blank line, and three endpoint fences with no
language, now labelled `text` as the other fences in these pages are.
Whitespace only, apart from those labels.

Signed-off-by: Max Freedom Pollard <[email protected]>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@vllm-omni-review-bot

Copy link
Copy Markdown

This PR was classified as CI work.

CI owner: @yenuo26

@MaxFreedomPollard, please review your own changes and leave a short self-review comment describing what you checked. PRs without author self-review may not be assigned a reviewer.

Please take a look when you have a chance. If you would like an automated review, mention @vllm-omni-review-bot in a comment.

@hsliuustc0106 hsliuustc0106 added high priority high priority issue, needs to be done asap documentation Improvements or additions to documentation labels Sep 5, 2026

@hsliuustc0106 hsliuustc0106 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified with the pre-commit-pinned [email protected] and the repo's .markdownlint.yaml: base six pages reproduce exactly the claimed 131 findings, head pages lint clean, and all fourteen docs/serving/ pages at head are clean. The --ignore-all-space diff matches the body (three text labels plus the two delimiter rows with dash counts aligned to header widths), and the ReadTheDocs build confirms no rendering regression. Nice, exactly-as-described cleanup.

@MaxFreedomPollard

Copy link
Copy Markdown
Contributor Author

Self-review: ran the pre-commit-pinned [email protected] with the repo's .markdownlint.yaml on the six pages before and after (131 findings to 0, and all fourteen docs/serving pages clean at head), and checked that git diff --ignore-all-space --ignore-blank-lines shows only the three text fence labels and the two table delimiter rows. No rendered content changes.

@hsliuustc0106
hsliuustc0106 merged commit 946b843 into vllm-project:main Sep 6, 2026
3 checks passed
ZhengWG pushed a commit to ZhengWG/vllm-omni that referenced this pull request Sep 8, 2026
khairulkabir1661 pushed a commit to khairulkabir1661/vllm-omni that referenced this pull request Sep 25, 2026
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 high priority high priority issue, needs to be done asap

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants