docs(getting-start): 添加 Electron 镜像安装说明 - #21
Open
Craun718 wants to merge 2 commits into
Open
Conversation
审阅者指南更新了中文和英文的入门文档，在 Electron 二进制文件下载缓慢或失败时，通过 npmmirror 镜像进行一次性 Electron 安装，并在疑难解答检查列表中添加相同命令，以保持两种语言内容同步。 文件级改动
提示与命令与 Sourcery 交互
自定义你的体验前往你的 dashboard 来：
获取帮助Original review guide in EnglishReviewer's GuideUpdates Chinese and English getting-started docs to document a one-shot Electron installation via an npmmirror mirror when binary downloads are slow or failing, and adds the same command to the troubleshooting checklists to keep both languages in sync. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - 我发现了 1 个问题，并留下了一些总体反馈：
- 请考虑说明该命令假设
cross-env已可用（全局或作为项目依赖），否则部分用户可能会遇到“command not found”的错误。 - 在 FAQ 的第 4 步中，你可能希望将完整的
yarn cross-env ELECTRON_MIRROR=... yarn install命令单独放在一个围栏代码块中，以提升可读性，并与前面的安装说明在格式上保持一致。
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider clarifying that this command assumes `cross-env` is available (either globally or as a project dependency), as some users may hit a “command not found” error otherwise.
- In the FAQ step 4 lines, you may want to put the full `yarn cross-env ELECTRON_MIRROR=... yarn install` command in its own fenced code block for readability and to keep formatting consistent with the earlier install instructions.
## Individual Comments
### Comment 1
<location path="en/developer/getting-start.md" line_range="83" />
<code_context>
yarn install
```
+If the Electron binary download is slow or fails, use the npmmirror for a one-shot install:
+
+```bash
</code_context>
<issue_to_address>
**suggestion (typo):** Consider dropping the article before "npmmirror" for more natural phrasing.
Because "npmmirror" is a proper service/domain name, it sounds more natural without an article. For example: "use npmmirror for a one-shot install."
```suggestion
If the Electron binary download is slow or fails, use npmmirror for a one-shot install:
```
</issue_to_address>帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've found 1 issue, and left some high level feedback:
- Consider clarifying that this command assumes
cross-envis available (either globally or as a project dependency), as some users may hit a “command not found” error otherwise. - In the FAQ step 4 lines, you may want to put the full
yarn cross-env ELECTRON_MIRROR=... yarn installcommand in its own fenced code block for readability and to keep formatting consistent with the earlier install instructions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider clarifying that this command assumes `cross-env` is available (either globally or as a project dependency), as some users may hit a “command not found” error otherwise.
- In the FAQ step 4 lines, you may want to put the full `yarn cross-env ELECTRON_MIRROR=... yarn install` command in its own fenced code block for readability and to keep formatting consistent with the earlier install instructions.
## Individual Comments
### Comment 1
<location path="en/developer/getting-start.md" line_range="83" />
<code_context>
yarn install
```
+If the Electron binary download is slow or fails, use the npmmirror for a one-shot install:
+
+```bash
</code_context>
<issue_to_address>
**suggestion (typo):** Consider dropping the article before "npmmirror" for more natural phrasing.
Because "npmmirror" is a proper service/domain name, it sounds more natural without an article. For example: "use npmmirror for a one-shot install."
```suggestion
If the Electron binary download is slow or fails, use npmmirror for a one-shot install:
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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
1 participant
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.
变更内容
ELECTRON_MIRROR指向 npmmirror 镜像执行一次性安装，不修改全局配置说明
新增命令仅对本次
yarn install生效：yarn cross-env ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" yarn install目的是避免用户因 Electron 二进制下载问题卡在环境搭建阶段。
来自 Sourcery 的总结
记录一次性 Electron 镜像安装的解决方案，以帮助用户在二进制文件下载缓慢或不可用时完成环境配置。
文档：
Original summary in English
Summary by Sourcery
文档：
Original summary in English
Summary by Sourcery
Documentation: