Skip to content

Commit f417ace

Browse files
joeytodayjoeytoday
committed
docs: update various documentation for clarity, formatting, and link corrections
1 parent 6e9d4f1 commit f417ace

8 files changed

Lines changed: 55 additions & 102 deletions

File tree

‎docs/users/configuration/qwen-ignore.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Qwen Code includes the ability to automatically ignore files, similar to `.gitig
66

77
## How it works
88

9-
When you add a path to your `.qwenignore` file, tools that respect this file will exclude matching files and directories from their operations. For example, when you use the [`read_many_files`](./tools/multi-file.md) command, any paths in your `.qwenignore` file will be automatically excluded.
9+
When you add a path to your `.qwenignore` file, tools that respect this file will exclude matching files and directories from their operations. For example, when you use the [`read_many_files`](/developers/tools/multi-file) command, any paths in your `.qwenignore` file will be automatically excluded.
1010

1111
For the most part, `.qwenignore` follows the conventions of `.gitignore` files:
1212

@@ -20,14 +20,10 @@ You can update your `.qwenignore` file at any time. To apply the changes, you mu
2020

2121
## How to use `.qwenignore`
2222

23-
To enable `.qwenignore`:
24-
25-
1. Create a file named `.qwenignore` in the root of your project directory.
26-
27-
To add a file or directory to `.qwenignore`:
28-
29-
1. Open your `.qwenignore` file.
30-
2. Add the path or file you want to ignore, for example: `/archive/` or `apikeys.txt`.
23+
| Step | Description |
24+
| ---------------------- | ------------------------------------------------------------ |
25+
| **Enable .qwenignore** | Create a file named `.qwenignore` in your project root directory |
26+
| **Add ignore rules** | Open `.qwenignore` file and add paths to ignore, example: `/archive/` or `apikeys.txt` |
3127

3228
### `.qwenignore` examples
3329

‎docs/users/configuration/themes.md‎

Lines changed: 12 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -140,64 +140,25 @@ The theme file must be a valid JSON file that follows the same structure as a cu
140140

141141
### Example Custom Theme
142142

143-
<img src="../assets/theme-custom.png" alt="Custom theme example" width="600" />
143+
144+
145+
<img src="https://gw.alicdn.com/imgextra/i1/O1CN01Em30Hc1jYXAdIgls3_!!6000000004560-2-tps-1009-629.png" alt=" " style="zoom:100%;text-align:center;margin: 0 auto;" />
144146

145147
### Using Your Custom Theme
146148

147149
- Select your custom theme using the `/theme` command in Qwen Code. Your custom theme will appear in the theme selection dialog.
148150
- Or, set it as the default by adding `"theme": "MyCustomTheme"` to the `ui` object in your `settings.json`.
149151
- Custom themes can be set at the user, project, or system level, and follow the same [configuration precedence](./configuration.md) as other settings.
150152

151-
---
152-
153-
## Dark Themes
154-
155-
### ANSI
156-
157-
<img src="../assets/theme-ansi.png" alt="ANSI theme" width="600" />
158-
159-
### Atom OneDark
160-
161-
<img src="../assets/theme-atom-one.png" alt="Atom One theme" width="600">
162-
163-
### Ayu
164-
165-
<img src="../assets/theme-ayu.png" alt="Ayu theme" width="600">
166-
167-
### Default
168-
169-
<img src="../assets/theme-default.png" alt="Default theme" width="600">
170-
171-
### Dracula
172-
173-
<img src="../assets/theme-dracula.png" alt="Dracula theme" width="600">
174-
175-
### GitHub
176-
177-
<img src="../assets/theme-github.png" alt="GitHub theme" width="600">
178-
179-
## Light Themes
180-
181-
### ANSI Light
182-
183-
<img src="../assets/theme-ansi-light.png" alt="ANSI Light theme" width="600">
184-
185-
### Ayu Light
186-
187-
<img src="../assets/theme-ayu-light.png" alt="Ayu Light theme" width="600">
188-
189-
### Default Light
190-
191-
<img src="../assets/theme-default-light.png" alt="Default Light theme" width="600">
192-
193-
### GitHub Light
194-
195-
<img src="../assets/theme-github-light.png" alt="GitHub Light theme" width="600">
196-
197-
### Google Code
198153

199-
<img src="../assets/theme-google-light.png" alt="Google Code theme" width="600">
200154

201-
### Xcode
155+
## Themes Preview
202156

203-
<img src="../assets/theme-xcode-light.png" alt="Xcode Light theme" width="600">
157+
| Dark Theme | Preview | Light Theme | Preview |
158+
| :-: | :-: | :-: | :-: |
159+
| ANSI | <img src="https://gw.alicdn.com/imgextra/i2/O1CN01ZInJiq1GdSZc9gHsI_!!6000000000645-2-tps-1140-934.png" style="zoom:30%;text-align:center;margin: 0 auto;" /> | ANSI Light | <img src="https://gw.alicdn.com/imgextra/i2/O1CN01IiJQFC1h9E3MXQj6W_!!6000000004234-2-tps-1140-934.png" style="zoom:30%;text-align:center;margin: 0 auto;" /> |
160+
| Atom OneDark | <img src="https://gw.alicdn.com/imgextra/i2/O1CN01Zlx1SO1Sw21SkTKV3_!!6000000002310-2-tps-1140-934.png" style="zoom:30%;text-align:center;margin: 0 auto;" /> | Ayu Light | <img src="https://gw.alicdn.com/imgextra/i3/O1CN01zEUc1V1jeUJsnCgQb_!!6000000004573-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> |
161+
| Ayu | <img src="https://gw.alicdn.com/imgextra/i3/O1CN019upo6v1SmPhmRjzfN_!!6000000002289-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> | Default Light | <img src="https://gw.alicdn.com/imgextra/i4/O1CN01RHjrEs1u7TXq3M6l3_!!6000000005990-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> |
162+
| Default | <img src="https://gw.alicdn.com/imgextra/i4/O1CN016pIeXz1pFC8owmR4Q_!!6000000005330-2-tps-1140-934.png" style="zoom:30%;text-align:center;margin: 0 auto;" /> | GitHub Light | <img src="https://gw.alicdn.com/imgextra/i4/O1CN01US2b0g1VETCPAVWLA_!!6000000002621-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> |
163+
| Dracula | <img src="https://gw.alicdn.com/imgextra/i4/O1CN016htnWH20c3gd2LpUR_!!6000000006869-2-tps-1140-934.png" style="zoom:30%;text-align:center;margin: 0 auto;" /> | Google Code | <img src="https://gw.alicdn.com/imgextra/i1/O1CN01Ng29ab23iQ2BuYKz8_!!6000000007289-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> |
164+
| GitHub | <img src="https://gw.alicdn.com/imgextra/i4/O1CN01fFCRda1IQIQ9qDNqv_!!6000000000887-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> | Xcode | <img src="https://gw.alicdn.com/imgextra/i1/O1CN010E3QAi1Huh5o1E9LN_!!6000000000818-2-tps-1140-934.png" alt=" " style="zoom:30%;text-align:center;margin: 0 auto;" /> |

‎docs/users/configuration/trusted-folders.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Add the following to your user `settings.json` file:
2222

2323
Once the feature is enabled, the first time you run the Qwen Code from a folder, a dialog will automatically appear, prompting you to make a choice:
2424

25-
- **Trust folder**: Grants full trust to the current folder (e.g., `my-project`).
26-
- **Trust parent folder**: Grants trust to the parent directory (e.g., `safe-projects`), which automatically trusts all of its subdirectories as well. This is useful if you keep all your safe projects in one place.
25+
- **Trust folder**: Grants full trust to the current folder (e.g. `my-project`).
26+
- **Trust parent folder**: Grants trust to the parent directory (e.g. `safe-projects`), which automatically trusts all of its subdirectories as well. This is useful if you keep all your safe projects in one place.
2727
- **Don't trust**: Marks the folder as untrusted. The CLI will operate in a restricted "safe mode."
2828

2929
Your choice is saved in a central file (`~/.qwen/trustedFolders.json`), so you will only be asked once per folder.
@@ -56,6 +56,6 @@ If you need to change a decision or see all your settings, you have a couple of
5656

5757
For advanced users, it's helpful to know the exact order of operations for how trust is determined:
5858

59-
1. **IDE Trust Signal**: If you are using the [IDE Integration](./ide-integration.md), the CLI first asks the IDE if the workspace is trusted. The IDE's response takes highest priority.
59+
1. **IDE Trust Signal**: If you are using the [IDE Integration](/users/ide-integration/ide-integration), the CLI first asks the IDE if the workspace is trusted. The IDE's response takes highest priority.
6060

6161
2. **Local Trust File**: If the IDE is not connected, the CLI checks the central `~/.qwen/trustedFolders.json` file.

‎docs/users/ide-integration/ide-integration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Qwen Code can integrate with your IDE to provide a more seamless and context-aware experience. This integration allows the CLI to understand your workspace better and enables powerful features like native in-editor diffing.
44

5-
Currently, the only supported IDE is [Visual Studio Code](https://code.visualstudio.com/) and other editors that support VS Code extensions. To build support for other editors, see the [IDE Companion Extension Spec](./ide-companion-spec.md).
5+
Currently, the only supported IDE is [Visual Studio Code](https://code.visualstudio.com/) and other editors that support VS Code extensions. To build support for other editors, see the [IDE Companion Extension Spec](/users/ide-integration/ide-companion-spec).
66

77
## Features
88

‎docs/users/reference/cli-reference.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Environment Variables: Commands executed via `!` will set the `QWEN_CODE=1` envi
120120

121121
Save frequently used prompts as shortcut commands to improve work efficiency and ensure consistency.
122122

123-
### 📋 Quick Overview
123+
### Quick Overview
124124

125125
| Function | Description | Advantages | Priority | Applicable Scenarios |
126126
| ---------------- | ------------------------------------------ | -------------------------------------- | -------- | ---------------------------------------------------- |
@@ -130,7 +130,7 @@ Save frequently used prompts as shortcut commands to improve work efficiency and
130130

131131
Priority Rules: Project commands > User commands (project command used when names are same)
132132

133-
### 🔤 Command Naming Rules
133+
### Command Naming Rules
134134

135135
#### File Path to Command Name Mapping Table
136136

@@ -141,14 +141,14 @@ Priority Rules: Project commands > User commands (project command used when name
141141

142142
Naming Rules: Path separator (`/` or `\`) converted to colon (`:`)
143143

144-
### 📄 TOML File Format Specification
144+
### TOML File Format Specification
145145

146146
| Field | Required | Description | Example |
147147
| ------------- | -------- | ---------------------------------------- | ------------------------------------------ |
148148
| `prompt` | Required | Prompt content sent to model | `prompt = "Please analyze code: {{args}}"` |
149149
| `description` | Optional | Command description (displayed in /help) | `description = "Code analysis tool"` |
150150

151-
### 🔧 Parameter Processing Mechanism
151+
### Parameter Processing Mechanism
152152

153153
| Processing Method | Syntax | Applicable Scenarios | Security Features |
154154
| ---------------------------- | ------------------ | ------------------------------------ | -------------------------------------- |
@@ -182,11 +182,11 @@ Naming Rules: Path separator (`/` or `\`) converted to colon (`:`)
182182

183183
| Operation | User Interaction |
184184
| ------------------------------- | -------------------- |
185-
| 1️⃣ Parse command and parameters | - |
186-
| 2️⃣ Automatic Shell escaping | - |
187-
| 3️⃣ Show confirmation dialog | ✅ User confirmation |
188-
| 4️⃣ Execute command | - |
189-
| 5️⃣ Inject output to prompt | - |
185+
| 1. Parse command and parameters | - |
186+
| 2. Automatic Shell escaping | - |
187+
| 3. Show confirmation dialog | ✅ User confirmation |
188+
| 4. Execute command | - |
189+
| 5. Inject output to prompt | - |
190190

191191
Example: Git Commit Message Generation
192192

@@ -221,16 +221,16 @@ Review {{args}}, reference standards:
221221
"""
222222
```
223223

