diff --git a/README.md b/README.md index f3fb3dff9..60193e086 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ # MetaGPT: The Multi-Agent Framework

Software Company Multi-Role Schematic (Gradually Implementing)

+ + ## Install ### Conda installation @@ -58,7 +60,7 @@ # setup your OPENAI_API_KEY in key.yaml copy from config.yaml python3 startup.py "Write a cli snake game" ``` -detail installation please refer to [cli_install](docs/install/cli_install.md) +detail installation please refer to [cli_install](https://docs.deepwisdom.ai/guide/get_started/installation.html#installation-for-full-features) ### Docker installation @@ -78,28 +80,30 @@ # Step 2: Run metagpt demo with container python startup.py "Write a cli snake game" ``` -detail installation please refer to [docker_install](docs/install/docker_install.md) +detail installation please refer to [docker_install](https://docs.deepwisdom.ai/guide/get_started/installation.html#install-with-docker) ### QuickStart & Demo Video - Try it on [MetaGPT Huggingface Space](https://huggingface.co/spaces/deepwisdom/MetaGPT) - [Matthew Berman: How To Install MetaGPT - Build A Startup With One Prompt!!](https://youtu.be/uT75J_KG_aY) - [Official Demo Video](https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d) +https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419 + ## Tutorial -- [Oneline Document]() -- [Usage](docs/tutorial/usage.md) -- [What can MetaGPT do?](docs/tutorial/what_can_this_do.md) -- How to build your own agents? - - [MetaGPT Usage & Development Guide](https://deepwisdom.feishu.cn/wiki/RUnswqUIPimRJmkkDZ7cLYwOndg#Yu2AdUvymoo67Jxbp0bcu8G4nEb) -- [Contribution](docs/develop/contribution.md) - - Develop RFC +- 🗒 [Online Document](https://docs.deepwisdom.ai/) +- 💻 [Usage](https://docs.deepwisdom.ai/guide/get_started/quickstart.html) +- 🔎 [What can MetaGPT do?](https://docs.deepwisdom.ai/guide/get_started/introduction.html) +- 🛠 How to build your own agents? + - [MetaGPT Usage & Development Guide | Agent 101](https://docs.deepwisdom.ai/guide/tutorials/agent_101.html) + - [MetaGPT Usage & Development Guide | MultiAgent 101](https://docs.deepwisdom.ai/guide/tutorials/multi_agent_101.html) +- 🧑‍💻 Contribution - [Develop Roadmap](docs/ROADMAP.md) -- [Examples](docs/examples/README.md) - - Researcher - - Werewolf Game -- [FAQs](docs/tutorial/faq.md) -- [The generated projects display wall](https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419) +- 🔖 Use Cases + - [Debate](https://docs.deepwisdom.ai/guide/use_cases/multi_agent/debate.html) + - [Researcher](https://docs.deepwisdom.ai/guide/use_cases/agent/researcher.html) + - [Recepit Assistant](https://docs.deepwisdom.ai/guide/use_cases/agent/receipt_assistant.html) +- ❓ [FAQs](https://docs.deepwisdom.ai/guide/faq.html) ## Support diff --git a/docs/README_CN.md b/docs/README_CN.md index 8c04e5066..6dac0e210 100644 --- a/docs/README_CN.md +++ b/docs/README_CN.md @@ -57,7 +57,7 @@ # 拷贝config.yaml为key.yaml,并设置你自己的OPENAI_API_KEY python3 startup.py "Write a cli snake game" ``` -详细的安装请安装 [cli_install](docs/install/cli_install_cn.md) +详细的安装请安装 [cli_install](https://docs.deepwisdom.ai/zhcn/guide/get_started/installation.html#%E5%AE%89%E8%A3%85%E5%85%A8%E9%83%A8%E5%8A%9F%E8%83%BD) ### Docker安装 @@ -77,27 +77,29 @@ # 步骤2: 使用容器运行metagpt演示 python startup.py "Write a cli snake game" ``` -详细的安装请安装 [docker_install](docs/install/docker_install_cn.md) +详细的安装请安装 [docker_install](https://docs.deepwisdom.ai/zhcn/guide/get_started/installation.html#%E4%BD%BF%E7%94%A8docker%E5%AE%89%E8%A3%85) ### 快速开始的演示视频 - 在 [MetaGPT Huggingface Space](https://huggingface.co/spaces/deepwisdom/MetaGPT) 上进行体验 - [Matthew Berman: How To Install MetaGPT - Build A Startup With One Prompt!!](https://youtu.be/uT75J_KG_aY) - [官方演示视频](https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d) +https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419 + ## 教程 -- [在线文档]() -- [如何使用](docs/tutorial/usage_cn.md) -- [MetaGPT的能力及应用场景](docs/tutorial/what_can_this_do.md) -- 如何构建你自己得智能体? - - [MetaGPT的使用和开发教程](https://deepwisdom.feishu.cn/wiki/RUnswqUIPimRJmkkDZ7cLYwOndg#Yu2AdUvymoo67Jxbp0bcu8G4nEb) -- [贡献](docs/develop/contribution.md) - - 开发者RFC +- 🗒 [在线文档](https://docs.deepwisdom.ai/zhcn/) +- 💻 [如何使用](https://docs.deepwisdom.ai/zhcn/guide/get_started/quickstart.html) +- 🔎 [MetaGPT的能力及应用场景](https://docs.deepwisdom.ai/zhcn/guide/get_started/introduction.html) +- 🛠 如何构建你自己得智能体? + - [MetaGPT的使用和开发教程 | 智能体入门](https://docs.deepwisdom.ai/zhcn/guide/tutorials/agent_101.html) + - [MetaGPT的使用和开发教程 | 多智能体入门](https://docs.deepwisdom.ai/zhcn/guide/tutorials/multi_agent_101.html) +- 🧑‍💻 贡献 - [开发路线图](docs/ROADMAP.md) -- [样例](docs/examples/README.md) - - 调研员 - - 狼人杀游戏 -- [常见问题解答](docs/tutorial/faq.md) -- [已生成项目的展示墙](https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419) +- 🔖 示例 + - [辩论](https://docs.deepwisdom.ai/zhcn/guide/use_cases/multi_agent/debate.html) + - [调研员](https://docs.deepwisdom.ai/zhcn/guide/use_cases/agent/researcher.html) + - [票据助手](https://docs.deepwisdom.ai/zhcn/guide/use_cases/agent/receipt_assistant.html) +- ❓ [常见问题解答](https://docs.deepwisdom.ai/zhcn/guide/faq.html) ## 支持 diff --git a/docs/examples/README.md b/docs/examples/README.md deleted file mode 100644 index 4fe4628e2..000000000 --- a/docs/examples/README.md +++ /dev/null @@ -1,12 +0,0 @@ -## Examples -We introduce some example agents created recently and show how to created these agents under the framework. - -- Researcher - - With the given research topic, the agent will derive the keywords from the topic and then search the related documents using search engine api. - - The search result will be ranked and filtered to get high quality candidates. - - Summary the final content using the candidate documents as context. -- Invoice OCR and QA - - With the given one or multi invoices, the agent can recognize the text from the image or pdf. - - Organize the text with particular structure, generally, it will be saved in a csv. - - It can answer your question like `what's the total reimbursement of Alice?` -- Werewolf Game