Improves tutorial (#4507)

* Change nav depth * Remove repetitive module names * Increase nav depth * Decrease base font size of docs * Improve docs * Undo css change
microsoft · Dec 4, 2024 · 6706dce · 6706dce
1 parent 31cb50b
commit 6706dce
Show file tree

Hide file tree

Showing 5 changed files with 188 additions and 211 deletions.
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md
@@ -13,18 +13,9 @@ For beginner users, AgentChat is the recommended starting point.
 For advanced users, [`autogen-core`](../core-user-guide/index.md)'s event-driven
 programming model provides more flexibility and control over the underlying components.
 
-AgentChat aims to provide intuitive defaults, such as **Agents** with preset
+AgentChat provides intuitive defaults, such as **Agents** with preset
 behaviors and **Teams** with predefined [multi-agent design patterns](../core-user-guide/design-patterns/index.md).
-to simplify building multi-agent applications.
 
-```{include} warning.md
-
-```
-
-```{tip}
-If you are interested in implementing complex agent interaction behaviours, defining custom messaging protocols, or orchestration mechanisms, consider using the [ `autogen-core`](../core-user-guide/index.md) package.
-
-```
 
 ::::{grid} 2 2 2 2
 :gutter: 3

diff --git a/.../packages/autogen-core/docs/src/user-guide/agentchat-user-guide/installation.md b/.../packages/autogen-core/docs/src/user-guide/agentchat-user-guide/installation.md
@@ -7,7 +7,7 @@ myst:
 
 # Installation
 
-## Create a virtual environment (optional)
+## Create a Virtual Environment (optional)
 
 When installing AgentChat locally, we recommend using a virtual environment for the installation. This will ensure that the dependencies for AgentChat are isolated from the rest of your system.
 
@@ -55,7 +55,7 @@ conda deactivate
 
 ``````
 
-## Intall the AgentChat package using pip
+## Install Using pip
 
 Install the `autogen-agentchat` package using pip:
 

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/quickstart.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/quickstart.ipynb
@@ -11,15 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "```{include} warning.md\n",
-    "\n",
-    "```\n",
-    "\n",
-    ":::{note}\n",
-    "For installation instructions, please refer to the [installation guide](./installation).\n",
-    ":::\n",
-    "\n",
-    "In AutoGen AgentChat, you can build applications quickly using preset agents.\n",
+    "Via AgentChat, you can build applications quickly using preset agents.\n",
     "To illustrate this, we will begin with creating a team of a single agent\n",
     "that can use tools and respond to messages.\n",
     "\n",

diff --git a/...ackages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/index.md b/...ackages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/index.md
@@ -7,11 +7,7 @@ myst:
 
 # Tutorial
 
-Tutorial to get started with AgentChat.
-
-```{include} ../warning.md
-
-```
+Get started with AgentChat through this comprehensive tutorial.
 
 ::::{grid} 2 2 2 3
 :gutter: 3