Add template page for the docs (#170)

* Add template page for the docs * Fix a typo in the requirements-docs.txt
vllm-project · Sep 12, 2024 · d579a5e · d579a5e
1 parent 78ea085
commit d579a5e
Show file tree

Hide file tree

Showing 16 changed files with 108 additions and 50 deletions.
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
@@ -4,5 +4,5 @@ sphinx-click==6.0.0
 sphinx-copybutton==0.5.2
 sphinx-togglebutton==0.3.2
 sphinxemoji==0.3.1
-sphinx-autodoc-typehints-2.4.1==2.4.1
+sphinx-autodoc-typehints==2.4.1
 sphinx_design==0.6.1
diff --git a/docs/source/aibrix_icon.png → ...source/assets/logos/aibrix-logo-light.png b/docs/source/aibrix_icon.png → ...source/assets/logos/aibrix-logo-light.png
diff --git a/docs/source/community/community.rst b/docs/source/community/community.rst
@@ -0,0 +1,7 @@
+.. _community:
+
+=========
+Community
+=========
+
+TODO
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -42,7 +42,7 @@
 
 html_title = project
 html_theme = 'sphinx_book_theme'
-html_logo = 'aibrix_icon.png'
+html_logo = 'assets/logos/aibrix-logo-light.png'
 html_static_path = ['_static']
 html_theme_options = {
     # repository level setting
@@ -57,8 +57,8 @@
 
 
     # navigation and sidebar
-    'show_toc_level': 1,
-    'announcement': 'This is still in private mode',
+    'show_toc_level': 2,
+    'announcement': None,
     'secondary_sidebar_items': [
         'page-toc',
     ],

diff --git a/docs/source/designs/architecture.rst b/docs/source/designs/architecture.rst
@@ -0,0 +1,7 @@
+.. _architecture:
+
+====================
+Overall Architecture
+====================
+
+TODO
diff --git a/docs/source/development/contribution.rst b/docs/source/development/contribution.rst
@@ -0,0 +1,7 @@
+.. _contribution:
+
+============
+Contribution
+============
+
+TODO
diff --git a/docs/source/features/autoscaling.rst b/docs/source/features/autoscaling.rst
@@ -0,0 +1,7 @@
+.. _autoscaling:
+
+===========
+Autoscaling
+===========
+
+TODO
diff --git a/docs/source/features/gateway-plugins.rst b/docs/source/features/gateway-plugins.rst
@@ -0,0 +1,7 @@
+.. _gateway:
+
+===============
+Gateway Routing
+===============
+
+TODO
diff --git a/docs/source/features/lora-dynamic-loading.rst b/docs/source/features/lora-dynamic-loading.rst
@@ -0,0 +1,7 @@
+.. _lora:
+
+====================
+Lora Dynamic Loading
+====================
+
+TODO
diff --git a/docs/source/features/multi-node-inference.rst b/docs/source/features/multi-node-inference.rst
@@ -0,0 +1,7 @@
+.. _distributed_inference:
+
+====================
+Multi-Node Inference
+====================
+
+TODO
diff --git a/docs/source/features/runtime.rst b/docs/source/features/runtime.rst
@@ -0,0 +1,7 @@
+.. _ai_runtime:
+
+==========
+AI Runtime
+==========
+
+TODO
diff --git a/docs/source/getstarted/quickstart.rst b/docs/source/getstarted/quickstart.rst
diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst
@@ -0,0 +1,7 @@
+.. _installation:
+
+============
+Installation
+============
+
+This section contains how to install the packages.
diff --git a/docs/source/getting_started/quickstart.rst b/docs/source/getting_started/quickstart.rst
@@ -0,0 +1,7 @@
+.. _quickstart:
+
+==========
+Quickstart
+==========
+
+This section contains how to do a quickstart.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,57 +1,57 @@
-.. AIBrix documentation master file, created by
-   sphinx-quickstart on Thu Aug  8 15:07:35 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to AIBrix
 =================
 
-.. image:: aibrix_icon.png 
-  :width: 400
-  :alt: Alternative text
-
-AIBrix is a high-performant and easy-to-use library for LLM inference. 
-
-AIBrix is high-performant at
+.. image:: ./assets/logos/aibrix-logo-light.png
+  :width: 60%
+  :align: center
+  :alt: AIBrix
 
-* This is a bulleted list.
-* It has two items, the second
-  item uses two lines.
+AIBrix is the foundational building blocks for constructing your own GenAI inference infrastructure.
+AIBrix offers a cloud-native solution tailored to meet the demands of enterprises aiming to deploy, manage, and scale LLMs efficiently.
 
+Key features:
 
-AIBrix is easy-to-use with
+* High density Lora management
+* Intelligent and LLM specific routing strategies
+* LLM tailored pod autoscaler
+* AI runtime sidecar (metrics merge, fast model downloading, admin operations)
 
-1. This is a numbered list.
-2. It has two items too.
-#. This is a numbered list.
-#. It has two items too.
 
 Documentation
 =============
 
-Get Started
------------
-
 .. toctree::
-   :caption: Chapter 1
-   :titlesonly:
-
-
-   getstarted/quickstart
-
+   :maxdepth: 1
+   :caption: Getting Started
 
+   getting_started/quickstart.rst
+   getting_started/installation.rst
 
 
 .. toctree::
-   :caption: Chapter 2
-   :titlesonly:
+   :maxdepth: 1
+   :caption: Core Concepts
 
-   serving/installation
-   External Link <https://www.sphinx-doc.org>
+   designs/architecture.rst
 
+.. toctree::
+   :maxdepth: 1
+   :caption: User Manuals
 
+   features/autoscaling.rst
+   features/lora-dynamic-loading.rst
+   features/gateway-plugins.rst
+   features/multi-node-inference.rst
+   features/runtime.rst
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development
 
+   development/contribution.rst
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Community
 
-This is an example of a simple Sphinx project using the Sphinx Book Theme.
+   community/community.rst
diff --git a/docs/source/serving/installation.rst b/docs/source/serving/installation.rst