Skip to content

[Docs] Reorganize examples docs.#41082

Merged
noooop merged 7 commits intovllm-project:mainfrom
noooop:reorganize_examples_docs
May 8, 2026
Merged

[Docs] Reorganize examples docs.#41082
noooop merged 7 commits intovllm-project:mainfrom
noooop:reorganize_examples_docs

Conversation

@noooop
Copy link
Copy Markdown
Collaborator

@noooop noooop commented Apr 28, 2026

Purpose

Following #29362

Reorganize examples docs.

Test Plan

Test Result


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
@noooop noooop force-pushed the reorganize_examples_docs branch from 55ad71b to 6916a2b Compare April 28, 2026 02:51
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Apr 28, 2026

Documentation preview: https://vllm--41082.org.readthedocs.build/en/41082/

@mergify mergify Bot added the documentation Improvements or additions to documentation label Apr 28, 2026
Copy link
Copy Markdown
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 removes the categorized list of example links from the main examples README, leaving the document essentially empty. Feedback indicates that this change significantly hinders discoverability and suggests that any reorganization should maintain navigation links to ensure the documentation remains useful.

I am having trouble creating individual review comments. Click here to see my feedback.

docs/examples/README.md (3-7)

high

Removing the list of example categories makes it very difficult for users to discover the available examples. This change leaves the main examples page almost empty, which can be confusing.

If the intention is to move this index to another location as part of the reorganization, that change should be included in this pull request to ensure the documentation remains navigable.

@noooop noooop force-pushed the reorganize_examples_docs branch from 4ff894e to a548fc6 Compare May 7, 2026 03:25
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
@noooop noooop force-pushed the reorganize_examples_docs branch from a548fc6 to 0206d23 Compare May 8, 2026 02:50
noooop added 2 commits May 8, 2026 10:50
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
@noooop noooop marked this pull request as ready for review May 8, 2026 03:03
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@noooop noooop requested a review from DarkLight1337 May 8, 2026 03:03
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
@noooop noooop enabled auto-merge (squash) May 8, 2026 03:21
@github-actions github-actions Bot added the ready ONLY add when PR is ready to merge/full CI is needed label May 8, 2026
@noooop noooop merged commit 77b13b9 into vllm-project:main May 8, 2026
8 checks passed
@noooop noooop deleted the reorganize_examples_docs branch May 8, 2026 06:25
libinta pushed a commit to libinta/vllm that referenced this pull request May 8, 2026
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
Signed-off-by: Libin Tang <libin.tang@intel.com>
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.

2 participants