docs(getting-started): polish quickstart chapter with flow diagram and UX tips#39
docs(getting-started): polish quickstart chapter with flow diagram and UX tips#39yi-ge wants to merge 3 commits into
Conversation
…d UX tips - Add quickstart-flow.svg (zh) and quickstart-flow-en.svg (en) step diagrams - Reference flow diagram in both zh/en index.md - system-requirements: add quick-check tip for non-technical users - installation/index: add pre-install checklist reminder - first-run: expand chat area description with structured layout details - first-conversation: add reply format context and conversation tips - whats-next: add recommended first action for new users - Skip configure-api-key (算力-related, per review constraint) - No fabricated UI descriptions or fake screenshots
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d567b45b29
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| DesireCore 桌面客户端支持 macOS、Windows、Linux 三大平台。下面列出了各平台的环境要求。 | ||
|
|
||
| :::tip 快速判断 | ||
| 如果你的电脑是近 3 年内购买的，基本都能流畅运行 DesireCore。最低只需要 8 GB 内存和 2 GB 磁盘空间。 |
There was a problem hiding this comment.
For recently purchased low-end laptops with less than 8 GB RAM, or devices running an unsupported OS such as ChromeOS, the purchase-date heuristic says DesireCore should run smoothly even though the requirements immediately below exclude them. This can send users into an installation they cannot complete; direct them to verify the listed OS, memory, processor, and disk requirements instead.
Useful? React with 👍 / 👎.
| :::tip 对话小技巧 | ||
| - 你可以随时在同一对话中切换话题，智能体会记住上下文 | ||
| - 如果回复不理想，直接告诉它哪里需要调整即可 | ||
| - 想让智能体记住某个偏好？直接说"记住：我喜欢……" |
There was a problem hiding this comment.
When a newcomer follows this tip, saying the phrase alone does not make the preference persistent: docs/02-user-guide/03-teaching/05-learning-feedback.md lines 28–35 says the knowledge is formally written only after the user confirms the learning-feedback card, and the memory guide likewise requires accepting a candidate. Without mentioning that confirmation step, users can leave the card unconfirmed and later find that the promised preference was not remembered.
Useful? React with 👍 / 👎.
- Windows/macOS: add estimated install time tip - Windows/macOS: add troubleshooting quick-fix section - Linux: add 'experienced user' TL;DR with 2-command quickstart - configure-api-key: add skip hint for cloud-compute users - configure-api-key: add security note about local key storage - No fabricated screenshots or unverifiable claims
- Windows/macOS: add estimated install time tip - Windows/macOS: add Troubleshooting section - Linux: add experienced-user quick-start TL;DR - configure-api-key: add skip hint for cloud users + key security note
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2c277511fd
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| <!-- 截图占位: 配置 API Key (configure-api-key.png) --> | ||
|
|
||
| :::note 密钥安全 | ||
| 你的 API Key 仅保存在本机的 `~/.desirecore/secrets.json` 中（文件权限为 `600`，仅当前用户可读），不会上传到 DesireCore 服务器或任何第三方。 |
There was a problem hiding this comment.
For every self-managed provider request, the claim that the key is never sent to “any third party” is false: the key must be sent to that provider as authentication, as documented in docs/02-user-guide/10-settings/04-compute-service.md lines 113–114. This materially misstates the privacy boundary; clarify that the key is not uploaded to DesireCore but is transmitted to the configured provider when the user invokes it.
Useful? React with 👍 / 👎.
| <!-- 截图占位: 配置 API Key (configure-api-key.png) --> | ||
|
|
||
| :::note 密钥安全 | ||
| 你的 API Key 仅保存在本机的 `~/.desirecore/secrets.json` 中（文件权限为 `600`，仅当前用户可读），不会上传到 DesireCore 服务器或任何第三方。 |
There was a problem hiding this comment.
Users trying to inspect or protect this file are directed to the wrong location: the rest of the documentation consistently identifies it as ~/.desirecore/config/secrets.json, not ~/.desirecore/secrets.json. In addition, the unconditional 600 claim does not apply on Windows; docs/02-user-guide/10-settings/04-compute-service.md lines 111–112 explicitly limits that mode to POSIX platforms and describes Windows ACL protection separately.
Useful? React with 👍 / 👎.
| ## 遇到问题？ | ||
|
|
||
| - **安装程序无法打开**：确认文件下载完整（大小约 100-200 MB），尝试重新下载。 | ||
| - **杀毒软件拦截**：将 DesireCore 安装目录加入白名单，或暂时关闭实时防护后重试。 |
There was a problem hiding this comment.
When antivirus blocks the installer because it is actually malicious, corrupted, or unexpectedly signed, following this instruction removes the protection immediately before running it. This also directly contradicts lines 52 and 58–60 of the same Windows guide, which tell users not to disable protection and to verify the source and signature; troubleshooting should retain those checks rather than recommend an allowlist or temporary shutdown.
Useful? React with 👍 / 👎.
| ## 遇到问题？ | ||
|
|
||
| - **DMG 无法打开**：确认文件下载完整，尝试重新下载。 | ||
| - **"已损坏，无法打开"提示**：这通常是 Gatekeeper 拦截，按上方"处理 Gatekeeper 提示"操作即可。 |
There was a problem hiding this comment.
When macOS reports that the app is damaged, the download may be incomplete or its signature/notarization verification may have failed; it is not the unidentified-developer prompt handled by the control-click/Open Anyway steps above. Directing users to bypass that warning can both leave them stuck and encourage running a tampered copy, so this case should instead require re-downloading from the official source and rechecking the signature.
Useful? React with 👍 / 👎.
1 participant
变更内容
完善 Getting Started 快速入门章节的用户体验，不引入任何无法验证的内容。
新增
static/img/getting-started/quickstart-flow.svg— 中文快速上手流程图static/img/getting-started/quickstart-flow-en.svg— 英文快速上手流程图修改
index.md(zh/en)01-system-requirements.md02-installation/index.md03-first-run.md05-first-conversation.md06-whats-next.md约束遵守
04-configure-api-key.md（算力相关，按约束跳过）