添加开发文档。 - #5437
Closed
zhangzhichaolove wants to merge 2 commits into
Closed
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds multilingual development documentation and links it from each localized README to help contributors set up local dev environments consistently.
Changes:
- Added new Development Guide docs in English, Simplified Chinese, Traditional Chinese, Japanese, and French under
docs/development/. - Added “Development Guide” links to the localized READMEs pointing to the new local documentation.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/development/DEVELOPMENT.md | Adds English local development guide and troubleshooting. |
| docs/development/DEVELOPMENT.zh_CN.md | Adds Simplified Chinese version of the development guide. |
| docs/development/DEVELOPMENT.zh_TW.md | Adds Traditional Chinese version of the development guide. |
| docs/development/DEVELOPMENT.ja.md | Adds Japanese version of the development guide. |
| docs/development/DEVELOPMENT.fr.md | Adds French version of the development guide. |
| README.md | Adds a link to the new English development guide. |
| README.en.md | Adds a link to the new English development guide. |
| README.zh_CN.md | Adds a link to the new Simplified Chinese development guide. |
| README.zh_TW.md | Adds a link to the new Traditional Chinese development guide. |
| README.ja.md | Adds a link to the new Japanese development guide. |
| README.fr.md | Adds a link to the new French development guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| > **Prerequisites**: Since Go uses `//go:embed` to embed frontend files, you must build the frontend once before the first startup, otherwise an error will occur. | ||
|
|
||
| #### 1. First-Time Setup | ||
|
|
Comment on lines
+3
to
+9
| <p align="center"> | ||
| <a href="./DEVELOPMENT.zh_CN.md">简体中文</a> | | ||
| <a href="./DEVELOPMENT.zh_TW.md">繁體中文</a> | | ||
| <a href="./DEVELOPMENT.md">English</a> | | ||
| <a href="./DEVELOPMENT.fr.md">Français</a> | | ||
| <a href="./DEVELOPMENT.ja.md">日本語</a> | ||
| </p> |
| bun run build | ||
| cd ../.. | ||
|
|
||
| # 立即刪除構建產物 (防止後端服務靜態檔案) |
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
WalkthroughThis PR adds localized developer guides (EN/FR/JA/zh_CN/zh_TW) and updates six README files to include “Development Guide” links pointing to the corresponding DEVELOPMENT.md documents. ChangesMultilingual Development Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Important
📝 变更描述 / Description
为项目添加了完整的开发文档（DEVELOPMENT.md），帮助开发者快速搭建本地开发环境。
主要内容：
为什么这样改：
//go:embed机制导致开发时需要特殊处理，未说明会导致新手开发者遇到报错变更细节：
docs/development/DEVELOPMENT.*.md（5 个语言版本）🚀 变更类型 / Type of change
🔗 关联任务 / Related Issue
无
✅ 提交前检查项 / Checklist
📸 运行证明 / Proof of Work
已在本地成功验证以下流程：
文档位置：
docs/development/DEVELOPMENT.md及其他语言版本README 更新： 所有语言版本的文档部分已添加"开发指南"入口
Summary by CodeRabbit