Skip to content

Commit 546017d

Browse files
JackLianJackLian
committed
docs: some minor doc optimizations
1 parent 778ba32 commit 546017d

8 files changed

Lines changed: 78 additions & 15 deletions

File tree

‎docs/docs/api/index.md‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,39 @@ title: API 总览
33
sidebar_position: 0
44
---
55

6-
引擎直接提供 9 大类 API，以及若干间接的 API，具体如下图：
6+
引擎提供的公开 API 分为`命名空间`和`模型`两类，其中`命名空间`用于聚合一大类的 API，`模型`为各 API 涉及到的对象模型。
7+
8+
### 命名空间
9+
10+
引擎直接提供以下几大类 API
11+
12+
- skeleton 面板 API
13+
- material 物料 API
14+
- project 模型 API
15+
- simulator-host 模拟器 API
16+
- hotkey 快捷键 API
17+
- setters 设置器 API
18+
- event 事件 API
19+
- config 配置 API
20+
- common 通用 API
21+
- logger 日志 API
22+
- init 初始化 API
23+
24+
### 模型
25+
以下模型通过前面的 API 以返回值等形式间接透出。
26+
27+
- document-model 文档
28+
- node 节点
29+
- node-children 节点孩子
30+
- props 属性集
31+
- prop 属性
32+
- setting-prop-entry 设置属性
33+
- setting-top-entry 设置属性集
34+
- component-meta 物料元数据
35+
- selection 画布选中
36+
- detecting 画布 hover
37+
- history 操作历史
738

8-
![image.png](https://img.alicdn.com/imgextra/i3/O1CN01ZA2RMv1nYlWf6ThGf_!!6000000005102-2-tps-1278-1390.png)
939

1040
### API 设计约定
1141
一些 API 设计约定：

docs/docs/api/datasource.md renamed to docs/docs/demoUsage/appendix/api.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: DataSource - 数据源 API
3-
sidebar_position: 12
2+
title: demo 使用相关 API
3+
sidebar_position: 2
44
---
5+
## 数据源相关
56
### 请求数据源
67
```javascript
78
// 请求 userList（userList 在数据源面板中定义）

‎docs/docs/guide/expand/editor/_category_.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
2-
"label": "扩展低代码编辑器",
3-
"position": 1
2+
"label": "扩展编辑态",
3+
"position": 1,
4+
"collapsed": false,
5+
"collapsible": true
46
}

‎docs/docs/guide/expand/editor/summary.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 低代码扩展简述
2+
title: 编辑态扩展简述
33
sidebar_position: 0
44
---
55
## 扩展点简述

‎docs/docs/guide/expand/runtime/_category_.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
2-
"label": "扩展低代码运行时",
3-
"position": 2
2+
"label": "扩展运行时",
3+
"position": 2,
4+
"collapsed": false,
5+
"collapsible": true
46
}

‎docs/docs/participate/config.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ sidebar_position: 3
99
<!-- engine-ext 引擎的扩展包，负责收拢内置 setters / plugins，方便迭代 -->
1010
<script crossorigin="anonymous" src="//alifd.alicdn.com/npm/@alilc/[email protected]/dist/js/engine-ext.js"></script>
1111
```
12+
> 注，这里的版本号是示例，请尽量选用最新版
1213
1314
工程化配置我们进行了统一，具体如下：
1415
```shell
@@ -22,7 +23,6 @@ sidebar_position: 3
2223
"react": "var window.React",
2324
"react-dom": "var window.ReactDOM",
2425
"prop-types": "var window.PropTypes",
25-
"rax": "var window.Rax",
2626
"@alilc/lowcode-engine": "var window.AliLowCodeEngine",
2727
"@alilc/lowcode-engine-ext": "var window.AliLowCodeEngineExt",
2828
"moment": "var moment",
@@ -39,7 +39,7 @@ sidebar_position: 3
3939
["build-plugin-fusion", {
4040
}],
4141
["build-plugin-moment-locales", {
42-
"locales": ["zh-cn"]
42+
"locales": ["zh-CN"]
4343
}],
4444
"./build.plugin.js"
4545
]

‎docs/docs/participate/flow.md‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ sidebar_position: 2
1919
几点要求：
2020

2121
1. commit message 格式遵循 [ConvensionalCommits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
22-
![image.png](https://img.alicdn.com/imgextra/i3/O1CN01M9UzVM1iqYpyxECdV_!!6000000004464-2-tps-2070-594.png)
22+
23+
<img src="https://img.alicdn.com/imgextra/i3/O1CN01M9UzVM1iqYpyxECdV_!!6000000004464-2-tps-2070-594.png" width="700"/>
2324
2. 请按照一个 bugfix / feature 对应一个 commit，假如不是，请 rebase 后再提交 MR，不要一堆无用的、试验性的 commit。
2425

2526
好处：从引擎的整体 commit 历史来看，会很清晰，**每个 commit 完成一件确定的事，changelog 也能自动生成**。另外，假如因为某个 commit 导致了 bug，也很容易通过 rebase drop 等方式快速修复。
@@ -42,7 +43,7 @@ sidebar_position: 2
4243

4344
> 此处是理想节奏，实际情况可能会有调整
4445
45-
- 日常迭代 2 周，一般月中或月底
46+
- 日常迭代 2 周，一般月中或月底，发版日两天前发最后一个 beta 版本，原则上不接受新 pr，灰度 2 天后，发正式版。
4647
- 特殊情况紧急迭代随时发
4748
- 大 Feature 迭代，每年 2 - 4 次
4849

@@ -79,7 +80,34 @@ sidebar_position: 2
7980

8081
如果是发布 beta 版本，步骤如下（以发布 1.0.1 版本为例）：
8182

82-
#### 发某版本首个 beta，如 1.0.1-beta.0
83+
#### 发某 y 位版本首个 beta，如 1.1.0-beta.0
84+
1. 拉 develop 分支
85+
```bash
86+
git checkout develop
87+
```
88+
更新到最新（如需）
89+
```bash
90+
git pull
91+
```
92+
2. 拉 release 分支，此处以 1.1.0 版本做示例
93+
```bash
94+
git checkout -b release/1.1.0-beta
95+
git push --set-upstream origin release/1.1.0-beta
96+
```
97+
3. build
98+
```bash
99+
npm run build
100+
```
101+
4. 发布，此处需有 @alilc scope 发包权限
102+
```bash
103+
npm run pub:preminor
104+
```
105+
5. 同步到 tnpm 源 & alifd CDN
106+
```bash
107+
tnpm run sync
108+
```
109+
110+
#### 发某 z 位版本首个 beta，如 1.0.1-beta.0
83111
1. 拉 develop 分支
84112
```bash
85113
git checkout develop

‎docs/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@alilc/lowcode-engine-docs",
3-
"version": "1.0.7",
3+
"version": "1.0.8",
44
"description": "低代码引擎版本化文档",
55
"license": "MIT",
66
"files": [

0 commit comments

Comments
 (0)