Translate README to English and fix invalid badges by Copilot · Pull Request #6 · BukeLy/rag-api

Copilot · 2025-12-12T05:20:59Z

更新 README 到英文版本并修复无效 Badges

任务清单

完成情况

✅ 完全完成 - README 已100%翻译为英文版本，两个版本的 Badges 均已修复

主 README.md 现在是英文版（1277行全部翻译）
中文版本保存为 README.zh-CN.md
CI Badge 已修复（英文和中文版本）：YOUR_USERNAME → BukeLy/rag-api
添加语言切换器（两个版本）：English | 简体中文
所有章节、表格、代码注释、Mermaid图表均已翻译

Original prompt

更新README英文版（主README为英文，可以选择语言），并去除无效Badges

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Translate main README.md from Chinese to English - Fix CI badge: change YOUR_USERNAME to BukeLy/rag-api - Add language switcher: English/简体中文 - Backup original Chinese README as README.zh-CN.md - Translate all sections: Introduction, Features, Architecture, Quick Start, API Documentation, Deployment, Multi-tenant Usage, Troubleshooting, Contributing - Translate Mermaid diagrams, tables, code comments, and examples - 100% English translation complete (except language switcher label) Co-authored-by: BukeLy <19304666+BukeLy@users.noreply.github.com>

BukeLy

修复中文文档的Badge

README.zh-CN.md

- Fix CI badge: change YOUR_USERNAME to BukeLy/rag-api - Add language switcher to Chinese README for consistency Co-authored-by: BukeLy <19304666+BukeLy@users.noreply.github.com>

Copilot · 2025-12-12T05:42:28Z

修复中文文档的Badge

Fixed in commit 067737d. Updated the CI badge URL in README.zh-CN.md from YOUR_USERNAME to BukeLy/rag-api, and added the language switcher.

Copilot

Pull request overview

This PR successfully translates the README from Chinese to English and fixes invalid CI badges. The main README.md is now in English with the original Chinese version saved as README.zh-CN.md, with bidirectional language switchers added to both files.

Key Changes

Complete translation of README.md (1,277 lines) from Chinese to English covering all sections including features, architecture diagrams, API documentation, deployment guides, and troubleshooting
Fixed CI badge placeholder YOUR_USERNAME to BukeLy/rag-api in both English and Chinese versions
Added language switcher links [English](README.md) | [简体中文](README.zh-CN.md) at the top of both files

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File	Description
README.md	Fully translated to English; CI badge fixed; language switcher added; minor spacing/punctuation issues in some sections
README.zh-CN.md	New file containing original Chinese content; CI badge fixed; language switcher added

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-12T05:48:23Z

README.md

- `full`: ~120 秒（完整上下文处理）
+**Processing Time Estimate** (20-page PDF example):
+- `off`: ~10 seconds(Markdown only)
+- `selective`: ~30 seconds(5-10 important charts)


Missing space after "~30 seconds". Should be "~30 seconds (5-10 important charts)"

Suggested change

- `selective`: ~30 seconds(5-10 important charts)

- `selective`: ~30 seconds (5-10 important charts)

Copilot · 2025-12-12T05:48:23Z

README.md

+**Processing Time Estimate** (20-page PDF example):
+- `off`: ~10 seconds(Markdown only)
+- `selective`: ~30 seconds(5-10 important charts)
+- `full`: ~120 seconds(complete context processing)


Missing space after "~120 seconds". Should be "~120 seconds (complete context processing)"

Suggested change

- `full`: ~120 seconds(complete context processing)

- `full`: ~120 seconds (complete context processing)

Copilot · 2025-12-12T05:48:24Z

README.md

+| `max_entity_tokens` | int | Entity token limit | `6000` |

-完整 API 文档访问：http://localhost:8000/docs
+Complete API documentation:http://localhost:8000/docs


Missing space after "documentation:". Should be "Complete API documentation: http://localhost:8000/docs"

Suggested change

Complete API documentation:http://localhost:8000/docs

Complete API documentation: http://localhost:8000/docs

Copilot · 2025-12-12T05:48:24Z

