Skip to content

[Docs] Clean up v1/metrics.md #21449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2025
Merged

Conversation

windsonsea
Copy link
Contributor

@windsonsea windsonsea commented Jul 23, 2025

Performed these minor actions:

  • try to improve and fix some grammar issues
  • fix consistency issues on style
  • fix a 1-2-3 list
  • put link text and its url onto a single line, so the color will be changed when you edit it in an IDE

No any meaning changed.

docs/design/v1/metrics.md

@windsonsea windsonsea requested a review from hmellor as a code owner July 23, 2025 10:04
@mergify mergify bot added the documentation Improvements or additions to documentation label Jul 23, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request provides a nice cleanup of the metrics.md design document, improving grammar, style consistency, and link formatting. The changes enhance readability. I've identified one issue with markdown formatting where paragraphs under list items are indented with 4 spaces, which would incorrectly render them as code blocks. I've suggested changing this to a 2-space indent to ensure correct rendering as paragraphs.

Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

Thank you for this cleanup!

Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@vllm-bot vllm-bot merged commit 2cc5016 into vllm-project:main Jul 23, 2025
7 of 9 checks passed
zixi-qi pushed a commit to zixi-qi/vllm that referenced this pull request Jul 23, 2025
LyrisZhong pushed a commit to LyrisZhong/vllm that referenced this pull request Jul 23, 2025
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
wenscarl pushed a commit to wenscarl/vllm that referenced this pull request Aug 4, 2025
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
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 force-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants