#monSQLize 文档入口

这份文档从常见应用路径开始：连接 MongoDB，完成集合读写，需要时再加入 Model 校验，并按需开启缓存、事务、连接池、同步与运维能力。

#主要文档路径

#推荐阅读顺序

1. 根入口说明：仓库 README
2. 安装：getting-started.md
3. 快速上手：basic-operations.md
4. 构造配置：configuration.md
5. 可执行示例：
   • examples/README.md
   • examples/quick-start/basic-connect.ts
   • examples/quick-start/basic-operations.ts
   • examples/docs
   • examples.md
6. 缓存专题：cache.md
7. 写路径策略：write-path-policy.md
8. 生产发布：production-rollout.md
9. 生产数据迁移：production-data-migration.md
10. 数据任务 API：data-tasks.md
11. 场景指南：recipes.md
12. API 与运行时参考：

• api-index.md
• capability-index.md
• support-matrix.md

#源码与验证

• 文档站由 docs/en 与 docs/zh 生成。
• 可运行示例位于 examples。
• 公开行为应与包根导出、公开类型和可运行示例保持一致。

#示例运行方式

在仓库根目录执行：

npm run build
npm run test:examples

npm run test:examples 会通过仓库示例 runner 启动临时 MongoDB 测试服务，编译 TypeScript 示例，执行示例，并在结束时清理临时数据目录。