Skip to content

[Doc] Sync#1216

Open
congw729 wants to merge 2 commits intovllm-project:mainfrom
congw729:doc/sync
Open

[Doc] Sync#1216
congw729 wants to merge 2 commits intovllm-project:mainfrom
congw729:doc/sync

Conversation

@congw729
Copy link
Contributor

@congw729 congw729 commented Feb 5, 2026

PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.

Purpose

Sync doc with examples readme. Those additions are auto-generated by mkdocs serve.

Test Plan

mkdocs serve

Test Result

image
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.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft.

BEFORE SUBMITTING, PLEASE READ https://github.com/vllm-project/vllm-omni/blob/main/CONTRIBUTING.md (anything written below this line will be removed by GitHub Actions)

@congw729
Copy link
Contributor Author

congw729 commented Feb 5, 2026

@hsliuustc0106 Those editions are auto-generated by mkdocs serve. We also need to clarify that PR who change the README under examples need to run mkdocs serve to sync those editions.

@hsliuustc0106
Copy link
Collaborator

@hsliuustc0106 Those editions are auto-generated by mkdocs serve. We also need to clarify that PR who change the README under examples need to run mkdocs serve to sync those editions.

where can we send these messages to developers?

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR synchronizes the documentation navigation and content with the example README files. The changes were auto-generated using mkdocs serve to ensure consistency between the documentation site and the source README files in the examples directory.

Changes:

  • Updated navigation titles in .nav.yml to match the actual H1 titles in markdown files
  • Simplified the Qwen3-TTS title from "Qwen3-TTS Online Serving" to "Qwen3-TTS" for consistency
  • Added a note about VAE slicing and tiling options for memory-constrained environments in the Image-To-Image documentation

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/user_guide/examples/online_serving/qwen3_tts.md Updated H1 title from "Qwen3-TTS Online Serving" to "Qwen3-TTS" to match the source README
docs/user_guide/examples/online_serving/image_to_image.md Added note about VAE memory optimization flags synced from the source README
docs/.nav.yml Updated navigation entries to match the actual markdown file titles for consistency

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Alicia <115451386+congw729@users.noreply.github.com>
Signed-off-by: Alicia <115451386+congw729@users.noreply.github.com>
@congw729
Copy link
Contributor Author

congw729 commented Feb 6, 2026

@hsliuustc0106 Those editions are auto-generated by mkdocs serve. We also need to clarify that PR who change the README under examples need to run mkdocs serve to sync those editions.

where can we send these messages to developers?

I just added a message to the PR template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants