diff --git a/docs/ecosystem.md b/docs/ecosystem.md new file mode 100644 index 000000000..9d6bd4150 --- /dev/null +++ b/docs/ecosystem.md @@ -0,0 +1 @@ +# Ecosystem \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4ece9459f..95877b81d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,9 @@ Getting Started - `Concepts and terminology <./getting_started/concepts.html>`_ +| Coming soon... + +- `Tutorials <.getting_started/tutorials.html>`_ .. toctree:: :maxdepth: 2 :caption: Getting Started @@ -31,22 +34,101 @@ Getting Started Modules --------- +| These modules are the core abstractions with which we can interact with data and environment smoothly. +It's very important for DB-GPT, DB-GPT also provide standard, extendable interfaces. +| The docs for each module contain quickstart examples, how to guides, reference docs, and conceptual guides. + +| The modules are as follows + +- `LLMs <./modules/llms.html>`_: Supported multi models management and integrations. + +- `Prompts <./modules/prompts.html>`_: Prompt management, optimization, and serialization for multi database. + +- `Plugins <./modules/plugins.html>`_: Plugins management, scheduler. + +- `Knownledge <./modules/knownledge.html>`_: Knownledge management, embedding, and search. + +- `Connections <./modules/connections.html>`_: Supported multi databases connection. management connections and interact with this. + +.. toctree:: + :maxdepth: 2 + :caption: Modules + :name: modules + :hidden: + + ./modules/llms.md + ./modules/prompts.md + ./modules/plugins.md + ./modules/connections.md + ./modules/knownledge.md Use Cases --------- +| Best Practices and built-in implementations for common DB-GPT use cases: + +- `Sql generation and diagnosis <./use_cases/sql_generation_and_diagnosis.html>`: SQL generation and diagnosis. + +- `knownledge Based QA <./use_cases/knownledge_based_qa.html>`_: A important scene for user to chat with database documents, codes, bugs and schemas. + +- `Chatbots <./use_cases/chatbots.html>`_: Language model love to chat, use multi models to chat. + +- `Querying Database Data <./use_cases/query_database_data.html>`_: Query and Analysis data from databases and give charts. + +- `Interacting with apis <./use_cases/interacting_with_api.html>`_: Interact with apis, such as create a table, deploy a database cluster, create a database and so on. + +- `Tool use with plugins <./use_cases/tool_use_with_plugin>`_: According to Plugin use tools to manage databases autonomoly. + +.. toctree:: + :maxdepth: 2 + :caption: Use Cases + :name: use_cases + :hidden: + + ./use_cases/sql_generation_and_diagnosis.md + ./use_cases/knownledge_based_qa.md + ./use_cases/chatbots.md + ./use_cases/query_database_data.md + ./use_cases/interacting_with_api.md + ./use_cases/tool_use_with_plugin.md Reference ----------- +| Full documentation on all methods, classes, installation methods, and integration setups for DB-GPT. +.. toctree:: + :maxdepth: 1 + :caption: Reference + :name: reference + :hidden: + ./reference.md Ecosystem ---------- +| Guides for how other companies/products can be used with DB-GPT + +.. toctree:: + :maxdepth: 1 + :glob: + :caption: Ecosystem + :name: ecosystem + :hidden + + ./ecosystem.md + Resources ---------- +| Additional resources we think may be useful as you develop your application! +- `Discord `_: if your have some problem or ideas, you can talk from discord. + +.. toctree:: + :maxdepth: 1 + :caption: Resources + :name: resources + :hidden: diff --git a/docs/modules/connections.md b/docs/modules/connections.md new file mode 100644 index 000000000..e2bfe7401 --- /dev/null +++ b/docs/modules/connections.md @@ -0,0 +1 @@ +# Connections \ No newline at end of file diff --git a/docs/reference.md b/docs/reference.md index e69de29bb..4a938e09d 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/docs/use_cases/chatbots.md b/docs/use_cases/chatbots.md new file mode 100644 index 000000000..547ae67cc --- /dev/null +++ b/docs/use_cases/chatbots.md @@ -0,0 +1 @@ +# Chatbot \ No newline at end of file diff --git a/docs/use_cases/interacting_with_api.md b/docs/use_cases/interacting_with_api.md new file mode 100644 index 000000000..65f69ed2a --- /dev/null +++ b/docs/use_cases/interacting_with_api.md @@ -0,0 +1 @@ +# Interacting with api \ No newline at end of file diff --git a/docs/use_cases/knownledge_based_qa.md b/docs/use_cases/knownledge_based_qa.md new file mode 100644 index 000000000..c9e25f385 --- /dev/null +++ b/docs/use_cases/knownledge_based_qa.md @@ -0,0 +1 @@ +# Knownledge based qa \ No newline at end of file diff --git a/docs/use_cases/query_database_data.md b/docs/use_cases/query_database_data.md new file mode 100644 index 000000000..fa25f7de7 --- /dev/null +++ b/docs/use_cases/query_database_data.md @@ -0,0 +1 @@ +# Query database data \ No newline at end of file diff --git a/docs/use_cases/sql_generation_and_diagnosis.md b/docs/use_cases/sql_generation_and_diagnosis.md new file mode 100644 index 000000000..f0448edd0 --- /dev/null +++ b/docs/use_cases/sql_generation_and_diagnosis.md @@ -0,0 +1 @@ +# SQL generation and diagnosis \ No newline at end of file diff --git a/docs/use_cases/tool_use_with_plugin.md b/docs/use_cases/tool_use_with_plugin.md new file mode 100644 index 000000000..8aa053daf --- /dev/null +++ b/docs/use_cases/tool_use_with_plugin.md @@ -0,0 +1 @@ +# Tool use with plugin \ No newline at end of file