224-
### 🛠️ Practical Creation Example
224+
### Practical Creation Example
225225

226226
#### "Pure Function Refactoring" Command Creation Steps Table
227227

228228
| Operation | Command/Code |
229229
| ----------------------------- | ------------------------------------------- |
230-
| 1️⃣ Create directory structure | `mkdir -p ~/.qwen/commands/refactor` |
231-
| 2️⃣ Create command file | `touch ~/.qwen/commands/refactor/pure.toml` |
232-
| 3️⃣ Edit command content | 参考下方代码 |
233-
| 4️⃣ Test command | `@file.js` → `/refactor:pure` |
230+
| 1. Create directory structure | `mkdir -p ~/.qwen/commands/refactor` |
231+
| 2. Create command file | `touch ~/.qwen/commands/refactor/pure.toml` |
232+
| 3. Edit command content | Refer to the complete code below. |
233+
| 4. Test command | `@file.js` → `/refactor:pure` |
234234

235235
```# ~/.qwen/commands/refactor/pure.toml
236236
description = "Refactor code to pure function"
@@ -243,7 +243,7 @@ prompt = """
243243
"""
244244
```
245245

246-
### 💡 Custom Command Best Practices Summary
246+
### Custom Command Best Practices Summary
247247

248248
#### Command Design Recommendations Table
249249

