Skip to content

Commit 2c27751

Browse files
committed
docs(getting-started/en): sync installation and API key improvements
- 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
1 parent b6a7a75 commit 2c27751

4 files changed

Lines changed: 38 additions & 0 deletions

File tree

‎i18n/en/docusaurus-plugin-content-docs/current/01-getting-started/02-installation/01-windows.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ keywords: [Windows, installation, NSIS, SmartScreen]
88

99
This guide covers how to install DesireCore on Windows.
1010

11+
:::tip Estimated time
12+
The entire installation typically takes just **1–2 minutes** (depending on download speed).
13+
:::
14+
1115
## Installation Steps
1216

1317
1. **Download the installer**
@@ -81,4 +85,10 @@ To uninstall DesireCore:
8185
During uninstallation, you'll be asked whether to also delete application data. If you plan to reinstall, it's recommended to keep the data; if you're sure you won't use it again, you can choose to delete everything.
8286
:::
8387

88+
## Troubleshooting
89+
90+
- **Installer won't open**: Verify the download completed successfully (file size ~100–200 MB), then try downloading again.
91+
- **Antivirus blocks installation**: Add the DesireCore install directory to your antivirus allowlist, or temporarily disable real-time protection and retry.
92+
- **Other issues**: Visit the [FAQ](../../06-faq/index.md) or contact our support team.
93+
8494
After installation, head to [First Run](../03-first-run.md) to learn about the post-launch onboarding flow.

‎i18n/en/docusaurus-plugin-content-docs/current/01-getting-started/02-installation/02-macos.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ keywords: [macOS, installation, DMG, Gatekeeper, Apple Silicon, Intel]
88

99
This guide covers how to install DesireCore on macOS.
1010

11+
:::tip Estimated time
12+
The entire installation typically takes just **1 minute** — download the DMG, drag to Applications, done.
13+
:::
14+
1115
## Installation Steps
1216

1317
1. **Download the DMG file**
@@ -76,4 +80,11 @@ To also remove application data, delete the following directories:
7680
~/.desirecore/
7781
```
7882

83+
## Troubleshooting
84+
85+
- **DMG won't open**: Verify the download completed successfully, then try downloading again.
86+
- **"is damaged and can't be opened" message**: This is usually Gatekeeper blocking the app — follow the "Handling Gatekeeper Prompts" section above.
87+
- **Slow performance on Apple Silicon**: Confirm you downloaded the arm64 version, not x64 (Rosetta translation incurs a performance penalty).
88+
- **Other issues**: Visit the [FAQ](../../06-faq/index.md) or contact our support team.
89+
7990
After installation, head to [First Run](../03-first-run.md) to learn about the post-launch onboarding flow.

‎i18n/en/docusaurus-plugin-content-docs/current/01-getting-started/02-installation/03-linux.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ keywords: [Linux, installation, AppImage, Ubuntu, Fedora, ARM64, UnionTech UOS,
88

99
This guide covers how to install DesireCore on Linux. DesireCore is distributed as an AppImage, supporting both x64 and ARM64 architectures, and is compatible with most mainstream Linux distributions, including Chinese domestic operating systems such as UnionTech UOS, Kylin OS, Deepin, and openKylin.
1010

11+
:::tip Experienced users — quick start
12+
```bash
13+
# Two commands after downloading:
14+
chmod +x DesireCore_x86_64_*.AppImage
15+
./DesireCore_x86_64_*.AppImage
16+
```
17+
If you hit a sandbox error, jump to [Troubleshooting](#troubleshooting-sandbox-errors).
18+
:::
19+
1120
:::tip Chinese Domestic OS Users
1221
DesireCore has been tested and verified on UnionTech UOS, Kylin OS, Deepin, openKylin, and other Chinese domestic operating systems. For platform-specific installation instructions and compatibility details, please visit the [DesireCore China website](https://www.desirecore.cn).
1322
:::

‎i18n/en/docusaurus-plugin-content-docs/current/01-getting-started/04-configure-api-key.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ DesireCore is a local-first application: core data is stored locally by default.
1515
| Official cloud compute | Users who do not want to register with each model provider first | Sign in to bind the `desirecore-cloud` provider and use a subscription or credits |
1616
| Your own API key | Existing provider accounts, direct cost control, or enterprise compliance | The key is stored in the permission-protected local `secrets.json`; provider configuration stores only a reference |
1717

18+
:::info Already using cloud compute?
19+
If you've signed in and bound official cloud compute, you can **skip this page** and go straight to [Your First Conversation](./05-first-conversation.md). Come back anytime to add more providers.
20+
:::
21+
1822
## What is an API Key?
1923

2024
An API Key is like a "key" to access AI services. Each AI provider (such as OpenAI, Anthropic, DeepSeek, etc.) offers API services — you need to register on their website, obtain an API Key, and then enter it in DesireCore so it can call the corresponding AI models.
@@ -33,6 +37,10 @@ Calls made with your own API key are billed by the corresponding provider. Offic
3337

3438
<!-- Screenshot placeholder: Configure API Key (configure-api-key.png) -->
3539

40+
:::note Key Security
41+
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.
42+
:::
43+
3644
## Provider API Key Guides
3745

3846
DesireCore supports over 20 AI providers. Below are instructions for the most commonly used ones.

0 commit comments

Comments
 (0)