Skip to content

Commit 5c1579d

Browse files
authored
Add links to roadmap issues from README, Getting-Started, Contribute and Tutorial (#2072)
* Link to roadmap issues. * Ordering
1 parent 99e48dc commit 5c1579d

File tree

4 files changed

+34
-19
lines changed

4 files changed

+34
-19
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ AutoGen is a framework that enables the development of LLM applications using mu
5757

5858
AutoGen is powered by collaborative [research studies](https://microsoft.github.io/autogen/docs/Research) from Microsoft, Penn State University, and the University of Washington.
5959

60+
## Roadmaps
61+
62+
To see what we are working on and what we plan to work on, please check our
63+
[Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap).
64+
6065
## Quickstart
6166
The easiest way to start playing is
6267
1. Click below to use the GitHub Codespace

website/docs/Contribute.md

+5
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
2424
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
2525
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
2626

27+
## Roadmaps
28+
29+
To see what we are working on and what we plan to work on, please check our
30+
[Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap).
31+
2732
## How to make a good bug report
2833

2934
When you submit an issue to [GitHub](https://github.com/microsoft/autogen/issues), please do your best to

website/docs/Getting-Started.mdx

+23-19
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import Tabs from '@theme/Tabs';
2-
import TabItem from '@theme/TabItem';
1+
import Tabs from "@theme/Tabs";
2+
import TabItem from "@theme/TabItem";
33

44
# Getting Started
55

@@ -13,16 +13,15 @@ tools.
1313

1414
### Main Features
1515

16-
1716
- AutoGen enables building next-gen LLM applications based on [multi-agent
1817
conversations](/docs/Use-Cases/agent_chat) with minimal effort. It simplifies
1918
the orchestration, automation, and optimization of a complex LLM workflow. It
2019
maximizes the performance of LLM models and overcomes their weaknesses.
2120
- It supports [diverse conversation
22-
patterns](/docs/Use-Cases/agent_chat#supporting-diverse-conversation-patterns)
23-
for complex workflows. With customizable and conversable agents, developers can
24-
use AutoGen to build a wide range of conversation patterns concerning
25-
conversation autonomy, the number of agents, and agent conversation topology.
21+
patterns](/docs/Use-Cases/agent_chat#supporting-diverse-conversation-patterns)
22+
for complex workflows. With customizable and conversable agents, developers can
23+
use AutoGen to build a wide range of conversation patterns concerning
24+
conversation autonomy, the number of agents, and agent conversation topology.
2625
- It provides a collection of working systems with different complexities. These
2726
systems span a [wide range of
2827
applications](/docs/Use-Cases/agent_chat#diverse-applications-implemented-with-autogen)
@@ -75,7 +74,6 @@ user_proxy.initiate_chat(
7574
</TabItem>
7675
<TabItem value="docker" label="Docker execution" default>
7776

78-
7977
```python
8078
from autogen import AssistantAgent, UserProxyAgent
8179
from autogen.coding import DockerCommandLineCodeExecutor
@@ -112,27 +110,33 @@ Open `coding/plot.png` to see the generated plot.
112110
Learn more about configuring LLMs for agents [here](/docs/topics/llm_configuration).
113111
:::
114112

115-
116-
117113
#### Multi-Agent Conversation Framework
114+
118115
Autogen enables the next-gen LLM applications with a generic multi-agent conversation framework. It offers customizable and conversable agents which integrate LLMs, tools, and humans.
119116
By automating chat among multiple capable agents, one can easily make them collectively perform tasks autonomously or with human feedback, including tasks that require using tools via code. For [example](https://github.com/microsoft/autogen/blob/main/test/twoagent.py),
120117

121118
The figure below shows an example conversation flow with AutoGen.
122119

123120
![Agent Chat Example](/img/chat_example.png)
124121

125-
126122
### Where to Go Next?
127123

128-
* Go through the [tutorial](/docs/tutorial/introduction) to learn more about the core concepts in AutoGen
129-
* Read the examples and guides in the [notebooks section](/docs/notebooks)
130-
* Understand the use cases for [multi-agent conversation](/docs/Use-Cases/agent_chat) and [enhanced LLM inference](/docs/Use-Cases/enhanced_inference)
131-
* Read the [API](/docs/reference/agentchat/conversable_agent/) docs
132-
* Learn about [research](/docs/Research) around AutoGen
133-
* Chat on [Discord](https://discord.gg/pAbnFJrkgZ)
134-
* Follow on [Twitter](https://twitter.com/pyautogen)
124+
- Go through the [tutorial](/docs/tutorial/introduction) to learn more about the core concepts in AutoGen
125+
- Read the examples and guides in the [notebooks section](/docs/notebooks)
126+
- Understand the use cases for [multi-agent conversation](/docs/Use-Cases/agent_chat) and [enhanced LLM inference](/docs/Use-Cases/enhanced_inference)
127+
- Read the [API](/docs/reference/agentchat/conversable_agent/) docs
128+
- Learn about [research](/docs/Research) around AutoGen
129+
- Chat on [Discord](https://discord.gg/pAbnFJrkgZ)
130+
- Follow on [Twitter](https://twitter.com/pyautogen)
131+
- See our [roadmaps](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap)
135132

136133
If you like our project, please give it a [star](https://github.com/microsoft/autogen/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](/docs/Contribute).
137134

138-
<iframe src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=autogen&amp;type=star&amp;count=true&amp;size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
135+
<iframe
136+
src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=autogen&amp;type=star&amp;count=true&amp;size=large"
137+
frameborder="0"
138+
scrolling="0"
139+
width="170"
140+
height="30"
141+
title="GitHub"
142+
></iframe>

website/docs/tutorial/what-next.md

+1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ our [Discord Server](https://discord.gg/pAbnFJrkgZ).
3636

3737
## Get Involved
3838

39+
- Check out [Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) to see what we are working on.
3940
- Contribute your work to our [gallery](../Gallery)
4041
- Follow our [contribution guide](../Contribute) to make a pull request to AutoGen
4142
- You can also share your work with the community on the Discord server.

0 commit comments

Comments
 (0)