docs(getting-started): P0 优化 — 流程图合入 + 英文修复 + 截图规范 - #41
Conversation
…ce descriptions - Add quickstart-flow.svg (zh) and quickstart-flow-en.svg (en) rendered from drawio source - Keep editable drawio source in assets/quickstart-flow.drawio - Reference only rendered SVG in docs (not .drawio directly) - Update index.md (zh/en) with flow diagram - Update 03-first-run.md: correct nav items, add real screenshot reference - Update 05-first-conversation.md: add conversation interface screenshot
…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
- 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
P0-02: Replace ASCII art diagram in English first-run.md with SVG reference - Remove ASCII art block diagram (┌─┬─┐ style) - Use main-layout.svg (same as Chinese version) - Remove stale screenshot placeholder comment P0-03: Add screenshot/snapshot guidelines document - static/img/getting-started/SNAPSHOT-GUIDE.md - Covers: resolution (2x Retina), theme, DevTools, sensitive info - Includes screenshot checklist and workflow - Documents all pending screenshot placeholders
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Resolve merge conflicts in 03-first-run.md (chat area description) - Resolve merge conflicts in English index.md (flow diagram reference) - Use enhanced quickstart-flow.svg and quickstart-flow-en.svg from diagrams branch - Add main-interface-clean.png and main-interface-real.png screenshots
![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: 56bf9c6d8d
ℹ️ 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".
| ## 遇到问题？ | ||
|
|
||
| - **安装程序无法打开**：确认文件下载完整（大小约 100-200 MB），尝试重新下载。 | ||
| - **杀毒软件拦截**：将 DesireCore 安装目录加入白名单，或暂时关闭实时防护后重试。 |
There was a problem hiding this comment.
When security software blocks the installer, this tells users to disable real-time protection and retry, allowing an unverified or compromised download to execute without scanning. It also directly contradicts the warning earlier on this page to wait for scanning and never disable protection to bypass an alert; the mirrored English instruction should be corrected as well.
Useful? React with 👍 / 👎.
| <!-- Screenshot placeholder: Configure API Key (configure-api-key.png) --> | ||
|
|
||
| :::note Key Security | ||
| Your API Key is stored only in the local file `~/.desirecore/secrets.json` (file permission `600`, readable only by the current user). It is never uploaded to DesireCore servers or any third party. |
There was a problem hiding this comment.
Whenever a user invokes a model with a self-managed key, DesireCore necessarily sends that key to the selected provider as authentication, as documented in 02-user-guide/02-conversations/04-model-selection.md. Claiming it is never uploaded to “any third party” therefore gives users a false security boundary; distinguish local storage from the intentional transmission to the configured provider, including in the mirrored Chinese note.
Useful? React with 👍 / 👎.
| <!-- 截图占位: 配置 API Key (configure-api-key.png) --> | ||
|
|
||
| :::note 密钥安全 | ||
| 你的 API Key 仅保存在本机的 `~/.desirecore/secrets.json` 中（文件权限为 `600`，仅当前用户可读），不会上传到 DesireCore 服务器或任何第三方。 |
There was a problem hiding this comment.
For users trying to inspect, secure, or migrate their credentials, this path is wrong: the rest of the documentation consistently identifies the file as ~/.desirecore/config/secrets.json. The unconditional 600 claim is also inaccurate on Windows, where protection relies on account and directory ACLs rather than POSIX mode bits, so the note should use the real path and make the permission statement platform-specific in both locales.
Useful? React with 👍 / 👎.
…escription - Add real interface screenshot reference (main-interface-clean.png) - Update navigation bar items to match Chinese version - Add detailed chat area description with status bar - Add info box for additional navigation entries - Add tip box for interface navigation reference
- Add 'What's next' link to quickstart table in both Chinese and English - Step 6 links to 06-whats-next.md with 5-minute estimated time - Complete the 5-minute quickstart journey with guidance on next steps
…igure-api-key page - Add table of contents with anchor links at the top - Wrap each supplier guide in <details> collapsible section - Improve page navigation and reduce visual clutter - Maintain all original content while improving UX
- Add P1-6 completion details - Update Git commit records - Update summary to reflect 2 P1 items completed
…page - Add detailed steps for using official cloud compute - Add benefits and advantages of cloud compute - Add guidance for using custom API keys - Remove duplicate content about cloud compute quick start - Improve page structure and navigation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 428f87a32f
ℹ️ 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".
| chmod +x DesireCore_x86_64_*.AppImage | ||
| ./DesireCore_x86_64_*.AppImage | ||
| ``` | ||
| If you hit a sandbox error, jump to [Troubleshooting](#troubleshooting-sandbox-errors). |
There was a problem hiding this comment.
The new quick-start link targets #troubleshooting-sandbox-errors, but this page only defines ## Troubleshooting (#troubleshooting) and the sandbox subheading uses a different generated slug; the later #full-diagnosis-and-fix-steps-click-to-expand links have the same issue because the <summary> does not create that anchor. Users who hit the AppImage sandbox failure will click these new links and stay at the top instead of reaching the recovery steps.
Useful? React with 👍 / 👎.
| 回复以左侧气泡的形式展示，你发送的消息在右侧。 | ||
| 回复以左侧气泡的形式展示，你发送的消息在右侧。首次对话的回复通常是纯文字；当你开始让智能体执行任务后，还会看到行动回执、委派通知等更丰富的卡片格式（见下方"理解回复格式"）。 | ||
|
|
||
|  |
There was a problem hiding this comment.
This first-conversation section now embeds main-interface-real.png, but the screenshot shows an internal debugging exchange asking for ManageContext with a UUID/targetId and a prior target_not_found state rather than the simple first message described above. New users following the onboarding flow will see implementation-specific tool/error details instead of the expected successful first reply, so this should use a sanitized screenshot that matches the guide.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: eedcf67e54
ℹ️ 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".
| | **Uncertainty Handling** | What to do when unsure | "Explain uncertainty and provide verification path" | | ||
|
|
||
| `persona.md` is part of the **Agent prompt layer**. At runtime, DesireCore also combines the current user's global prompt and prompts from every team the Agent belongs to. Open **Explorer -> Prompt Center** to edit these sources together and preview the result. See [Prompt Center and Prompt Layers](./11-prompt-center.md). | ||
| `persona.md` is part of the **Agent prompt layer**. At runtime, DesireCore also combines the current user's global prompt and prompts from every team the Agent belongs to. Open **Explorer -> Prompt Center** to edit these sources together and preview the result. See [Prompt Center and Prompt Layers](./12-prompt-center.md). |
There was a problem hiding this comment.
This changes the English Persona page to link to ./12-prompt-center.md, but a repo-wide file search shows the Prompt Center doc still exists only as 11-prompt-center.md in both locales. In the English docs, this link now resolves to a missing page, and the same bad target is repeated in the Next Steps links here and in 05-edit-principles.md, so users following the Prompt Center references will hit 404s unless the target stays at ./11-prompt-center.md or the file is renamed too.
Useful? React with 👍 / 👎.
This reverts commit eedcf67.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 1fc4573a8f
ℹ️ 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".
|
|
||
| :::warning | ||
| `--no-sandbox` 会关闭 Chromium 的进程沙箱隔离，降低安全性。请仅用于排查问题，不要作为日常启动方式。建议按照上述方案一或方案二进行正式配置。 | ||
| `--no-sandbox` 会关闭 Chromium 的进程沙箱隔离，降低安全性。请仅用于排查问题，不要作为日常启动方式。建议按照 [上方的完整排查步骤](#完整排查与修复步骤点击展开) 进行正式配置。 |
There was a problem hiding this comment.
This link targets text that only exists inside the <summary> of the <details> block, so the page does not define a #完整排查与修复步骤点击展开 heading anchor. When users run with --no-sandbox and then click the recommended formal fix path, they won't be taken back to the AppArmor/sysctl steps; link to an actual heading in that section or give the details block an explicit id.
Useful? React with 👍 / 👎.
1 participant
Summary
完成 Getting Started 快速入门章节的 P0 优先级优化项。
✅ 已完成
ls✅ +grepzh:1 en:1 ✅grep main-layout.svg: 1 ✅ + ASCII art 残留: 0 ✅⏸️ 阻塞项（需真机截图）
P0-04 ~ P0-07 共 8 张截图需要真机环境拍摄，已记录在 SNAPSHOT-GUIDE.md 中：
变更文件
验证命令
Optimization plan:
OPTIMIZATION-getting-started.md§ 五