Skip to content

Commit c19ff9c

Browse files
committed
doc: Update README files to include docker deployment links
1 parent 4f28eca commit c19ff9c

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ GC-QA-RAG 项目采用模块化架构,包含 ETL(知识库构建)、Server
4040
- ETL 前端:`cd sources/gc-qa-rag-etl/etlapp-web && pnpm install && pnpm run dev`
4141
- Server:`cd sources/gc-qa-rag-server && pdm install && pdm run dev`
4242
- Frontend:`cd sources/gc-qa-rag-frontend && pnpm install && pnpm run dev`
43-
3. 生产环境建议使用 Docker 部署
43+
3. 生产环境建议使用 [Docker 部署](https://grapecity-ai.github.io/gc-qa-rag/2-%E5%BC%80%E5%8F%91%E6%95%99%E7%A8%8B/1-Docker%E9%83%A8%E7%BD%B2/)
4444

4545
## 概述
4646

README_ENGLISH.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@
1919

2020
The GC-QA-RAG project adopts a modular architecture, including three core modules: ETL (knowledge base construction), Server (retrieval Q&A - backend services), and Frontend (retrieval Q&A - main frontend interface). Each module can be independently developed, tested, and deployed, supporting both local and Docker containerized operation.
2121

22-
- It is recommended to first read the [Quick Start](./quickstart_ENGLISH.md) document for detailed environment preparation, dependency installation, and module startup instructions.
23-
- The typical startup process is as follows:
22+
- It is recommended to first read the [Quick Start](./quickstart_ENGLISH.md) document for detailed environment preparation, dependency installation, and module startup instructions.
23+
- The typical startup process is as follows:
2424

2525
1. Install Dependencies
26-
- Python 3.13, Node.js 16+, PDM, pnpm, MySQL, Qdrant
26+
- Python 3.13, Node.js 16+, PDM, pnpm, MySQL, Qdrant
2727
2. Module Compilation and Running
28-
- ETL Main Program: `cd sources/gc-qa-rag-etl && pdm install && pdm run dev`
29-
- ETL Frontend: `cd sources/gc-qa-rag-etl/etlapp-web && pnpm install && pnpm run dev`
30-
- Server: `cd sources/gc-qa-rag-server && pdm install && pdm run dev`
31-
- Frontend: `cd sources/gc-qa-rag-frontend && pnpm install && pnpm run dev`
32-
3. Docker deployment is recommended for production environments
28+
- ETL Main Program: `cd sources/gc-qa-rag-etl && pdm install && pdm run dev`
29+
- ETL Frontend: `cd sources/gc-qa-rag-etl/etlapp-web && pnpm install && pnpm run dev`
30+
- Server: `cd sources/gc-qa-rag-server && pdm install && pdm run dev`
31+
- Frontend: `cd sources/gc-qa-rag-frontend && pnpm install && pnpm run dev`
32+
3. Docker deployment is recommended for production environments. See also: [Docker Deployment](https://grapecity-ai.github.io/gc-qa-rag/2-%E5%BC%80%E5%8F%91%E6%95%99%E7%A8%8B/1-Docker%E9%83%A8%E7%BD%B2/)
3333

3434
## Overview
3535

0 commit comments

Comments
 (0)