Repository navigation
[Doc] Fix markdownlint findings in the serving API reference - #7111
Conversation
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]>
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
|
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
left a comment
There was a problem hiding this comment.
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.
|
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 |
…oject#7111) Signed-off-by: Max Freedom Pollard <[email protected]> Signed-off-by: ZhengWG <[email protected]>
…oject#7111) Signed-off-by: Max Freedom Pollard <[email protected]>
Purpose
docs/serving/is the API reference for the OpenAI-compatible endpoints, and six of its fourteen pages fail themarkdownlint-cli2gate 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 labelledtext, the tag these pages already use.git diff --ignore-all-space --ignore-blank-linesshows 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.md35,video_stream_api.md28,videos_api.md23,image_edit_api.md20,image_generation_api.md19,streaming_video_output_api.md6). After: none. The other eight pages indocs/serving/already pass and are untouched.