Skip to content

Commit 5e5d730

Browse files
committed
refactor(docs): update existing files for new VitePress framework
Update existing documentation files to work with the new framework: - Update index.md with auto language detection - Remove old config.mts (renamed to config.ts) - Remove old pages.yml workflow - Update package.json with new doc commands - Unify algorithm terminology in Chinese docs - Add CONTEXT.md glossary for terminology consistency
1 parent 1f807d7 commit 5e5d730

18 files changed

Lines changed: 227 additions & 512 deletions

File tree

.github/workflows/pages.yml

Lines changed: 0 additions & 59 deletions
This file was deleted.

CONTEXT.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,3 +191,57 @@ Streaming Layer 的核心控制逻辑,定义有效的状态转换。
191191
- `openspec/specs/core-architecture/spec.md` - 核心架构规范
192192
- `openspec/specs/encoding-project/spec.md` - 项目需求规范
193193
- `openspec/specs/cross-language-testing/spec.md` - 测试规范
194+
195+
## 文档术语表
196+
197+
本文节定义 Git Pages 文档(VitePress)中的术语翻译规范。
198+
199+
### 算法名称
200+
201+
| 英文 | 中文文档用法 | 说明 |
202+
|------|-------------|------|
203+
| Huffman | Huffman | 保留英文 |
204+
| Arithmetic | Arithmetic | 保留英文 |
205+
| Range Coder | Range Coder | 保留英文 |
206+
| RLE | RLE | 保留英文,首次出现可标注"行程编码" |
207+
208+
### API 术语
209+
210+
| 英文 | 中文翻译 | 说明 |
211+
|------|----------|------|
212+
| Streaming API | Streaming API | 保留英文,代码术语不翻译 |
213+
| Buffer Layer | 缓冲层 | 翻译 |
214+
| Streaming Layer | 流式层 | 翻译 |
215+
| CLI | CLI | 保留英文,通用术语 |
216+
| Import | 导入 | 翻译 |
217+
| Functions | 函数 | 翻译 |
218+
| Constants | 常量 | 翻译 |
219+
| Error Handling | 错误处理 | 翻译 |
220+
| Error Type | 错误类型 | 翻译 |
221+
| File Format | 文件格式 | 翻译 |
222+
| Usage | 用法 | 翻译 |
223+
| Internal Structure | 内部结构 | 翻译 |
224+
| Key Classes | 关键类 | 翻译 |
225+
| Common Patterns | 通用模式 | 翻译 |
226+
227+
### 文档结构
228+
229+
| 英文 | 中文翻译 | 说明 |
230+
|------|----------|------|
231+
| Getting Started | 快速开始 | 统一使用"快速开始" |
232+
| API Reference | API 参考 | 保留 API 英文 |
233+
| Benchmarks | 基准测试 | 翻译 |
234+
| Prerequisites | 前置条件 | 统一使用"前置条件" |
235+
| Troubleshooting | 故障排除 | 翻译 |
236+
237+
### 性能术语
238+
239+
| 英文 | 中文翻译 | 说明 |
240+
|------|----------|------|
241+
| encode/decode | 编码/解码 | 翻译 |
242+
| Encoder/Decoder | 编码器/解码器 | 翻译 |
243+
| encode time | 编码时间 | 翻译 |
244+
| decode time | 解码时间 | 翻译 |
245+
| compression ratio | 压缩比 | 翻译 |
246+
| throughput | 吞吐量 | 翻译 |
247+
| MiB/s | MiB/s | 保留单位 |

0 commit comments

Comments
 (0)