docs: add getting started

.readthedocs.yaml

@@ -11,10 +11,12 @@ build:
   tools:
     python: "3.11"
 
-mkdocs:
+sphinx:
-  configuration: mkdocs.yml
+   configuration: docs/conf.py
 
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
    - requirements: docs/requirements.txt
+   - method: pip
+     path: .

docs/getting_started/concepts.md

@@ -0,0 +1,3 @@
+# Concepts
+
+

docs/getting_started/getting_started.md

@@ -0,0 +1,7 @@
+# Quickstart Guide
+
+This tutorial gives you a quick walkthrough about use DB-GPT with you environment and data.
+
+## Installation
+
+To get started, install DB-GPT with the following command.

docs/getting_started/tutorials.md

@@ -0,0 +1,6 @@
+# Tutorials
+-------------
+
+This is a collection of DB-GPT tutorials on Medium.  
+
+Comming soon...

docs/index.rst

@@ -3,18 +3,50 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to DB-GPT's documentation!
+Welcome to DB-GPT!
 ==================================
+| As large models are released and iterated upon, they are becoming increasingly intelligent. However, in the process of using large models, we face significant challenges in data security and privacy. We need to ensure that our sensitive data and environments remain completely controlled and avoid any data privacy leaks or security risks. Based on this, we have launched the DB-GPT project to build a complete private large model solution for all database-based scenarios. This solution supports local deployment, allowing it to be applied not only in independent private environments but also to be independently deployed and isolated according to business modules, ensuring that the ability of large models is absolutely private, secure, and controllable.
+
+| **DB-GPT** is an experimental open-source project that uses localized GPT large models to interact with your data and environment. With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure.
+
+Getting Started
+-----------------
+| How to get started using DB-GPT to interact with your data and environment.
+- `Quickstart Guid <./getting_started/getting_started.html>`_
+
+| Concepts and terminology
+
+- `Concepts and terminology  <./getting_started/concepts.html>`_
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Getting Started
+   :hidden:
+
+   getting_started/getting_started.md
+   getting_started/concepts.md
+   getting_started/tutorials.md
+
+
+Modules
+---------
 
 
 
-Indices and tables
+Use Cases
-==================
+---------
+
+
+Reference
+-----------
+
+
+
+Ecosystem
+----------
+
+
+Resources
+----------
+
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/modules/embedding.md

@@ -0,0 +1 @@
+# Embedding

docs/modules/knownledge.md

@@ -0,0 +1 @@
+# Knownledge

docs/modules/llms.md

@@ -0,0 +1 @@
+# LLMs

docs/modules/plugins.md

@@ -0,0 +1 @@
+# Plugins

docs/modules/prompts.md

@@ -0,0 +1 @@
+# Prompts

docs/modules/server.md

@@ -0,0 +1 @@
+# Server