README.md

 ```

-详细配置参考 [外部存储部署文档](docs/DEPLOYMENT_EXTERNAL_STORAGE.md)。
+See [External Storage Deployment Documentation](docs/DEPLOYMENT_EXTERNAL_STORAGE.md)。


Missing period at the end of the sentence. Should be "See External Storage Deployment Documentation."

Suggested change

See [External Storage Deployment Documentation](docs/DEPLOYMENT_EXTERNAL_STORAGE.md)。

See [External Storage Deployment Documentation](docs/DEPLOYMENT_EXTERNAL_STORAGE.md).

Copilot · 2025-12-12T05:48:24Z

README.md

+- `chore:` Build/tools

-详见 [PR 工作流程文档](docs/PR_WORKFLOW.md)。
+See [PR Workflow Documentation](docs/PR_WORKFLOW.md)。


Remove unnecessary period at the end of the link text. Should be "See PR Workflow Documentation"

Suggested change

See [PR Workflow Documentation](docs/PR_WORKFLOW.md)。

See [PR Workflow Documentation](docs/PR_WORKFLOW.md)

Copilot · 2025-12-12T05:48:25Z

README.md

-   - 确保 `.env` 中配置了 LLM API（豆包）
+**Check Items**:
+1. **vision_model_func not configured**
+   - Check logs:`vision_model_func not found, fallback to off mode`


Inconsistent capitalization: "Check logs:" should be "Check logs: " with a space before the backticks for consistency.

Copilot · 2025-12-12T05:48:25Z

README.md

+- `off`: ~10 seconds(Markdown only)
+- `selective`: ~30 seconds(5-10 important charts)
+- `full`: ~120 seconds(complete context processing)


Missing space after "~10 seconds". Should be "~10 seconds (Markdown only)"

Suggested change

- `off`: ~10 seconds(Markdown only)

- `selective`: ~30 seconds(5-10 important charts)

- `full`: ~120 seconds(complete context processing)

- `off`: ~10 seconds (Markdown only)

- `selective`: ~30 seconds (5-10 important charts)

- `full`: ~120 seconds (complete context processing)

Copilot · 2025-12-12T05:48:25Z

README.md

+    "embedding": {...},  // Using Global Config
+    "rerank": {...},     // Using Global Config
+    "ds_ocr": {...},     // Using tenant config
+    "mineru": {...}      // Using Global Config


The translation "Using Global Config" appears twice with different capitalization. For consistency, use "Using global config" (lowercase 'g' and 'c') to match the pattern used for other entries in this diagram.

Suggested change

"mineru": {...} // Using Global Config

"mineru": {...} // Using global config

Copilot · 2025-12-12T05:48:25Z

README.md

-   - 检查日志：`Image file not found: xxx`
-   - 可能是 MinerU ZIP 损坏或解压失败
+2. **Image file does not exist**
+   - Check logs:`Image file not found: xxx`


Missing space after "logs:". Should be "Check logs: Image file not found: xxx"

Copilot · 2025-12-12T05:48:25Z

README.md

-RAG_VLM_MODE=selective  # 降级到 selective
+# Modify .env
+VLM_TIMEOUT=300  # Increase to 5 minutes
+RAG_VLM_MODE=selective  # downgrade to selective


The word "downgrade" should be capitalized at the beginning of the comment. Should be "# Downgrade to selective"

Suggested change

RAG_VLM_MODE=selective # downgrade to selective

RAG_VLM_MODE=selective # Downgrade to selective

Initial plan

1f8478e

Copilot AI assigned Copilot and BukeLy Dec 12, 2025

Copilot started work on behalf of BukeLy December 12, 2025 05:21 View session

Copilot AI changed the title ~~[WIP] Update English version of README and remove invalid badges~~ Translate README to English and fix invalid badges Dec 12, 2025

Copilot AI requested a review from BukeLy December 12, 2025 05:39

Copilot finished work on behalf of BukeLy December 12, 2025 05:39

BukeLy requested changes Dec 12, 2025

View reviewed changes

README.zh-CN.md Outdated Show resolved Hide resolved

Copilot started work on behalf of BukeLy December 12, 2025 05:40 View session

Fix badges in Chinese README (README.zh-CN.md)

067737d

- Fix CI badge: change YOUR_USERNAME to BukeLy/rag-api - Add language switcher to Chinese README for consistency Co-authored-by: BukeLy <19304666+BukeLy@users.noreply.github.com>

Copilot AI requested a review from BukeLy December 12, 2025 05:43

Copilot finished work on behalf of BukeLy December 12, 2025 05:43

BukeLy marked this pull request as ready for review December 12, 2025 05:44

Copilot AI review requested due to automatic review settings December 12, 2025 05:44

Copilot started reviewing on behalf of BukeLy December 12, 2025 05:44 View session

BukeLy merged commit 3c53526 into main Dec 12, 2025
4 checks passed

BukeLy deleted the copilot/update-readme-english-version branch December 12, 2025 05:44

Copilot AI reviewed Dec 12, 2025

View reviewed changes

	- `selective`: ~30 seconds(5-10 important charts)
	- `selective`: ~30 seconds (5-10 important charts)

	- `full`: ~120 seconds(complete context processing)
	- `full`: ~120 seconds (complete context processing)

	Complete API documentation:http://localhost:8000/docs
	Complete API documentation: http://localhost:8000/docs

	See [External Storage Deployment Documentation](docs/DEPLOYMENT_EXTERNAL_STORAGE.md)。
	See [External Storage Deployment Documentation](docs/DEPLOYMENT_EXTERNAL_STORAGE.md).

	See [PR Workflow Documentation](docs/PR_WORKFLOW.md)。
	See [PR Workflow Documentation](docs/PR_WORKFLOW.md)

	"mineru": {...} // Using Global Config
	"mineru": {...} // Using global config

	RAG_VLM_MODE=selective # downgrade to selective
	RAG_VLM_MODE=selective # Downgrade to selective

Conversation

Copilot AI commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

更新 README 到英文版本并修复无效 Badges

任务清单

完成情况

Uh oh!

BukeLy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI commented Dec 12, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Dec 12, 2025 •

edited

Loading