diff --git a/README-zh_CN.md b/README-zh_CN.md index 656f550d..7f1b18b3 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -61,3 +61,35 @@ - `yarn run dev`: 使用实际接口,需要将`webpack.dev.js`文件第 47 行的 "http://pre.xxx.com" 修改为实际地址 - `yarn run build`: 构建打包,可将生成的 dist 目录的内容交给后端 + +## 文档 + +### 如何开发 + +- [开发前的准备](docs/zh/develop/1-ready-to-work.md) +- [目录结构](docs/zh/develop/2-catalog-introduction.md) +- [开发一个资源的页面](docs/zh/develop/3-0-how-to-develop.md) +- [BaseList 介绍](docs/zh/develop/3-1-BaseList-introduction.md) +- [BaseTabList 介绍](docs/zh/develop/3-2-BaseTabList-introduction.md) +- [BaseDetail 介绍](docs/zh/develop/3-3-BaseDetail-introduction.md) +- [BaseDetailInfo 介绍](docs/zh/develop/3-4-BaseDetailInfo-introduction.md) +- [BaseStore 介绍](docs/zh/develop/3-5-BaseStore-introduction.md) +- [FormAction 介绍](docs/zh/develop/3-6-FormAction-introduction.md) +- [ModalAction 介绍](docs/zh/develop/3-7-ModalAction-introduction.md) +- [ConfirmAction 介绍](docs/zh/develop/3-8-ConfirmAction-introduction.md) +- [StepAction 介绍](docs/zh/develop/3-9-StepAction-introduction.md) +- [FormItem 介绍](docs/zh/develop/3-10-FormItem-introduction.md) +- [Action 介绍](docs/zh/develop/3-11-Action-introduction.md) +- [Menu 介绍](docs/zh/develop/3-12-Menu-introduction.md) +- [Route 介绍](docs/zh/develop/3-13-Route-introduction.md) +- [I18n 介绍](docs/zh/develop/3-14-I18n-introduction.md) + +### How to test + +- [两种不同的测试方式](docs/zh/test/1-ready-to-work.md) +- [目录结构](docs/zh/test/2-catalog-introduction.md) +- [如何修改 e2e 测试用例](docs/zh/test/3-0-how-to-edit-e2e-case.md) +- [E2E - 表单操作](docs/zh/test/3-1-E2E-form-operation.md) +- [E2E - 列表页操作](docs/zh/test/3-2-E2E-table-operation.md) +- [E2E - 详情页操作](docs/zh/test/3-3-E2E-detail-operation.md) +- [E2E - 资源操作](docs/zh/test/3-4-E2E-resource-operation.md) diff --git a/README.md b/README.md index c37e2abe..981170ec 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,35 @@ Under the root directory, with `package.json` in the same place. - `yarn run mock`: Use the mock interface of [rap2](http://rap2.taobao.org/) - `yarn run dev`: To use the actual interface,please change the "http://pre.xxx.com" in line 47 into the real address in file `webpack.dev.js`. - `yarn run build`: Build packages and then you can hand over the contents of the generated _dist_ directory to the back end. + +## Docs + +### How to develop + +- [Preparation before development](docs/en/develop/1-ready-to-work.md) +- [Directory structure](docs/en/develop/2-catalog-introduction.md) +- [Develop a new resource page](docs/en/develop/3-0-how-to-develop.md) +- [BaseList introduction](docs/en/develop/3-1-BaseList-introduction.md) +- [BaseTabList introduction](docs/en/develop/3-2-BaseTabList-introduction.md) +- [BaseDetail introduction](docs/en/develop/3-3-BaseDetail-introduction.md) +- [BaseDetailInfo introduction](docs/en/develop/3-4-BaseDetailInfo-introduction.md) +- [BaseStore introduction](docs/en/develop/3-5-BaseStore-introduction.md) +- [FormAction introduction](docs/en/develop/3-6-FormAction-introduction.md) +- [ModalAction introduction](docs/en/develop/3-7-ModalAction-introduction.md) +- [ConfirmAction introduction](docs/en/develop/3-8-ConfirmAction-introduction.md) +- [StepAction introduction](docs/en/develop/3-9-StepAction-introduction.md) +- [FormItem introduction](docs/en/develop/3-10-FormItem-introduction.md) +- [Action introduction](docs/en/develop/3-11-Action-introduction.md) +- [Menu introduction](docs/en/develop/3-12-Menu-introduction.md) +- [Route introduction](docs/en/develop/3-13-Route-introduction.md) +- [I18n introduction](docs/en/develop/3-14-I18n-introduction.md) + +### How to test + +- [Two kinds of tests](docs/en/test/1-ready-to-work.md) +- [Directory structure](docs/en/test/2-catalog-introduction.md) +- [How to edit e2e case](docs/en/test/3-0-how-to-edit-e2e-case.md) +- [E2E - Form operation](docs/en/test/3-1-E2E-form-operation.md) +- [E2E - Table operation](docs/en/test/3-2-E2E-table-operation.md) +- [E2E - Detail operation](docs/en/test/3-3-E2E-detail-operation.md) +- [E2E - Resource operation](docs/en/test/3-4-E2E-resource-operation.md) diff --git a/docs/en/test/1-read-to-work.md b/docs/en/test/1-ready-to-work.md similarity index 100% rename from docs/en/test/1-read-to-work.md rename to docs/en/test/1-ready-to-work.md