Skip to content

Commit aa5e115

Browse files
earayuearayu
authored
feat: update docs (#1433)
1 parent 187f3ad commit aa5e115

File tree

15 files changed

+155
-705
lines changed

15 files changed

+155
-705
lines changed

docs/en-US/build-docker-image.md renamed to docs/en-US/development/build-docker-image.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Build Guide
22

3-
[阅读中文文档](build-docker-image-zh.md)
4-
53
This section covers how to build ApeRAG container images. It's primarily for users who need to create their own builds or deploy to environments other than the ones covered in "Getting Started".
64

75
## Building Container Images

docs/en-US/development-guide.md renamed to docs/en-US/development/development-guide.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# 🛠️ Development Guide
22

3-
[阅读中文文档](development-guide-zh.md)
4-
53
This guide focuses on setting up a development environment and the development workflow for ApeRAG. This is designed for developers looking to contribute to ApeRAG or run it locally for development purposes.
64

75
## 🚀 Development Environment Setup

‎docs/en-US/development/dify.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ ApeRAG is a production-grade RAG platform with multimodal indexing, AI agents, M
1616
## Video Demo
1717

1818
<div align="center">
19-
<iframe src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
20-
scrolling="no"
21-
border="0"
22-
frameborder="no"
23-
framespacing="0"
24-
allowfullscreen="true"
25-
width="800"
26-
height="600"
27-
style="max-width: 100%;">
19+
<iframe
20+
src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
21+
scrolling="no"
22+
border="0"
23+
frameborder="no"
24+
framespacing="0"
25+
allowfullscreen
26+
width="800"
27+
height="600"
28+
style="max-width: 100%;">
2829
</iframe>
2930
</div>
3031

docs/zh-CN/build-docker-image.md renamed to docs/zh-CN/development/build-docker-image.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# 构建指南
1+
---
2+
title: 构建 Docker 镜像
3+
description: 如何构建 ApeRAG 容器镜像
4+
---
25

3-
[Read English Documentation](build-docker-image.md)
6+
# 构建指南
47

58
本节介绍如何构建 ApeRAG 容器镜像。这主要适用于需要创建自己的构建或部署到"快速开始"中未涵盖的环境的用户。
69

docs/zh-CN/development-guide.md renamed to docs/zh-CN/development/development-guide.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# 🛠️ 开发指南
1+
---
2+
title: 开发指南
3+
description: ApeRAG 开发环境设置和工作流程
4+
---
25

3-
[Read English Documentation](development-guide.md)
6+
# 🛠️ 开发指南
47

58
本指南重点介绍如何为 ApeRAG 设置开发环境和开发工作流程。这是为希望为 ApeRAG 做贡献或在本地运行它进行开发的开发人员设计的。
69

@@ -128,7 +131,7 @@ make run-frontend
128131
### 8. 🌐 访问 ApeRAG
129132

130133
服务运行后，您可以访问：
131-
* **前端 UI**：http://localhost:3000（如果已启动）
134+
* **前端 UI**：http://localhost:3000 (如果已启动)
132135
* **后端 API**：http://localhost:8000
133136
* **API 文档**：http://localhost:8000/docs
134137

‎docs/zh-CN/development/dify.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,16 @@ ApeRAG 是一款具备多模态索引、AI 智能体、MCP 支持及可扩展 K8
1616
## 视频演示
1717

1818
<div align="center">
19-
<iframe src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
20-
scrolling="no"
21-
border="0"
22-
frameborder="no"
23-
framespacing="0"
24-
allowfullscreen="true"
25-
width="800"
26-
height="600"
27-
style="max-width: 100%;">
19+
<iframe
20+
src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
21+
scrolling="no"
22+
border="0"
23+
frameborder="no"
24+
framespacing="0"
25+
allowfullscreen
26+
width="800"
27+
height="600"
28+
style="max-width: 100%;">
2829
</iframe>
2930
</div>
3031

‎scripts/sync-docs.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,12 @@
8484
# English docs - Development
8585
"en-US/development/dify.md",
8686
"en-US/development/mcp-api.md",
87+
"en-US/development/build-docker-image.md",
88+
"en-US/development/development-guide.md",
89+
90+
# English docs - Reference
91+
# "en-US/reference/how-to-configure-ollama.md",
92+
# "en-US/reference/HOW-TO-DEBUG.md",
8793

8894
# Chinese docs - Design
8995
"zh-CN/design/architecture.md",
@@ -94,6 +100,12 @@
94100
# Chinese docs - Development
95101
"zh-CN/development/dify.md",
96102
"zh-CN/development/mcp-api.md",
103+
"zh-CN/development/build-docker-image.md",
104+
"zh-CN/development/development-guide.md",
105+
106+
# Chinese docs - Reference
107+
# "zh-CN/reference/how-to-configure-ollama.md",
108+
# "zh-CN/reference/HOW-TO-DEBUG.md",
97109
]
98110

99111

‎web/docs/en-US/about-aperag.md‎

Lines changed: 0 additions & 242 deletions
This file was deleted.

0 commit comments

Comments
 (0)