From 73e0edf2cd4ad15dc680b6763926441b1708bf79 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=87=8E=E5=A3=B0?= <lijiacheng.ljc@antgroup.com>
Date: Mon, 21 Oct 2024 12:37:36 +0800
Subject: [PATCH 1/3] chore: update docs

---
 docs/zh/quick-start.md       | 31 +++++++++++++++++++++++++++++++
 docs/zh/release-codeblitz.md |  2 +-
 2 files changed, 32 insertions(+), 1 deletion(-)
 create mode 100644 docs/zh/quick-start.md

diff --git a/docs/zh/quick-start.md b/docs/zh/quick-start.md
new file mode 100644
index 00000000..91326adf
--- /dev/null
+++ b/docs/zh/quick-start.md
@@ -0,0 +1,31 @@
+# Quick Start
+
+## Clone
+
+```bash
+
+git clone git@github.com:opensumi/codeblitz.git
+cd codeblitz
+```
+
+## Install
+
+```bash
+yarn
+yarn run init
+```
+
+## Start
+
+```bash
+yarn start
+```
+
+CodeBlitz 有很多集成场景，在开发的时候需要模拟这些场景，你也可以直接通过命令行启动这些场景：
+
+- diff-viewer 行内的 diff 查看器
+  `yarn diff-viewer`
+- code
+  `yarn code`
+- provider 直接渲染编辑器
+  `yarn provider`
diff --git a/docs/zh/release-codeblitz.md b/docs/zh/release-codeblitz.md
index dc6a7510..5fd1e65f 100644
--- a/docs/zh/release-codeblitz.md
+++ b/docs/zh/release-codeblitz.md
@@ -16,4 +16,4 @@ node scripts/upgrade-opensumi.js -v x.x.x
 
 发布流程和 OpenSumi 一样，参考这个 Wiki 即可：https://github.com/opensumi/core/wiki/%E5%8F%91%E5%B8%83%E6%96%87%E6%A1%A3
 
-Action 地址在这里：https://github.com/opensumi/codeblitz/actions/workflows/release.yml
+对应的 action 地址在这里：<https://github.com/opensumi/codeblitz/actions/workflows/release.yml>

From a3a583587c61af64584b57ad0639e0dec43fd134 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=87=8E=E5=A3=B0?= <lijiacheng.ljc@antgroup.com>
Date: Tue, 22 Oct 2024 10:38:40 +0800
Subject: [PATCH 2/3] chore: update docs

---
 docs/zh/architecture.md | 20 ++++++++++++++++++++
 docs/zh/quick-start.md  |  3 ++-
 2 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 docs/zh/architecture.md

diff --git a/docs/zh/architecture.md b/docs/zh/architecture.md
new file mode 100644
index 00000000..c93afc76
--- /dev/null
+++ b/docs/zh/architecture.md
@@ -0,0 +1,20 @@
+# 架构简述
+
+CodeBlitz 将原来 OpenSumi 的功能封装成了一个 React 组件。
+
+它的主入口在 `@codeblitzjs/ide-core` 这个包，用起来很简单：
+
+```tsx
+import { AppRenderer, EditorRenderer } from '@codeblitzjs/ide-core';
+
+function App() {
+    return <AppRenderer appConfig={{}} />
+}
+
+function Editor() {
+    return <EditorRenderer appConfig={{}} />
+}
+```
+
+此外还提供了 `DiffViewerRenderer`，这是我们的新版 Diff 组件，所有的 diff 在行内展示，并且可以让用户选择是否采纳，
+对于 AI 生成代码的场景特别有用。
diff --git a/docs/zh/quick-start.md b/docs/zh/quick-start.md
index 91326adf..3b8e2fe1 100644
--- a/docs/zh/quick-start.md
+++ b/docs/zh/quick-start.md
@@ -27,5 +27,6 @@ CodeBlitz 有很多集成场景，在开发的时候需要模拟这些场景，
   `yarn diff-viewer`
 - code
   `yarn code`
-- provider 直接渲染编辑器
+- provider 直接渲染编辑器组件、Diff 组件的例子
+  使用 `CodeEditor`/`DiffEditor`。  
   `yarn provider`

From 759c14904260ed183e90bb8d32a8fa5c1d740fb5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E9=87=8E=E5=A3=B0?= <lijiacheng.ljc@antgroup.com>
Date: Tue, 22 Oct 2024 10:44:41 +0800
Subject: [PATCH 3/3] chore: update docs

---
 docs/zh/architecture.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/zh/architecture.md b/docs/zh/architecture.md
index c93afc76..78342307 100644
--- a/docs/zh/architecture.md
+++ b/docs/zh/architecture.md
@@ -18,3 +18,14 @@ function Editor() {
 
 此外还提供了 `DiffViewerRenderer`，这是我们的新版 Diff 组件，所有的 diff 在行内展示，并且可以让用户选择是否采纳，
 对于 AI 生成代码的场景特别有用。
+
+## 产物
+
+CodeBlitz 有一个很特别的地方是它打包的产物分 `bundle` 与 `lib` 两种版本：
+
+1. lib 下为源码经过 tsc 编译后的文件，因此如直接从 lib 下引用，那么可根据需要使用 OpenSumi (@opensumi/ide-*) 和 monaco (@opensumi/monaco-editor-core/esm) 相关模块，满足高定制的应用的需求，可以参考 [OpenSumi 开发文档](https://opensumi.com/zh/docs/integrate/universal-integrate-case/custom-view)。另外由于 lib 下的样式文件为 less，因此 webpack 需要额外处理 less 的编译。
+
+2. 提供 bundle 方式可以减少集成方打包的时间，缺点就是整个 bundle 包体积很大。
+    bundle 下为打包好的文件，只需引入 js 和 css 即可。
+
+同时 CodeBlitz 还会打包成 umd 格式，方便在浏览器中直接引用，它的导出名为 `Alex`。