Skip to content

feat: update docs #1433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
earayu merged 1 commit into from
Jan 29, 2026
Merged

feat: update docs #1433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/en-US/build-docker-image.md → docs/en-US/development/build-docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Build Guide

[阅读中文文档](build-docker-image-zh.md)

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".

## Building Container Images
Expand Down
2 changes: 0 additions & 2 deletions docs/en-US/development-guide.md → docs/en-US/development/development-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# 🛠️ Development Guide

[阅读中文文档](development-guide-zh.md)

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.

## 🚀 Development Environment Setup
Expand Down
19 changes: 10 additions & 9 deletions docs/en-US/development/dify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,16 @@ ApeRAG is a production-grade RAG platform with multimodal indexing, AI agents, M
## Video Demo

<div align="center">
<iframe src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
scrolling="no"
border="0"
frameborder="no"
framespacing="0"
allowfullscreen="true"
width="800"
height="600"
style="max-width: 100%;">
<iframe
src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
scrolling="no"
border="0"
frameborder="no"
framespacing="0"
allowfullscreen
width="800"
height="600"
style="max-width: 100%;">
</iframe>
</div>

Expand Down
7 changes: 5 additions & 2 deletions docs/zh-CN/build-docker-image.md → docs/zh-CN/development/build-docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 构建指南
---
title: 构建 Docker 镜像
description: 如何构建 ApeRAG 容器镜像
---

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

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

Expand Down
9 changes: 6 additions & 3 deletions docs/zh-CN/development-guide.md → docs/zh-CN/development/development-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 🛠️ 开发指南
---
title: 开发指南
description: ApeRAG 开发环境设置和工作流程
---

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

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

Expand Down Expand Up @@ -128,7 +131,7 @@ make run-frontend
### 8. 🌐 访问 ApeRAG

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

Expand Down
19 changes: 10 additions & 9 deletions docs/zh-CN/development/dify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,16 @@ ApeRAG 是一款具备多模态索引、AI 智能体、MCP 支持及可扩展 K8
## 视频演示

<div align="center">
<iframe src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
scrolling="no"
border="0"
frameborder="no"
framespacing="0"
allowfullscreen="true"
width="800"
height="600"
style="max-width: 100%;">
<iframe
src="//player.bilibili.com/player.html?bvid=BV1TRzABDEs3&page=1"
scrolling="no"
border="0"
frameborder="no"
framespacing="0"
allowfullscreen
width="800"
height="600"
style="max-width: 100%;">
</iframe>
</div>

Expand Down
12 changes: 12 additions & 0 deletions scripts/sync-docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@
# English docs - Development
"en-US/development/dify.md",
"en-US/development/mcp-api.md",
"en-US/development/build-docker-image.md",
"en-US/development/development-guide.md",

# English docs - Reference
# "en-US/reference/how-to-configure-ollama.md",
# "en-US/reference/HOW-TO-DEBUG.md",

# Chinese docs - Design
"zh-CN/design/architecture.md",
Expand All @@ -94,6 +100,12 @@
# Chinese docs - Development
"zh-CN/development/dify.md",
"zh-CN/development/mcp-api.md",
"zh-CN/development/build-docker-image.md",
"zh-CN/development/development-guide.md",

# Chinese docs - Reference
# "zh-CN/reference/how-to-configure-ollama.md",
# "zh-CN/reference/HOW-TO-DEBUG.md",
]


Expand Down
242 changes: 0 additions & 242 deletions web/docs/en-US/about-aperag.md
View file
Open in desktop

This file was deleted.

Loading
Loading