‎docs/users/support/Uninstall.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Remove-Item -Path (Join-Path $env:LocalAppData "npm-cache\_npx") -Recurse -Force
3333

3434
## Method 2: Using npm (Global Install)
3535

36-
If you installed the CLI globally (e.g., `npm install -g @qwen-code/qwen-code`), use the `npm uninstall` command with the `-g` flag to remove it.
36+
If you installed the CLI globally (e.g. `npm install -g @qwen-code/qwen-code`), use the `npm uninstall` command with the `-g` flag to remove it.
3737

3838
```bash
3939
npm uninstall -g @qwen-code/qwen-code

‎docs/users/support/tos-privacy.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,21 @@ When you authenticate using your qwen.ai account, these Terms of Service and Pri
2323
- **Terms of Service:** Your use is governed by the [Qwen Terms of Service](https://qwen.ai/termsservice).
2424
- **Privacy Notice:** The collection and use of your data is described in the [Qwen Privacy Policy](https://qwen.ai/privacypolicy).
2525

26-
For details about authentication setup, quotas, and supported features, see [Authentication Setup](./cli/authentication.md).
26+
For details about authentication setup, quotas, and supported features, see [Authentication Setup](/users/configuration/settings).
2727

2828
## 2. If you are using OpenAI-Compatible API Authentication
2929

3030
When you authenticate using API keys from OpenAI-compatible providers, the applicable Terms of Service and Privacy Notice depend on your chosen provider.
3131

32-
**Important:** When using OpenAI-compatible API authentication, you are subject to the terms and privacy policies of your chosen API provider, not Qwen Code's terms. Please review your provider's documentation for specific details about data usage, retention, and privacy practices.
32+
> [!important]
33+
>
34+
> When using OpenAI-compatible API authentication, you are subject to the terms and privacy policies of your chosen API provider, not Qwen Code's terms. Please review your provider's documentation for specific details about data usage, retention, and privacy practices.
3335
3436
Qwen Code supports various OpenAI-compatible providers. Please refer to your specific provider's terms of service and privacy policy for detailed information.
3537

3638
## Usage Statistics and Telemetry
3739

38-
Qwen Code may collect anonymous usage statistics and telemetry data to improve the user experience and product quality. This data collection is optional and can be controlled through configuration settings.
40+
Qwen Code may collect anonymous usage statistics and [telemetry](/developers/development/telemetry) data to improve the user experience and product quality. This data collection is optional and can be controlled through configuration settings.
3941

4042
### What Data is Collected
4143

@@ -50,10 +52,6 @@ When enabled, Qwen Code may collect:
5052
- **Qwen OAuth:** Usage statistics are governed by Qwen's privacy policy. You can opt-out through Qwen Code's configuration settings.
5153
- **OpenAI-Compatible API:** No additional data is collected by Qwen Code beyond what your chosen API provider collects.
5254

53-
### Opt-Out Instructions
54-
55-
You can disable usage statistics collection by following the instructions in the [Usage Statistics Configuration](./cli/configuration.md#usage-statistics) documentation.
56-
5755
## Frequently Asked Questions (FAQ)
5856

5957
### 1. Is my code, including prompts and answers, used to train AI models?
@@ -85,8 +83,6 @@ When enabled, Qwen Code may collect:
8583

8684
The Usage Statistics setting only controls data collection by Qwen Code itself. It does not affect what data your chosen AI service provider (Qwen, OpenAI, etc.) may collect according to their own privacy policies.
8785

88-
You can disable Usage Statistics collection by following the instructions in the [Usage Statistics Configuration](./cli/configuration.md#usage-statistics) documentation.
89-
9086
### 3. How do I switch between authentication methods?
9187

9288
You can switch between Qwen OAuth and OpenAI-compatible API authentication at any time:
@@ -95,4 +91,4 @@ You can switch between Qwen OAuth and OpenAI-compatible API authentication at an
9591
2. **Within the CLI**: Use the `/auth` command to reconfigure your authentication method
9692
3. **Environment variables**: Set up `.env` files for automatic OpenAI-compatible API authentication
9793

98-
For detailed instructions, see the [Authentication Setup](./cli/authentication.md) documentation.
94+
For detailed instructions, see the [Authentication Setup](/users/configuration/settings#environment-variables-for-api-access) documentation.

0 commit comments

Comments
 (0)