[Docs] Reorganize examples docs.#41082
Conversation
55ad71b to
6916a2b
Compare
|
Documentation preview: https://vllm--41082.org.readthedocs.build/en/41082/ |
There was a problem hiding this comment.
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)
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.
4ff894e to
a548fc6
Compare
a548fc6 to
0206d23
Compare
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io>
Signed-off-by: wang.yuqi <yuqi.wang@daocloud.io> Signed-off-by: Libin Tang <libin.tang@intel.com>
Purpose
Following #29362
Reorganize examples docs.
Test Plan
Test Result
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.