test docs

Author: astral-data

.gitbook.yaml

@@ -0,0 +1,7 @@
+root: docs
+structure:
+  langs:
+    - label: 简体中文
+      path: zh
+    - label: English
+      path: en

README.md

@@ -5,7 +5,7 @@
 # Languages
 
 - [Complete documen-English](./docs/en/README.md)
-- [完整文档-中文](./docs/zh/README.md)
+- [完整文档-中文](https://astrals-organization.gitbook.io/php-serialize)
 
 # php-serialize
 An advanced PHP serialization tool leveraging attributes for flexible object-to-array and JSON conversion. Supports property aliases, type conversions, and nested object handling. Ideal for APIs, data persistence, and configuration management.

docs/en/SUMMARY.md

@@ -0,0 +1,70 @@
+### 类型转换
+
+#### 基本类型转换
+
+##### 方式一：构造函数属性提升
+
+```php
+use Astral\Serialize\Serialize;
+
+class Profile extends Serialize {
+    public function __construct(
+        public string $username,
+        public int $score,
+        public float $balance,
+        public bool $isActive
+    ) {}
+}
+```
+
+##### 方式二：传统属性定义
+
+```php
+use Astral\Serialize\Serialize;
+
+class Profile extends Serialize {
+    public string $username;
+    public int $score;
+    public float $balance;
+    public bool $isActive;
+}
+
+// 两种方式都支持相同的类型转换
+$profile = Profile::from([
+    'username' => 123,        // 整数转换为字符串
+    'score' => '100',         // 字符串转换为整数
+    'balance' => '99.99',     // 字符串转换为浮点数
+    'isActive' => 1           // 数字转换为布尔值
+]);
+
+// 转换为数组
+$profileArray = $profile->toArray();
+```
+
+##### 方式三：只读属性
+
+```php
+use Astral\Serialize\Serialize;
+
+class Profile extends Serialize {
+    public readonly string $username;
+    public readonly int $score;
+    public readonly float $balance;
+    public readonly bool $isActive;
+
+    // 手动初始化
+    public function __construct(
+        string $username, 
+        int $score, 
+        float $balance, 
+        bool $isActive
+    ) {
+        $this->username = $username;
+        $this->score = $score;
+        $this->balance = $balance;
+        $this->isActive = $isActive;
+    }
+}
+```
+
+无论使用哪种方式，`Serialize` 类都能正常工作，并提供相同的类型转换和序列化功能。

docs/zh/DTO 转换/类型转换.md

@@ -0,0 +1,94 @@
+## 快速开始
+
+### 安装
+
+使用 Composer 安装：
+
+```bash
+composer require astral/serialize
+```
+
+### 基本用法
+
+```php
+use Astral\Serialize\Serialize;
+
+class User extends Serialize {
+    public string $name,
+    public int $age
+}
+
+// 从数组创建对象
+$user = User::from([
+    'name' => '张三',
+    'age' => 30
+]);
+
+// 访问对象属性
+echo $user->name;  // 输出: 张三
+echo $user->age;   // 输出: 30
+
+// 转换为数组
+$userArray = $user->toArray();
+// $userArray 的内容:
+// [
+//     'name' => '张三',
+//     'age' => 30
+// ]
+```
+
+### 其他特性
+
+#### **不可变性**：只读属性在构造后无法修改
+
+```php
+use Astral\Serialize\Serialize;
+
+class User extends Serialize {
+    public function __construct(
+        public readonly string $name,
+        public readonly int $age
+    ) {}
+}
+
+$user = User::from([
+    'name' => '张三',
+    'age' => 30
+]);
+
+try {
+    $user->name = '李四';  // 编译时错误：无法修改只读属性
+} catch (Error $e) {
+    echo "只读属性不能被重新赋值";
+}
+```
+
+#### **类型安全的初始化**
+
+```php
+$user = User::from([
+    'name' => 123,       // 整数会被转换为字符串
+    'age' => '35'        // 字符串会被转换为整数
+]);
+
+echo $user->name;  // 输出: "123"
+echo $user->age;   // 输出: 35
+```
+
+#### **构造函数初始化**
+
+```php
+use Astral\Serialize\Serialize;
+
+class User extends Serialize {
+    public function __construct(
+        public readonly string $name,
+        public readonly int $age
+    ) {
+        // 可以在构造函数中添加额外的验证或处理逻辑
+        if (strlen($name) < 2) {
+            throw new \InvalidArgumentException('名称太短');
+        }
+    }
+}
+```