docs(root ui/docs): 完善开发指南

affects: @varlet/cli, @varlet/ui
varletjs · Apr 25, 2021 · 0eb9f5f · 0eb9f5f
1 parent d1006ac
commit 0eb9f5f
Show file tree

Hide file tree

Showing 10 changed files with 86 additions and 50 deletions.
diff --git a/TODO-zh-CN.md b/TODO-zh-CN.md
diff --git a/TODO.md b/TODO.md
diff --git a/developerGuide.md b/developerGuide.md
@@ -0,0 +1,20 @@
+# Developer Guide
+
+### Intro
+First, thank you for your interest in joining our development. Here are some considerations.
+
+### Quickstart
+The project is based on the workspace feature of `yarn` and `lerna` as the basic architecture of Monorepo. 
+The first fork of the repository is based on the dev branch, which is in the project root directory.
+
+```shell
+yarn bootstrap
+cd packages/varlet-ui
+yarn dev
+```
+
+### Todo list
+- 1.Provides `jsx`, `tsx` syntax highlighting support
+- 2.Improve the document reading experience and fix problems.
+- 3.Unit test all components and issue test report.
+- 4.Full component style detail optimization, animation curve optimization.
diff --git a/developerGuide.zh-CN.md b/developerGuide.zh-CN.md
@@ -0,0 +1,20 @@
+# 开发指南
+
+### 介绍
+首先感谢您有兴趣加入我们的开发，以下介绍一些注意事项。
+
+### 快速开始
+项目基于yarn的workspace特性和lerna作为monorepo的基本架构。
+首先fork仓库，基于dev分支进行开发，在项目根目录下.
+
+```shell
+yarn bootstrap
+cd packages/varlet-ui
+yarn dev
+```
+
+### Todo list
+- 1.提供`jsx`，`tsx`语法高亮支持。
+- 2.完善文档阅读体验，修复存在的问题。
+- 3.全组件单元测试，并出测试报告。
+- 4.全组件样式细节优化，动画曲线优化。
diff --git a/packages/varlet-cli/site/site.config.json b/packages/varlet-cli/site/site.config.json
@@ -89,10 +89,10 @@
       },
       {
         "text": {
-          "zh-CN": "Todo",
-          "en-US": "Todo"
+          "zh-CN": "开发指南",
+          "en-US": "Developer Guide"
         },
-        "doc": "todo",
+        "doc": "developerGuide",
         "nonComponent": true
       },
       {

diff --git a/packages/varlet-ui/docs/developerGuide.en-US.md b/packages/varlet-ui/docs/developerGuide.en-US.md
@@ -0,0 +1,20 @@
+# Developer Guide
+
+### Intro
+First, thank you for your interest in joining our development. Here are some considerations.
+
+### Quickstart
+The project is based on the workspace feature of `yarn` and `lerna` as the basic architecture of Monorepo. 
+The first fork of the repository is based on the dev branch, which is in the project root directory.
+
+```shell
+yarn bootstrap
+cd packages/varlet-ui
+yarn dev
+```
+
+### Todo list
+- 1.Provides `jsx`, `tsx` syntax highlighting support
+- 2.Improve the document reading experience and fix problems.
+- 3.Unit test all components and issue test report.
+- 4.Full component style detail optimization, animation curve optimization.
diff --git a/packages/varlet-ui/docs/developerGuide.zh-CN.md b/packages/varlet-ui/docs/developerGuide.zh-CN.md
@@ -0,0 +1,20 @@
+# 开发指南
+
+### 介绍
+首先感谢您有兴趣加入我们的开发，以下介绍一些注意事项。
+
+### 快速开始
+项目基于yarn的workspace特性和lerna作为monorepo的基本架构。
+首先fork仓库，基于dev分支进行开发，在项目根目录下.
+
+```shell
+yarn bootstrap
+cd packages/varlet-ui
+yarn dev
+```
+
+### Todo list
+- 1.提供`jsx`，`tsx`语法高亮支持。
+- 2.完善文档阅读体验，修复存在的问题。
+- 3.全组件单元测试，并出测试报告。
+- 4.全组件样式细节优化，动画曲线优化。
diff --git a/packages/varlet-ui/docs/todo.en-US.md b/packages/varlet-ui/docs/todo.en-US.md
diff --git a/packages/varlet-ui/docs/todo.zh-CN.md b/packages/varlet-ui/docs/todo.zh-CN.md
diff --git a/packages/varlet-ui/varlet.config.js b/packages/varlet-ui/varlet.config.js
@@ -86,10 +86,10 @@ module.exports = {
       },
       {
         text: {
-          'zh-CN': 'Todo',
-          'en-US': 'Todo',
+          'zh-CN': '开发指南',
+          'en-US': 'Developer Guide',
         },
-        doc: 'todo',
+        doc: 'developerGuide',
         nonComponent: true,
       },
       {