chore: add readme for document

VisActor · Aug 28, 2023 · 31ce00f · 31ce00f
1 parent b87816a
commit 31ce00f
Show file tree

Hide file tree

Showing 7 changed files with 2,532 additions and 590 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -66,3 +66,5 @@ After cloning VChart, run `rush update` to fetch its dependencies. Then, you can
 4. `rush test` runs the complete test suite.
 5. `rush run -p <project_name> -s <script>` run the specified script for the specified project, eg. `rush run -p @visactor/vchart -s start`
 6. `rush prettier --dir <project_relative_path> --ext <file_type>` prettier the specified script for the specified project, eg. `rush prettier --dir packages/vchart --ext ts`
+
+If you want to update documents, you can run `rush docs` to preview VChart document contents locally.
diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md
@@ -69,3 +69,5 @@ VisActor 团队会关注所有的 pull request，我们会 review 以及合并
 4. `rush test` 运行所有项目的 test 脚本
 5. `rush run -p <project_name> -s <script>` 运行指定项目的指定脚本，eg. `rush run -p @visactor/vchart -s start`
 6. `rush prettier --dir <project_relative_path> --ext <file_type>` 格式化指定项目的源代码，eg. `rush prettier --dir packages/vchart --ext ts`
+
+如果你需要更新文档内容，你可以执行 `rush docs` 在本地运行 VChart 的文档内容预览。
diff --git a/README.md b/README.md
@@ -131,6 +131,15 @@ $ rush start
 $ rush react
 ```
 
+## 📖 Documents
+
+After installation & clone & update, run docs to preview documents locally.
+
+```bash
+# start vchart document server
+$ rush docs
+```
+
 ## 🔗 Related Links
 
 - [Homepage](https://www.visactor.io/vchart)

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -131,6 +131,15 @@ $ rush start
 $ rush react
 ```
 
+## 📖 Documents
+
+安装并且更新依赖后，可以执行 docs 命令，开启 vchart 的本地文档预览
+
+```bash
+# start vchart document server
+$ rush docs
+```
+
 ## 🔗 相关链接
 
 - [主页](https://www.visactor.io/vchart)