github/ChatLab
1
0
Fork 0
mirror of https://github.com/hellodigua/ChatLab.git synced 2026-05-27 01:01:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 新增繁体中文文档

Browse Source
This commit is contained in:
digua
2026-04-13 21:56:30 +08:00
parent 3c022b069a
commit c69dcdffbb
24 changed files with 1704 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/quick-start.md
+2 -2
View File
@@ -16,11 +16,11 @@ This page tells you what the docs can help with and gives the shortest reading p
## Fastest path
::: tip Suggested path
1. [Export Chat Records](./usage/how-to-export.md)
2. [Import Chat Records](./usage/how-to-import.md)
3. [How to Configure AI](./usage/how-to-config-ai.md)
4. [Troubleshooting](./usage/troubleshooting.md)
:::
4. [Troubleshooting](./usage/troubleshooting.md) :::
## Useful links
docs/en/standard/ai-converter.md
+6 -12
View File
@@ -24,11 +24,9 @@ Select the appropriate prompt based on your data size.
#### Copy JSON Conversion Prompt
```markdown
**Role Setting**:
You are an expert in data processing and script writing.
**Role Setting**: You are an expert in data processing and script writing.
**Task Objective**:
Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provide, please write a script to convert my uploaded [original chat records] into the compliant **JSON format**.
**Task Objective**: Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provide, please write a script to convert my uploaded [original chat records] into the compliant **JSON format**.
**Requirements**:
@@ -44,8 +42,7 @@ Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provi
4. **Result Validation**:
- Ensure the generated JSON structure strictly conforms to the definitions in `chatlab-format.md`.
**Output**:
Please provide the code directly and briefly explain how to run the script.
**Output**: Please provide the code directly and briefly explain how to run the script.
```
### Scenario 2: Very Large Data
@@ -57,11 +54,9 @@ Please provide the code directly and briefly explain how to run the script.
#### Copy JSONL Conversion Prompt
```markdown
**Role Setting**:
You are an expert in big data processing and stream computing.
**Role Setting**: You are an expert in big data processing and stream computing.
**Task Objective**:
Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provide, please write a script to convert my uploaded [original chat records] into the compliant **JSONL (JSON Lines) format**.
**Task Objective**: Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provide, please write a script to convert my uploaded [original chat records] into the compliant **JSONL (JSON Lines) format**.
**Requirements**:
@@ -77,8 +72,7 @@ Based on the [ChatLab Standard Format Specification] (chatlab-format.md) I provi
- Please write an **efficient Python script**.
- Ensure constant memory usage during processing, suitable for GB-level large files.
**Output**:
Please provide the code directly and briefly explain how to run the script.
**Output**: Please provide the code directly and briefly explain how to run the script.
```
## Next Steps
docs/en/standard/chatlab-format.md
+11 -18
View File
@@ -8,9 +8,7 @@ ChatLab defines a standard chat record data exchange format to support unified i
As long as you convert your chat records to this format, ChatLab can parse and analyze them.
::: warning Notice
This format specification is still in its early development stage. Some fields and structures may be adjusted in future versions.
:::
::: warning Notice This format specification is still in its early development stage. Some fields and structures may be adjusted in future versions. :::
## Overview
@@ -80,13 +78,13 @@ Here's a **minimal** ChatLab format example with only required fields:
### Metadata (meta)
| Field | Type | Required | Description |
| ------------- | ------------- | -------- | ------------------------------------------------------------------- |
| `name` | string | ✅ | Group name or conversation name |
| `platform` | string | ✅ | Platform identifier: `qq` / `wechat` / `discord` / `whatsapp`, etc. |
| `type` | string | ✅ | Chat type: `group` / `private` |
| `groupId` | string | - | Group ID (group chat only) |
| `groupAvatar` | string | - | Group avatar (Data URL format) |
| Field | Type | Required | Description |
| ------------- | ------ | -------- | ------------------------------------------------------------------- |
| `name` | string | ✅ | Group name or conversation name |
| `platform` | string | ✅ | Platform identifier: `qq` / `wechat` / `discord` / `whatsapp`, etc. |
| `type` | string | ✅ | Chat type: `group` / `private` |
| `groupId` | string | - | Group ID (group chat only) |
| `groupAvatar` | string | - | Group avatar (Data URL format) |
### Members (members)
@@ -113,9 +111,7 @@ Here's a **minimal** ChatLab format example with only required fields:
## Message Type Reference
::: warning Tip
If you have other special types in your chat records that need support, please submit an issue explaining your situation. We'll evaluate whether to add them to the standard message types.
:::
::: warning Tip If you have other special types in your chat records that need support, please submit an issue explaining your situation. We'll evaluate whether to add them to the standard message types. :::
### Basic Message Types (0-19)
@@ -166,9 +162,7 @@ Supported image formats:
- `image/gif` - GIF format
- `image/webp` - WebP format
::: tip Suggestion
When exporting, we recommend compressing avatars to 100×100 pixels or less to reduce file size.
:::
::: tip Suggestion When exporting, we recommend compressing avatars to 100×100 pixels or less to reduce file size. :::
## Complete Examples
@@ -302,8 +296,7 @@ JSONL (JSON Lines) format is suitable for **very large chat records** (>1 millio
::: warning Notice
- Each line must be **valid JSON** (cannot span lines)
- Lines are separated by newline `\n`
:::
- Lines are separated by newline `\n` :::
## Version History
docs/en/usage/index.md
+1 -1
View File
@@ -2,4 +2,4 @@
outline: deep
---
# USAGE
# USAGE