From 314bb4e324c9b8a6f7442d5d8f7bb1e82e663160 Mon Sep 17 00:00:00 2001 From: Alicia <115451386+congw729@users.noreply.github.com> Date: Thu, 15 Jan 2026 10:38:27 +0800 Subject: [PATCH] [Doc] Fix mkdocs. (#785) Signed-off-by: Alicia <115451386+congw729@users.noreply.github.com> --- docs/.nav.yml | 2 +- docs/design/architecture_overview.md | 16 ++++++++-------- .../examples/online_serving/gradio_demo.md | 7 ------- ...ompletion_client_for_multimodal_generation.md | 7 ------- mkdocs.yml | 4 ++++ 5 files changed, 13 insertions(+), 23 deletions(-) delete mode 100644 docs/user_guide/examples/online_serving/gradio_demo.md delete mode 100644 docs/user_guide/examples/online_serving/openai_chat_completion_client_for_multimodal_generation.md diff --git a/docs/.nav.yml b/docs/.nav.yml index 911f0fbc9..be9306371 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -3,7 +3,7 @@ nav: - User Guide: - Getting Started: - getting_started/quickstart.md - - getting_started/installation + - getting_started/installation/* - Serving: - OpenAI-Compatible API: - Image Generation: serving/image_generation_api.md diff --git a/docs/design/architecture_overview.md b/docs/design/architecture_overview.md index ea7eff439..16f81ab15 100644 --- a/docs/design/architecture_overview.md +++ b/docs/design/architecture_overview.md @@ -64,13 +64,13 @@ According to analysis for current popular open-source models, most of them have ## Key Components -| Component | Description | -|-----------|-------------| -| **OmniRouter** | provide an intelligent router for Omni-modality requests dispatch | -| **EntryPoints** | define the APIs for offline/online serving (APIServer, Omni/AsyncOmni) and provide the OmniStage abstraction for different AR/DiT stages | -| **AR** | adapted for omni-modality models while inheriting efficient features from vLLM, such as cache management | -| **Diffusion** | natively implemented and optimized using acceleration components | -| **OmniConnector** | supports fully disaggregation based on E/P/D/G (Encoding/Processing/Decoding/Generation) disaggregation across stages | +| Component | Description | +| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **OmniRouter** | provide an intelligent router for Omni-modality requests dispatch | +| **EntryPoints** | define the APIs for offline/online serving (APIServer, Omni/AsyncOmni) and provide the OmniStage abstraction for different AR/DiT stages | +| **AR** | adapted for omni-modality models while inheriting efficient features from vLLM, such as cache management | +| **Diffusion** | natively implemented and optimized using acceleration components | +| **OmniConnector** | supports fully disaggregation based on E/P/D/G (Encoding/Processing/Decoding/Generation) disaggregation across stages | Disaggregated stages are managed through configuration, such as in the Qwen3-Omni example, where stages like Thinker, Talker, and Code2wav are defined as separate OmniStage instances with specific resources and input/output type. @@ -192,4 +192,4 @@ curl -sS -X POST http://localhost:8091/v1/chat/completions \ } ``` -For more usages, please refer to [examples](../user_guide/examples/). +For more usages, please refer to [examples](../examples/README.md). diff --git a/docs/user_guide/examples/online_serving/gradio_demo.md b/docs/user_guide/examples/online_serving/gradio_demo.md deleted file mode 100644 index 38278d9cf..000000000 --- a/docs/user_guide/examples/online_serving/gradio_demo.md +++ /dev/null @@ -1,7 +0,0 @@ -# Gradio Demo - -Source . - -``````py ---8<-- "examples/online_serving/gradio_demo.py" -`````` diff --git a/docs/user_guide/examples/online_serving/openai_chat_completion_client_for_multimodal_generation.md b/docs/user_guide/examples/online_serving/openai_chat_completion_client_for_multimodal_generation.md deleted file mode 100644 index ca3fa8306..000000000 --- a/docs/user_guide/examples/online_serving/openai_chat_completion_client_for_multimodal_generation.md +++ /dev/null @@ -1,7 +0,0 @@ -# OpenAI Chat Completion Client For Multimodal Generation - -Source . - -``````py ---8<-- "examples/online_serving/openai_chat_completion_client_for_multimodal_generation.py" -`````` diff --git a/mkdocs.yml b/mkdocs.yml index 71cfe0305..1e8e38f51 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,6 +60,10 @@ hooks: - docs/mkdocs/hooks/url_schemes.py - docs/mkdocs/hooks/generate_examples.py +# Exclude include files from navigation warnings +exclude_docs: | + **/*.inc.md + # Plugins plugins: - meta