A programming framework for agentic AI
Restructure docs, move packages to top level header (#4722)
Jack Gerrits97e5cab5234f
diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.htmlnew file mode 100644index 000000000..78de010ca--- /dev/null+++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html@@ -0,0 +1,19 @@+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}++<nav class="bd-docs-nav bd-links"+ aria-label="{{ _('Section Navigation') }}">+ <div class="bd-toc-item navbar-nav">+ {{- generate_toctree_html(+ "sidebar",+ show_nav_level=theme_show_nav_level | int,+ maxdepth=theme_navigation_depth | int,+ collapse=theme_collapse_navigation | tobool,+ includehidden=theme_sidebar_includehidden | tobool,+ titles_only=True+ )+ -}}+ <ul class="nav bd-sidenav">+ <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_agentchat')}}">API Reference</a></li>+ </ul>+ </div>+</nav>\ No newline at end of filediff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.htmlnew file mode 100644index 000000000..125146575--- /dev/null+++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html@@ -0,0 +1,19 @@+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}++<nav class="bd-docs-nav bd-links"+ aria-label="{{ _('Section Navigation') }}">+ <div class="bd-toc-item navbar-nav">+ {{- generate_toctree_html(+ "sidebar",+ show_nav_level=theme_show_nav_level | int,+ maxdepth=theme_navigation_depth | int,+ collapse=theme_collapse_navigation | tobool,+ includehidden=theme_sidebar_includehidden | tobool,+ titles_only=True+ )+ -}}+ <ul class="nav bd-sidenav">+ <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_core')}}">API Reference</a></li>+ </ul>+ </div>+</nav>\ No newline at end of filediff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.htmlnew file mode 100644index 000000000..6128f2404--- /dev/null+++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html@@ -0,0 +1,20 @@+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}++<nav class="bd-docs-nav bd-links"+ aria-label="{{ _('Section Navigation') }}">+ <div class="bd-toc-item navbar-nav">+ {{- generate_toctree_html(+ "sidebar",+ show_nav_level=theme_show_nav_level | int,+ maxdepth=theme_navigation_depth | int,+ collapse=theme_collapse_navigation | tobool,+ includehidden=theme_sidebar_includehidden | tobool,+ titles_only=True+ )+ -}}+ <p aria-level="2" class="caption" role="heading"><span class="caption-text">More</span></p>+ <ul class="nav bd-sidenav">+ <li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_ext.agents.magentic_one')}}">API Reference</a></li>+ </ul>+ </div>+</nav>\ No newline at end of filediff --git a/python/packages/autogen-core/docs/src/conf.py b/python/packages/autogen-core/docs/src/conf.pyindex d64f14f86..42ef158dd 100644--- a/python/packages/autogen-core/docs/src/conf.py+++ b/python/packages/autogen-core/docs/src/conf.py@@ -88,15 +88,14 @@ html_favicon = "_static/images/logo/favicon-512x512.png"html_theme_options = {- "header_links_before_dropdown": 4,+ "header_links_before_dropdown": 6,"navbar_align": "left",- "show_nav_level": 4,"check_switcher": False,# "navbar_start": ["navbar-logo", "version-switcher"],# "switcher": {# "json_url": "/_static/switcher.json",# },- "show_prev_next": False,+ "show_prev_next": True,"icon_links": [{"name": "GitHub",@@ -133,6 +132,9 @@ html_theme_options = {html_js_files = ["custom-icon.js", "override-switcher-button.js"]html_sidebars = {"packages/index": [],+ "user-guide/core-user-guide/**": ["sidebar-nav-bs-core"],+ "user-guide/agentchat-user-guide/**": ["sidebar-nav-bs-agentchat"],+ "user-guide/extensions-user-guide/**": ["sidebar-nav-bs-extensions"],}html_context = {diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.mdindex bebde85c1..d11080b6b 100644--- a/python/packages/autogen-core/docs/src/index.md+++ b/python/packages/autogen-core/docs/src/index.md@@ -97,7 +97,10 @@ Get Started:maxdepth: 3:hidden:-user-guide/index+user-guide/agentchat-user-guide/index+Studio <user-guide/autogenstudio-user-guide/index>+user-guide/core-user-guide/index+user-guide/extensions-user-guide/indexpackages/indexreference/index```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.mdindex 02a0b9517..391fe8f64 100644--- 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@@ -14,7 +14,7 @@ For advanced users, [`autogen-core`](../core-user-guide/index.md)'s event-drivenprogramming model provides more flexibility and control over the underlying components.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).+behaviors and **Teams** with predefined [multi-agent design patterns](../core-user-guide/design-patterns/intro.md).::::{grid} 2 2 2 2@@ -51,6 +51,29 @@ Sample code and use casesinstallationquickstart-tutorial/index+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: Tutorial++tutorial/models+tutorial/messages+tutorial/agents+tutorial/teams+tutorial/selector-group-chat+tutorial/swarm+tutorial/termination+tutorial/custom-agents+tutorial/state+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: More+examples/index```+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.ipynbindex e9145a13e..c02561d3e 100644--- 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@@ -124,7 +124,7 @@"source": ["## What's Next?\n","\n",- "Now that you have a basic understanding of how to define an agent and a team, consider following the [tutorial](./tutorial/index) for a walkthrough on other features of AgentChat.\n",+ "Now that you have a basic understanding of how to define an agent and a team, consider following the [tutorial](./tutorial/models) for a walkthrough on other features of AgentChat.\n","\n"]}@@ -145,7 +145,7 @@"name": "python","nbconvert_exporter": "python","pygments_lexer": "ipython3",- "version": "3.12.6"+ "version": "3.12.7"}},"nbformat": 4,diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/index.mddeleted file mode 100644index a7c97d9de..000000000--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/index.md+++ /dev/null@@ -1,78 +0,0 @@-----myst:- html_meta:- "description lang=en": |- Tutorial for AutoGen AgentChat, a framework for building multi-agent applications with AI agents.------# Tutorial--Get started with AgentChat through this comprehensive tutorial.--::::{grid} 2 2 2 3-:gutter: 3--:::{grid-item-card} {fas}`book-open;pst-color-primary` Models-:link: ./models.html--Setting up model clients for agents and teams.-:::--:::{grid-item-card} {fas}`message;pst-color-primary` Messages-:link: ./messages.html--Understanding different types of messages.-:::--:::{grid-item-card} {fas}`users;pst-color-primary` Agents-:link: ./agents.html--Building agents that use models, tools, and code executors.-:::--:::{grid-item-card} {fas}`users;pst-color-primary` Teams Intro-:link: ./teams.html--Introduction to teams and task termination.-:::--:::{grid-item-card} {fas}`users;pst-color-primary` Selector Group Chat-:link: ./selector-group-chat.html--A smart team that uses a model-based strategy and custom selector.-:::--:::{grid-item-card} {fas}`users;pst-color-primary` Swarm-:link: ./swarm.html--A dynamic team that uses handoffs to pass tasks between agents.-:::--:::{grid-item-card} {fas}`users;pst-color-primary` Custom Agents-:link: ./custom-agents.html--How to build custom agents.-:::--:::{grid-item-card} {fas}`database;pst-color-primary` State Management-:link: ./state.html--How to manage state in agents and teams.-:::--::::--```{toctree}-:maxdepth: 1-:hidden:--models-messages-agents-teams-selector-group-chat-swarm-termination-custom-agents-state-```diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/application-stack.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/application-stack.mdindex 71b380ebf..074e4b515 100644--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/application-stack.md+++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/application-stack.md@@ -20,7 +20,7 @@ implementation of the contracts determines how agents handle messages.The behavior contract is also sometimes referred to as the message protocol.It is the developer's responsibility to implement the behavior contract.Multi-agent patterns emerge from these behavior contracts-(see [Multi-Agent Design Patterns](../design-patterns/index.md)).+(see [Multi-Agent Design Patterns](../design-patterns/intro.md)).## An Example Applicationdiff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/index.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/index.mddeleted file mode 100644index 0862976a4..000000000--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/core-concepts/index.md+++ /dev/null@@ -1,14 +0,0 @@-# Core Concepts--The following sections describe the main concepts of the Core API-and the system architecture.--```{toctree}-:maxdepth: 1--agent-and-multi-agent-application-architecture-application-stack-agent-identity-and-lifecycle-topic-and-subscription-```diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/index.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.mdsimilarity index 82%rename from python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/index.mdrename to python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.mdindex 7528ed8e4..5fad8db25 100644--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/index.md+++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.md@@ -1,4 +1,4 @@-# Multi-Agent Design Patterns+# IntroAgents can work together in a variety of ways to solve problems.Research works like [AutoGen](https://aka.ms/autogen-paper),@@ -17,15 +17,4 @@ You can implement any multi-agent design pattern using AutoGen agents.In the next two sections, we will discuss two common design patterns:group chat for task decomposition, and reflection for robustness.-```{toctree}-:maxdepth: 1-concurrent-agents-sequential-workflow-group-chat-handoffs-mixture-of-agents-multi-agent-debate-reflection-code-execution-groupchat-```diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynbindex 84853479e..bfff326b5 100644--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb+++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb@@ -9,7 +9,16 @@"In this and the following section, we focus on the core concepts of AutoGen:\n","agents, agent runtime, messages, and communication.\n","You will not find any AI models or tools here, just the foundational\n",- "building blocks for building multi-agent applications."+ "building blocks for building multi-agent applications.\n",+ "\n",+ "```{note}\n",+ "The Core API is designed to be unopinionated and flexible. So at times, you\n",+ "may find it challenging. Continue if you are building\n",+ "an interactive, scalable and distributed multi-agent system and want full control\n",+ "of all workflows.\n",+ "If you just want to get something running\n",+ "quickly, you may take a look at the [AgentChat API](../../agentchat-user-guide/index.md).\n",+ "```"]},{diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/index.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/index.mddeleted file mode 100644index 21f9cd00d..000000000--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/framework/index.md+++ /dev/null@@ -1,30 +0,0 @@-# Framework Guide--The following sections guides you through the usage of the Core API.-At minimum, read [Agent and Agent Runtime](agent-and-agent-runtime.ipynb)-and [Message and Communication](message-and-communication.ipynb) to get the-basic understanding.--```{note}-The Core API is designed to be unopinionated and flexible. So at times, you-may find it challenging. Continue if you are building-an interactive, scalable and distributed multi-agent system and want full control-of all workflows.-If you just want to get something running-quickly, you may take a look at the [AgentChat API](../../agentchat-user-guide/index.md).-```--## List of content--```{toctree}-:maxdepth: 1--agent-and-agent-runtime-message-and-communication-model-clients-tools-logging-telemetry-command-line-code-executors-distributed-agent-runtime-```diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.mdindex 7782d0e4f..ead8623b2 100644--- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md+++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md@@ -12,9 +12,56 @@ myst::hidden:quickstart-core-concepts/index-framework/index-design-patterns/index+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: Core Concepts++core-concepts/agent-and-multi-agent-application+core-concepts/architecture+core-concepts/application-stack+core-concepts/agent-identity-and-lifecycle+core-concepts/topic-and-subscription+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: Framework Guide++framework/agent-and-agent-runtime+framework/message-and-communication+framework/model-clients+framework/tools+framework/logging+framework/telemetry+framework/command-line-code-executors+framework/distributed-agent-runtime+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: Multi-Agent Design Patterns++design-patterns/intro+design-patterns/concurrent-agents+design-patterns/sequential-workflow+design-patterns/group-chat+design-patterns/handoffs+design-patterns/mixture-of-agents+design-patterns/multi-agent-debate+design-patterns/reflection+design-patterns/code-execution-groupchat+```++```{toctree}+:maxdepth: 1+:hidden:+:caption: More+cookbook/indexfaqs```diff --git a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/create-your-own.md b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/create-your-own.mdnew file mode 100644index 000000000..6d4c797c6--- /dev/null+++ b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/create-your-own.md@@ -0,0 +1,44 @@+# Creating your own extension++With the new package structure in 0.4, it is easier than ever to create and publish your own extension to the AutoGen ecosystem. This page details some best practices so that your extension package integrates well with the AutoGen ecosystem.++## Best practices++### Naming++There is no requirement about naming. But prefixing the package name with `autogen-` makes it easier to find.++### Common interfaces++Whenever possible, extensions should implement the provided interfaces from the `autogen_core` package. This will allow for a more consistent experience for users.++#### Dependency on AutoGen++To ensure that the extension works with the version of AutoGen that it was designed for, it is recommended to specify the version of AutoGen the dependency section of the `pyproject.toml` with adequate constraints.++```toml+[project]+# ...+dependencies = [+ "autogen-core>=0.4,<0.5"+]+```++### Usage of typing++AutoGen embraces the use of type hints to provide a better development experience. Extensions should use type hints whenever possible.++## Discovery++To make it easier for users to find your extension, sample, service or package, you can [add the topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) [`autogen`](https://github.com/topics/autogen) to the GitHub repo.++More specific topics are also available:++- [`autogen-extension`](https://github.com/topics/autogen-extension) for extensions+- [`autogen-sample`](https://github.com/topics/autogen-sample) for samples++## Changes from 0.2++In AutoGen 0.2 it was common to merge 3rd party extensions and examples into the main repo. We are super appreciative of all of the users who have contributed to the ecosystem notebooks, modules and pages in 0.2. However, in general we are moving away from this model to allow for more flexibility and to reduce maintenance burden.++There is the `autogen-ext` package for 1st party supported extensions, but we want to be selective to manage maintenance load. If you would like to see if your extension makes sense to add into `autogen-ext`, please open an issue and let's discuss. Otherwise, we encourage you to publish your extension as a separate package and follow the guidance under [discovery](#discovery) to make it easy for users to find.diff --git a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/discover.md b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/discover.mdnew file mode 100644index 000000000..f0cb99529--- /dev/null+++ b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/discover.md@@ -0,0 +1,46 @@+# Discover community projects++::::{grid} 1 2 2 2+:margin: 4 4 0 0+:gutter: 1++:::{grid-item-card} {fas}`globe;pst-color-primary` <br> Ecosystem+:link: https://github.com/topics/autogen+:class-item: api-card+:columns: 12++Find samples, services and other things that work with AutoGen++:::++:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` <br> Community Extensions+:link: https://github.com/topics/autogen-extension+:class-item: api-card++Find AutoGen extensions for 3rd party tools, components and services++:::++:::{grid-item-card} {fas}`vial;pst-color-primary` <br> Community Samples+:link: https://github.com/topics/autogen-sample+:class-item: api-card++Find community samples and examples of how to use AutoGen++:::++::::+++## List of community projects++| Name | Package | Description |+|---|---|---|+| [autogen-watsonx-client](https://github.com/tsinggggg/autogen-watsonx-client) | [PyPi](https://pypi.org/project/autogen-watsonx-client/) | Model client for [IBM watsonx.ai](https://www.ibm.com/products/watsonx-ai) |+| [autogen-openaiext-client](https://github.com/vballoli/autogen-openaiext-client) | [PyPi](https://pypi.org/project/autogen-openaiext-client/) | Model client for other LLMs like Gemini, etc. through the OpenAI API |++<!-- Example -->+<!-- | [My Model Client](https://github.com/example) | [PyPi](https://pypi.org/project/example) | Model client for my custom model service | -->+<!-- - Name should link to the project page or repo+- Package should link to the PyPi page+- Description should be a brief description of the project. 1 short sentence is ideal. -->diff --git a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.mdindex f8013dae5..9b5fc111f 100644--- a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md+++ b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md@@ -11,124 +11,33 @@ myst::maxdepth: 3:hidden:-azure-container-code-executor+discover+create-your-own```+```{toctree}+:maxdepth: 3+:hidden:+:caption: Guides-## Discover community projects:--::::{grid} 1 2 2 2-:margin: 4 4 0 0-:gutter: 1--:::{grid-item-card} {fas}`globe;pst-color-primary` <br> Ecosystem-:link: https://github.com/topics/autogen-:class-item: api-card-:columns: 12+azure-container-code-executor+```-Find samples, services and other things that work with AutoGen+AutoGen is designed to be extensible. The `autogen-ext` package contains many different component implementations maintained by the AutoGen project. However, we strongly encourage others to build their own components and publish them as part of the ecosytem.-:::-:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` <br> Community Extensions-:link: https://github.com/topics/autogen-extension-:class-item: api-card+::::{grid} 2 2 2 2+:gutter: 3-Find AutoGen extensions for 3rd party tools, components and services+:::{grid-item-card} {fas}`magnifying-glass;pst-color-primary` Discover+:link: ./installation.html+How to install AgentChat:::-:::{grid-item-card} {fas}`vial;pst-color-primary` <br> Community Samples-:link: https://github.com/topics/autogen-sample-:class-item: api-card--Find community samples and examples of how to use AutoGen+:::{grid-item-card} {fas}`code;pst-color-primary` Create your own+:link: ./quickstart.html+Build your first agent:::-::::---### List of community projects--| Name | Package | Description |-|---|---|---|-| [autogen-watsonx-client](https://github.com/tsinggggg/autogen-watsonx-client) | [PyPi](https://pypi.org/project/autogen-watsonx-client/) | Model client for [IBM watsonx.ai](https://www.ibm.com/products/watsonx-ai) |-| [autogen-openaiext-client](https://github.com/vballoli/autogen-openaiext-client) | [PyPi](https://pypi.org/project/autogen-openaiext-client/) | Model client for other LLMs like Gemini, etc. through the OpenAI API |--<!-- Example -->-<!-- | [My Model Client](https://github.com/example) | [PyPi](https://pypi.org/project/example) | Model client for my custom model service | -->-<!-- - Name should link to the project page or repo-- Package should link to the PyPi page-- Description should be a brief description of the project. 1 short sentence is ideal. -->---## Built-in extensions--Read docs for built in extensions:--```{note}-WIP-```--<!-- ::::{grid} 1 2 3 3-:margin: 4 4 0 0-:gutter: 1--:::{grid-item-card} LangChain Tools-:link: python/autogen_agentchat/autogen_agentchat-:link-type: doc-:::--:::{grid-item-card} ACA Dynamic Sessions Code Executor-:link: python/autogen_agentchat/autogen_agentchat-:link-type: doc-:::--:::: -->---## Creating your own community extension--With the new package structure in 0.4, it is easier than ever to create and publish your own extension to the AutoGen ecosystem. This page details some best practices so that your extension package integrates well with the AutoGen ecosystem.--### Best practices--#### Naming--There is no requirement about naming. But prefixing the package name with `autogen-` makes it easier to find.--#### Common interfaces--Whenever possible, extensions should implement the provided interfaces from the `autogen_core` package. This will allow for a more consistent experience for users.--##### Dependency on AutoGen--To ensure that the extension works with the version of AutoGen that it was designed for, it is recommended to specify the version of AutoGen the dependency section of the `pyproject.toml` with adequate constraints.--```toml-[project]-# ...-dependencies = [- "autogen-core>=0.4,<0.5"-]-```--#### Usage of typing--AutoGen embraces the use of type hints to provide a better development experience. Extensions should use type hints whenever possible.--### Discovery--To make it easier for users to find your extension, sample, service or package, you can [add the topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) [`autogen`](https://github.com/topics/autogen) to the GitHub repo.--More specific topics are also available:--- [`autogen-extension`](https://github.com/topics/autogen-extension) for extensions-- [`autogen-sample`](https://github.com/topics/autogen-sample) for samples--### Changes from 0.2--In AutoGen 0.2 it was common to merge 3rd party extensions and examples into the main repo. We are super appreciative of all of the users who have contributed to the ecosystem notebooks, modules and pages in 0.2. However, in general we are moving away from this model to allow for more flexibility and to reduce maintenance burden.--There is the `autogen-ext` package for 1st party supported extensions, but we want to be selective to manage maintenance load. If you would like to see if your extension makes sense to add into `autogen-ext`, please open an issue and let's discuss. Otherwise, we encourage you to publish your extension as a separate package and follow the guidance under [discovery](#discovery) to make it easy for users to find.diff --git a/python/packages/autogen-core/docs/src/user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/index.mddeleted file mode 100644index eef6281b7..000000000--- a/python/packages/autogen-core/docs/src/user-guide/index.md+++ /dev/null@@ -1,47 +0,0 @@-# User Guide--```{toctree}-:maxdepth: 3-:hidden:--agentchat-user-guide/index-autogenstudio-user-guide/index-core-user-guide/index-extensions-user-guide/index-```--::::{grid} 1 2 2 3-:margin: 4 4 0 0-:gutter: 1--:::{grid-item-card} {fas}`people-group;pst-color-primary` <br> AutoGen AgentChat-:link: agentchat-user-guide/index-:link-type: doc-:class-item: api-card-:::--:::{grid-item-card} {fas}`people-group;pst-color-primary` <br> AutoGen AgentChat-:link: autogenstudio-user-guide/index-:link-type: doc-:class-item: api-card-:::--:::{grid-item-card} {fas}`display;pst-color-primary` <br> AutoGen Studio-:link: autogenstudio-user-guide/index-:link-type: doc-:class-item: api-card-:::--:::{grid-item-card} {fas}`cube;pst-color-primary` <br> AutoGen Core-:link: core-user-guide/index-:link-type: doc-:class-item: api-card-:::--::::--<script type="text/javascript">- setTimeout(function() {- window.location.href = "agentchat-user-guide/quickstart.html";- }, 0);-</script>