Skip to content

Commit 34bd468

Browse files
committed
update readme content by github.io
1 parent 36a9c58 commit 34bd468

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ CodeFuse-ChatBot是由蚂蚁CodeFuse团队开发的开源AI智能助手,致力
1818

1919

2020
## 🔔 更新
21-
- [2024.01.29] 开放可配置化的multi-agent框架:codefuse-muAgent,详情见[使用说明](sources/readme_docs/coagent/coagent.md)
21+
- [2024.01.29] 开放可配置化的multi-agent框架:codefuse-muAgent,详情见[使用说明](https://codefuse-ai.github.io/zh-CN/docs/api-docs/MuAgent/overview/multi-agent)
2222
- [2023.12.26] 基于FastChat接入开源私有化大模型和大模型接口的能力开放
2323
- [2023.12.14] 量子位公众号专题报道:[文章链接](https://mp.weixin.qq.com/s/MuPfayYTk9ZW6lcqgMpqKA)
2424
- [2023.12.01] Multi-Agent和代码库检索功能开放
@@ -41,13 +41,13 @@ CodeFuse-ChatBot是由蚂蚁CodeFuse团队开发的开源AI智能助手,致力
4141
💡 本项目旨在通过检索增强生成(Retrieval Augmented Generation,RAG)、工具学习(Tool Learning)和沙盒环境来构建软件开发全生命周期的AI智能助手,涵盖设计、编码、测试、部署和运维等阶段。 逐渐从各处资料查询、独立分散平台操作的传统开发运维模式转变到大模型问答的智能化开发运维模式,改变人们的开发运维习惯。
4242

4343
本项目核心差异技术、功能点:
44-
- **🧠 智能调度核心:** 构建了体系链路完善的调度核心,支持多模式一键配置,简化操作流程。 [使用说明](sources/readme_docs/coagent/coagent.md)
44+
- **🧠 智能调度核心:** 构建了体系链路完善的调度核心,支持多模式一键配置,简化操作流程。 [使用说明](https://codefuse-ai.github.io/zh-CN/docs/api-docs/MuAgent/overview/multi-agent)
4545
- **💻 代码整库分析:** 实现了仓库级的代码深入理解,以及项目文件级的代码编写与生成,提升了开发效率。
4646
- **📄 文档分析增强:** 融合了文档知识库与知识图谱,通过检索和推理增强,为文档分析提供了更深层次的支持。
4747
- **🔧 垂类专属知识:** 为DevOps领域定制的专属知识库,支持垂类知识库的自助一键构建,便捷实用。
4848
- **🤖 垂类模型兼容:** 针对DevOps领域的小型模型,保证了与DevOps相关平台的兼容性,促进了技术生态的整合。
4949

50-
🌍 依托于开源的 LLM 与 Embedding 模型,本项目可实现基于开源模型的离线私有部署。此外,本项目也支持 OpenAI API 的调用。[接入Demo](sources/readme_docs/fastchat.md)
50+
🌍 依托于开源的 LLM 与 Embedding 模型,本项目可实现基于开源模型的离线私有部署。此外,本项目也支持 OpenAI API 的调用。[接入Demo](https://codefuse-ai.github.io/zh-CN/docs/developer-docs/CodeFuse-ChatBot/master/fastchat)
5151

5252
👥 核心研发团队长期专注于 AIOps + NLP 领域的研究。我们发起了 Codefuse-ai 项目,希望大家广泛贡献高质量的开发和运维文档,共同完善这套解决方案,以实现“让天下没有难做的开发”的目标。
5353

@@ -80,8 +80,8 @@ CodeFuse-ChatBot是由蚂蚁CodeFuse团队开发的开源AI智能助手,致力
8080
- 💬 **LLM:**:智能体大脑,支持多种开源模型和 LLM 接口。
8181
- 🛠️ **API Management::** API 管理工具,实现对开源组件和运维平台的快速集成。
8282

83-
具体实现明细见:[技术路线明细](sources/readme_docs/roadmap.md)
84-
83+
具体实现明细见:[技术路线明细](https://codefuse-ai.github.io/zh-CN/docs/developer-docs/CodeFuse-ChatBot/master/roadmap)
84+
项目计划跟进见:[Projects](https://github.com/orgs/codefuse-ai/projects/1)
8585

8686

8787
## 🌐 模型接入
@@ -97,15 +97,15 @@ CodeFuse-ChatBot是由蚂蚁CodeFuse团队开发的开源AI智能助手,致力
9797

9898
## 🚀 快速使用
9999
### muagent-py
100-
完整文档见:[CodeFuse-muAgent](sources/readme_docs/coagent/coagent.md)
100+
完整文档见:[CodeFuse-muAgent](https://codefuse-ai.github.io/zh-CN/docs/api-docs/MuAgent/overview/multi-agent)
101101
```
102102
pip install codefuse-muagent
103103
```
104104

105105
### 使用ChatBot
106106
请自行安装 nvidia 驱动程序,本项目已在 Python 3.9.18,CUDA 11.7 环境下,Windows、X86 架构的 macOS 系统中完成测试。
107107

108-
Docker安装、私有化LLM接入及相关启动问题见:[快速使用明细](sources/readme_docs/start.md)
108+
Docker安装、私有化LLM接入及相关启动问题见:[快速使用明细](https://codefuse-ai.github.io/zh-CN/docs/developer-docs/CodeFuse-ChatBot/master/quickstart)
109109

110110
1、python 环境准备
111111

@@ -135,8 +135,8 @@ bash start.sh
135135
</div>
136136

137137

138-
或者通过`start.py`进行启动[老版启动方式](sources/readme_docs/start.md)
139-
更多LLM接入方法见[更多细节...](sources/readme_docs/fastchat.md)
138+
或者通过`start.py`进行启动[老版启动方式](https://codefuse-ai.github.io/zh-CN/docs/developer-docs/CodeFuse-ChatBot/master/start-detail)
139+
更多LLM接入方法见[更多细节...](https://codefuse-ai.github.io/zh-CN/docs/developer-docs/CodeFuse-ChatBot/master/fastchat)
140140
<br>
141141

142142

@@ -145,7 +145,7 @@ bash start.sh
145145

146146
您对 Codefuse 的各种建议、意见、评论可以直接通过 GitHub 的 Issues 提出。
147147

148-
参与 Codefuse 项目并为其作出贡献的方法有很多:代码实现、测试编写、流程工具改进、文档完善等等。任何贡献我们都会非常欢迎,并将您加入贡献者列表。详见[Contribution Guide...](sources/readme_docs/contribution/contribute_guide.md)
148+
参与 Codefuse 项目并为其作出贡献的方法有很多:代码实现、测试编写、流程工具改进、文档完善等等。任何贡献我们都会非常欢迎,并将您加入贡献者列表。详见[Contribution Guide...](https://codefuse-ai.github.io/zh-CN/contribution/contribution)
149149

150150
## 🤗 致谢
151151

README_en.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This project is an open-source AI intelligent assistant, specifically designed f
1717

1818

1919
## 🔔 Updates
20-
- [2024.01.29] A configurational multi-agent framework, codefuse-muagent, has been open-sourced. For more details, please refer to [codefuse-muagent](sources/readme_docs/coagent/coagent-en.md)
20+
- [2024.01.29] A configurational multi-agent framework, codefuse-muagent, has been open-sourced. For more details, please refer to [codefuse-muagent](https://codefuse-ai.github.io/docs/api-docs/MuAgent/overview/multi-agent)
2121
- [2023.12.26] Opening the capability to integrate with open-source private large models and large model interfaces based on FastChat
2222
- [2023.12.01] Release of Multi-Agent and codebase retrieval functionalities.
2323
- [2023.11.15] Addition of Q&A enhancement mode based on the local codebase.
@@ -34,13 +34,13 @@ This project is an open-source AI intelligent assistant, specifically designed f
3434

3535
💡 The aim of this project is to construct an AI intelligent assistant for the entire lifecycle of software development, covering design, coding, testing, deployment, and operations, through Retrieval Augmented Generation (RAG), Tool Learning, and sandbox environments. It transitions gradually from the traditional development and operations mode of querying information from various sources and operating on standalone, disparate platforms to an intelligent development and operations mode based on large-model Q&A, changing people's development and operations habits.
3636

37-
- **🧠 Intelligent Scheduling Core:** Constructed a well-integrated scheduling core system that supports multi-mode one-click configuration, simplifying the operational process. [codefuse-muagent](sources/readme_docs/coagent/coagent-en.md)
37+
- **🧠 Intelligent Scheduling Core:** Constructed a well-integrated scheduling core system that supports multi-mode one-click configuration, simplifying the operational process. [codefuse-muagent](https://codefuse-ai.github.io/docs/api-docs/MuAgent/overview/multi-agent)
3838
- **💻 Comprehensive Code Repository Analysis:** Achieved in-depth understanding at the repository level and coding and generation at the project file level, enhancing development efficiency.
3939
- **📄 Enhanced Document Analysis:** Integrated document knowledge bases with knowledge graphs, providing deeper support for document analysis through enhanced retrieval and reasoning.
4040
- **🔧 Industry-Specific Knowledge:** Tailored a specialized knowledge base for the DevOps domain, supporting the self-service one-click construction of industry-specific knowledge bases for convenience and practicality.
4141
- **🤖 Compatible Models for Specific Verticals:** Designed small models specifically for the DevOps field, ensuring compatibility with related DevOps platforms and promoting the integration of the technological ecosystem.
4242

43-
🌍 Relying on open-source LLM and Embedding models, this project can achieve offline private deployments based on open-source models. Additionally, this project also supports the use of the OpenAI API.[Access Demo](sources/readme_docs/fastchat-en.md)
43+
🌍 Relying on open-source LLM and Embedding models, this project can achieve offline private deployments based on open-source models. Additionally, this project also supports the use of the OpenAI API.[Access Demo](https://codefuse-ai.github.io/docs/developer-docs/CodeFuse-ChatBot/master/fastchat)
4444

4545
👥 The core development team has been long-term focused on research in the AIOps + NLP domain. We initiated the CodefuseGPT project, hoping that everyone could contribute high-quality development and operations documents widely, jointly perfecting this solution to achieve the goal of "Making Development Seamless for Everyone."
4646

@@ -68,8 +68,8 @@ This project is an open-source AI intelligent assistant, specifically designed f
6868
- 💬 **LLM:**:Supports various open-source models and LLM interfaces.
6969
- 🛠️ **API Management::** Enables rapid integration of open-source components and operational platforms.
7070

71-
For implementation details, see: [Technical Route Details](sources/readme_docs/roadmap-en.md)
72-
71+
For implementation details, see: [Technical Route Details](https://codefuse-ai.github.io/docs/developer-docs/CodeFuse-ChatBot/master/roadmap)
72+
Follow Projects:[Projects](https://github.com/orgs/codefuse-ai/projects/1)
7373

7474
## 🌐 Model Integration
7575

@@ -84,7 +84,7 @@ If you need to integrate a specific model, please inform us of your requirements
8484

8585
## 🚀 Quick Start
8686
### muagent-py
87-
More Detail see:[codefuse-muagent](sources/readme_docs/coagent/coagent-en.md)
87+
More Detail see:[codefuse-muagent](https://codefuse-ai.github.io/docs/api-docs/MuAgent/overview/multi-agent)
8888
```
8989
pip install codefuse-muagent
9090
```
@@ -119,16 +119,16 @@ bash start.sh
119119
<img src="sources/docs_imgs/webui_config.png" alt="图片">
120120
</div>
121121

122-
Or `python start.py` by [old version to start](sources/readme_docs/start-en.md)
123-
More details about accessing LLM Moldes[More Details...](sources/readme_docs/fastchat.md)
122+
Or `python start.py` by [old version to start](https://codefuse-ai.github.io/docs/developer-docs/CodeFuse-ChatBot/master/start-detail)
123+
More details about accessing LLM Moldes[More Details...](https://codefuse-ai.github.io/docs/developer-docs/CodeFuse-ChatBot/master/fastchat)
124124
<br>
125125

126126
## Contribution
127127
Thank you for your interest in the Codefuse project. We warmly welcome any suggestions, opinions (including criticisms), comments, and contributions to the Codefuse project.
128128

129129
Your suggestions, opinions, and comments on Codefuse can be directly submitted through GitHub Issues.
130130

131-
There are many ways to participate in the Codefuse project and contribute to it: code implementation, test writing, process tool improvement, documentation enhancement, and more. We welcome any contributions and will add you to our list of contributors. See [contribution guide](sources/readme_docs/contribution/contribute_guide_en.md)
131+
There are many ways to participate in the Codefuse project and contribute to it: code implementation, test writing, process tool improvement, documentation enhancement, and more. We welcome any contributions and will add you to our list of contributors. See [contribution guide](https://codefuse-ai.github.io/contribution/contribution)
132132

133133
## 🤗 Acknowledgements
134134

0 commit comments

Comments
 (0)