From f07eeb3f6845bab489be94571ecfe882e359be0d Mon Sep 17 00:00:00 2001 From: Betterlol <12311024@mail.sustech.edu.cn> Date: Tue, 7 Jul 2026 18:26:26 +0800 Subject: [PATCH] =?UTF-8?q?[docs][fix]:=20=E5=B0=86=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E7=B4=A2=E5=BC=95=E8=A1=A8=E7=A7=BB=E5=8A=A8=E5=88=B0=E4=B8=8A?= =?UTF-8?q?=E6=96=B9=EF=BC=8C=E4=B8=8B=E6=96=B9=E9=A2=84=E8=AE=A1=E6=94=BE?= =?UTF-8?q?=E5=BC=95=E7=94=A8=E7=9A=84=E7=9B=B8=E5=85=B3=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=EF=BC=8C=E5=A6=82=E5=90=8E=E7=BB=AD=E5=AE=9E=E7=8E=B0=E7=9A=84?= =?UTF-8?q?=E4=BB=A3=E7=A0=81=E6=8F=92=E4=BB=B6=E9=A1=B9=E7=9B=AE=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.mbt.md | 18 ++++++++++++------ README_zh.mbt.md | 18 ++++++++++++------ docs/en/README_TEMPLATE.md | 8 +++++++- docs/zh/README_TEMPLATE.md | 8 +++++++- 4 files changed, 38 insertions(+), 14 deletions(-) diff --git a/README.mbt.md b/README.mbt.md index 5190a21..325dc43 100644 --- a/README.mbt.md +++ b/README.mbt.md @@ -8,6 +8,17 @@ A runtime JSON schema validation library for MoonBit, inspired by [Zod](https:// --- +## Documents + +| Document | Description | +|---|---| +| [API Reference](./docs/en/API.md) | Detailed API documentation | +| [CLI Reference](./docs/en/CLI.md) | Command-line usage | +| [Benchmark](./docs/en/BENCHMARK.md) | Performance comparison with other validation libraries | +| [Examples](./docs/en/EXAMPLES.md) | Practical usage examples | + +--- + ## ✨ Why MoonZod? (AI-First) | Feature | moon_zod | Typical Validation | @@ -206,12 +217,7 @@ moon run examples/json2schema # JSON → moon_zod schema --- -| Document | Description | -|---|---| -| [API Reference](./docs/en/API.md) | Detailed API documentation | -| [CLI Reference](./docs/en/CLI.md) | Command-line usage | -| [Benchmark](./docs/en/BENCHMARK.md) | Performance comparison with other validation libraries | -| [Examples](./docs/en/EXAMPLES.md) | Practical usage examples | +--- ## Learn More diff --git a/README_zh.mbt.md b/README_zh.mbt.md index 12094d4..677bb3f 100644 --- a/README_zh.mbt.md +++ b/README_zh.mbt.md @@ -8,6 +8,17 @@ MoonBit 运行时 JSON Schema 校验库，受 [Zod](https://zod.dev) 和 [Pydant --- +## 文档 + +| 文档 | 说明 | +|---|---| +| [API 参考](./docs/zh/API.md) | 详细的 API 文档 | +| [CLI 参考](./docs/zh/CLI.md) | 命令行使用说明 | +| [性能基准](./docs/zh/BENCHMARK.md) | 与其他校验库的性能对比 | +| [使用示例](./docs/zh/EXAMPLES.md) | 实际使用示例 | + +--- + ## ✨ 为什么选择 MoonZod？（AI 优先） | 特性 | moon_zod | 典型校验库 | @@ -201,12 +212,7 @@ moon run examples/json2schema # JSON → moon_zod Schema - `schema_to_moonbit_struct(schema)` —— 为每个对象/枚举 schema 生成 MoonBit struct/enum 定义 - `schema_to_moonbit_struct_full(schema)` —— 生成定义并附加静态 `Type::to_schema()` 函数 -| 文档 | 说明 | -|---|---| -| [API 参考](./docs/zh/API.md) | 详细的 API 文档 | -| [CLI 参考](./docs/zh/CLI.md) | 命令行使用说明 | -| [性能基准](./docs/zh/BENCHMARK.md) | 与其他校验库的性能对比 | -| [使用示例](./docs/zh/EXAMPLES.md) | 实际使用示例 | +--- ## 了解更多 diff --git a/docs/en/README_TEMPLATE.md b/docs/en/README_TEMPLATE.md index 47e135d..c2d87d9 100644 --- a/docs/en/README_TEMPLATE.md +++ b/docs/en/README_TEMPLATE.md @@ -8,7 +8,7 @@ A runtime JSON schema validation library for MoonBit, inspired by [Zod](https:// --- -@include "INFO.md" +## Documents | Document | Description | |---|---| @@ -17,6 +17,12 @@ A runtime JSON schema validation library for MoonBit, inspired by [Zod](https:// | [Benchmark](./docs/en/BENCHMARK.md) | Performance comparison with other validation libraries | | [Examples](./docs/en/EXAMPLES.md) | Practical usage examples | +--- + +@include "INFO.md" + +--- + ## Learn More - [DESIGN.md](./DESIGN.md) for architecture, design decisions, and future directions. diff --git a/docs/zh/README_TEMPLATE.md b/docs/zh/README_TEMPLATE.md index 4646dcb..d1103ed 100644 --- a/docs/zh/README_TEMPLATE.md +++ b/docs/zh/README_TEMPLATE.md @@ -8,7 +8,7 @@ MoonBit 运行时 JSON Schema 校验库，受 [Zod](https://zod.dev) 和 [Pydant --- -@include "INFO.md" +## 文档 | 文档 | 说明 | |---|---| @@ -17,6 +17,12 @@ MoonBit 运行时 JSON Schema 校验库，受 [Zod](https://zod.dev) 和 [Pydant | [性能基准](./docs/zh/BENCHMARK.md) | 与其他校验库的性能对比 | | [使用示例](./docs/zh/EXAMPLES.md) | 实际使用示例 | +--- + +@include "INFO.md" + +--- + ## 了解更多 - [架构设计文档](./DESIGN.md) — 核心架构、设计决策与未来方向