Skip to content

[Doc] Remove duplicate TOCs during MkDocs migration #19021

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 2 commits into from
Jun 3, 2025

Conversation

Zerohertz
Copy link
Contributor

@Zerohertz Zerohertz commented Jun 2, 2025

This PR removes duplicate table of contents (TOCs) from documentation files as part of the migration to MkDocs.
MkDocs automatically generates navigation and TOCs, making manually written TOCs redundant and potentially conflicting.

  • /cli/index.html
    Screenshot 2025-06-03 at 12 12 31 AM
  • /deployment/nginx.html
    Screenshot 2025-06-03 at 12 13 35 AM
Original Contents

This pull request makes a small correction to the docs/cli/README.md file.

  • Fixing indent for table of contents.
  • Fixing hyperlink for the serve section to use an underscore instead of a hyphen for consistency.

[!NOTE]

  • Left: current docs page
  • Right: fixed docs page
    tmp

Signed-off-by: Zerohertz <ohg3417@gmail.com>
@Zerohertz Zerohertz requested a review from hmellor as a code owner June 2, 2025 13:22
Copy link

github-actions bot commented Jun 2, 2025

👋 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.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 2, 2025
@Zerohertz Zerohertz closed this Jun 2, 2025
@Zerohertz Zerohertz deleted the docs/cli branch June 2, 2025 13:28
@Zerohertz Zerohertz restored the docs/cli branch June 2, 2025 13:29
@Zerohertz Zerohertz reopened this Jun 2, 2025
@hmellor
Copy link
Member

hmellor commented Jun 2, 2025

Is it necessary to have a table of contents here at all? It just manually duplicates what is on the right:

image

@Zerohertz
Copy link
Contributor Author

I think you're right. Would it be better to create a separate branch and submit a PR that removes the table of contents more comprehensively?

@Zerohertz
Copy link
Contributor Author

Additionally, since the migration to MkDocs, I've found that unordered lists (-) with 2 or 3 space indentation are not rendering properly across many documents.
It would be beneficial to apply a consistent formatting fix for this issue throughout the documentation.

@hmellor
Copy link
Member

hmellor commented Jun 2, 2025

I think you're right. Would it be better to create a separate branch and submit a PR that removes the table of contents more comprehensively?

You can do it in this branch, whatever's easiest.

Additionally, since the migration to MkDocs, I've found that unordered lists (-) with 2 or 3 space indentation are not rendering properly across many documents.

This is meant to be enforced by

plugins.md007.indent = 4 # ul-indent
but clearly something isn't working properly

@Zerohertz
Copy link
Contributor Author

Then I'll modify the current PR to remove all TOCs.

Additionally, it would be better if we could delete that line from pymarkdown and find a setting in MkDocs that can recognize indentation with existing spaces as well.

@Zerohertz Zerohertz changed the title [Doc] Fix table of contents of vllm cli guide [Doc] Remove duplicate TOCs during MkDocs migration Jun 2, 2025
@hmellor
Copy link
Member

hmellor commented Jun 2, 2025

We should still enforce something standard, but yeah it'd be good if the MkDocs config could be more flexible for cases like this

Signed-off-by: Zerohertz <ohg3417@gmail.com>
@Zerohertz
Copy link
Contributor Author

I have removed all duplicate TOCs. (See the revised content)

@hmellor hmellor enabled auto-merge (squash) June 2, 2025 17:18
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 2, 2025
@simon-mo simon-mo disabled auto-merge June 3, 2025 02:47
@simon-mo simon-mo enabled auto-merge (squash) June 3, 2025 02:47
@simon-mo simon-mo merged commit 5bc1ad6 into vllm-project:main Jun 3, 2025
53 checks passed
@Zerohertz Zerohertz deleted the docs/cli branch June 3, 2025 03:34
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 ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants