Skip to content

Commit 57cc0ee

Browse files
committed
Publish stable API docs for Matrix plugin series
1 parent df1c59f commit 57cc0ee

17 files changed

Lines changed: 169 additions & 30 deletions

docs/matrixauth/developer-api.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ description: MatrixAuth 当前开发者入口、代码树与 Javadoc 生成方
55

66
# MatrixAuth 开发者 API
77

8-
MatrixAuth 当前没有单独拆分稳定 `api/` 包,开发者文档应优先参考这些分层:
8+
MatrixAuth 当前稳定公开层:
9+
10+
- `com.y54895.matrixauth.api`
11+
- `com.y54895.matrixauth.api.model`
12+
13+
内部代码主要仍按这些分层组织:
914

1015
- `MatrixAuth`
1116
- `command/`
@@ -27,6 +32,7 @@ src/main/kotlin/com/y54895/matrixauth/
2732
├─ hook/
2833
├─ listener/
2934
├─ metrics/
35+
├─ api/
3036
├─ service/
3137
└─ util/
3238
```

docs/matrixauth/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ MatrixAuth 是一个基于 TabooLib 6 的混合登录与档案管理插件,目
1616

1717
## 当前发布
1818

19-
- 当前版本:`1.0.2`
20-
- 前置版本:`MatrixLib 1.4.0`
21-
- 发布说明:[1.0.2 发布说明](./release-notes-1-0-2)
19+
- 当前版本:`1.1.0`
20+
- 前置版本:`MatrixLib 1.5.0`
21+
- 发布说明:[1.1.0 发布说明](./release-notes-1-1-0)
2222
- 遥测说明:[bStats 与遥测](./bstats-and-telemetry)
2323
- 开发者 API:[开发者 API](./developer-api)
2424

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: MatrixAuth 1.1.0 发布说明
3+
description: MatrixAuth 1.1.0 稳定 API 命名空间说明。
4+
---
5+
6+
# MatrixAuth 1.1.0 发布说明
7+
8+
发布日期:`2026-04-05`
9+
10+
## 本次更新
11+
12+
- 新增稳定 `com.y54895.matrixauth.api` 命名空间。
13+
- 新增 immutable snapshot:
14+
- `MatrixAuthPlayerDataSnapshot`
15+
- `MatrixAuthProfileSnapshot`
16+
- `MatrixAuthLinkedAccountSnapshot`
17+
- `MatrixAuthHookStatusSnapshot`
18+
- 新增 `MatrixAuthApi` facade。
19+
- 新增 Dokka Javadoc 生成。

docs/matrixcook/developer-api.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ description: MatrixCook 当前开发者入口、公开 API 包与 Javadoc 生成
55

66
# MatrixCook 开发者 API
77

8-
MatrixCook 当前公开 API 主要集中在 `dev.lensocraft.cookly.api` 命名空间。
8+
MatrixCook 当前稳定公开层:
9+
10+
- `dev.lensocraft.cookly.api`
11+
- `dev.lensocraft.cookly.api.data`
12+
- `dev.lensocraft.cookly.api.event`
13+
- `dev.lensocraft.cookly.api.hook`
14+
- `dev.lensocraft.cookly.api.runtime`
915

1016
推荐入口:
1117

18+
- `MatrixCookApi`
1219
- `NameManager`
1320
- `CookerConfig`
1421
- `RecipeConfig`
@@ -26,7 +33,8 @@ src/main/kotlin/dev/lensocraft/cookly/
2633
│ ├─ NameManager.kt
2734
│ ├─ data/
2835
│ ├─ event/
29-
│ └─ hook/
36+
│ ├─ hook/
37+
│ └─ runtime/
3038
├─ command/
3139
├─ listener/
3240
├─ manager/

docs/matrixcook/overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ MatrixCook 是一套围绕“锅具、配方、燃料、放置状态”构建的
1919

2020
## 当前发布
2121

22-
- 当前版本:`1.1.2`
23-
- 前置版本:`MatrixLib 1.4.0`
24-
- 发布说明:[1.1.2 发布说明](./release-notes-1-1-2)
22+
- 当前版本:`1.2.0`
23+
- 前置版本:`MatrixLib 1.5.0`
24+
- 发布说明:[1.2.0 发布说明](./release-notes-1-2-0)
2525
- 遥测说明:[bStats 与遥测](./bstats-and-telemetry)
2626
- 开发者 API:[开发者 API](./developer-api)
2727

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: MatrixCook 1.2.0 发布说明
3+
description: MatrixCook 1.2.0 稳定 API 命名空间说明。
4+
---
5+
6+
# MatrixCook 1.2.0 发布说明
7+
8+
发布日期:`2026-04-05`
9+
10+
## 本次更新
11+
12+
- 正式把 `dev.lensocraft.cookly.api.*` 视为稳定 API 命名空间。
13+
- 新增 `MatrixCookApi` facade。
14+
- 新增 `api.runtime` 快照:
15+
- `MatrixCookRegistrySnapshot`
16+
- `MatrixCookPlacedCookerSnapshot`
17+
- 新增 Dokka Javadoc 生成。

docs/matrixlib/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ slug: /matrixlib
1515

1616
## 当前发布
1717

18-
- 当前版本:`1.4.0`
19-
- 依赖坐标:`com.y54895.matrixlib:matrixlib-api:1.4.0`
20-
- 发布说明:[1.4.0 发布说明](/docs/matrixlib/release-notes-1-4-0)
18+
- 当前版本:`1.5.0`
19+
- 依赖坐标:`com.y54895.matrixlib:matrixlib-api:1.5.0`
20+
- 发布说明:[1.5.0 发布说明](/docs/matrixlib/release-notes-1-5-0)
2121
- 遥测说明:[bStats 与遥测](/docs/matrixlib/bstats-and-telemetry)
2222
- 更新器说明:[自动更新与审批](/docs/matrixlib/updater-and-approval)
2323
- 开发者 API:[开发者 API](/docs/matrixlib/developer-api)
2424

2525
## 推荐阅读
2626

27-
1. [1.4.0 发布说明](/docs/matrixlib/release-notes-1-4-0)
27+
1. [1.5.0 发布说明](/docs/matrixlib/release-notes-1-5-0)
2828
2. [自动更新与审批](/docs/matrixlib/updater-and-approval)
2929
3. [开发者 API](/docs/matrixlib/developer-api)
3030
4. [bStats 与遥测](/docs/matrixlib/bstats-and-telemetry)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: MatrixLib 1.5.0 发布说明
3+
description: MatrixLib 1.5.0 稳定 API 命名空间与开发者文档说明。
4+
---
5+
6+
# MatrixLib 1.5.0 发布说明
7+
8+
发布日期:`2026-04-05`
9+
10+
## 本次更新
11+
12+
- 为 MatrixLib 公开层补充稳定 API 文档与 KDoc。
13+
- 补齐 Dokka Javadoc 生成与 `javadocJar` 产物。
14+
- 将 Matrix 系列稳定 API 基线提升到 `matrixlib-api:1.5.0`
15+
16+
## 稳定命名空间
17+
18+
- `com.y54895.matrixlib.api.action`
19+
- `com.y54895.matrixlib.api.brand`
20+
- `com.y54895.matrixlib.api.compat`
21+
- `com.y54895.matrixlib.api.console`
22+
- `com.y54895.matrixlib.api.economy`
23+
- `com.y54895.matrixlib.api.hologram`
24+
- `com.y54895.matrixlib.api.menu`
25+
- `com.y54895.matrixlib.api.metrics`
26+
- `com.y54895.matrixlib.api.resource`
27+
- `com.y54895.matrixlib.api.text`
28+
- `com.y54895.matrixlib.api.update`

docs/matrixshop/developer-api.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ description: MatrixShop 当前开发者入口、代码树与 Javadoc 生成方
55

66
# MatrixShop 开发者 API
77

8-
MatrixShop 当前没有单独拆分稳定 `api/` 包,开发者文档应优先参考这些分层:
8+
MatrixShop 当前稳定公开层:
9+
10+
- `com.y54895.matrixshop.api`
11+
- `com.y54895.matrixshop.api.model`
12+
- `com.y54895.matrixshop.api.warehouse`
13+
14+
内部代码仍主要按这些分层组织:
915

1016
- `MatrixShop`
1117
- `core/command`
@@ -22,6 +28,7 @@ MatrixShop 当前没有单独拆分稳定 `api/` 包,开发者文档应优先
2228
```text
2329
src/main/kotlin/com/y54895/matrixshop/
2430
├─ MatrixShop.kt
31+
├─ api/
2532
├─ core/
2633
│ ├─ action/
2734
│ ├─ command/

docs/matrixshop/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ MatrixShop 是面向生存、经济和市场场景的模块化交易插件。当
1010

1111
当前最新版本入口:
1212

13-
- [1.6.2 发布说明](./release-notes-1-6-2)
13+
- [1.7.0 发布说明](./release-notes-1-7-0)
1414
- [1.5.0 发布说明](./release-notes-1-5-0)
1515
- [更新日志总览](./release-notes)
1616

@@ -70,7 +70,7 @@ MatrixShop 是面向生存、经济和市场场景的模块化交易插件。当
7070
如果你第一次接触 MatrixShop,推荐顺序是:
7171

7272
1. [快速开始](./quick-start)
73-
2. [1.6.2 发布说明](./release-notes-1-6-2)
73+
2. [1.7.0 发布说明](./release-notes-1-7-0)
7474
3. [bStats 与遥测](./bstats-and-telemetry)
7575
4. [开发者 API](./developer-api)
7676
5. [1.5.0 发布说明](./release-notes-1-5-0)
@@ -110,7 +110,7 @@ MatrixShop 是面向生存、经济和市场场景的模块化交易插件。当
110110

111111
### 更新日志
112112

113-
- [1.6.2 发布说明](./release-notes-1-6-2)
113+
- [1.7.0 发布说明](./release-notes-1-7-0)
114114
- [1.5.0 发布说明](./release-notes-1-5-0)
115115
- [1.4.0 发布说明](./release-notes-1-4-0)
116116
- [1.3.0 发布说明](./release-notes-1-3-0)
@@ -128,7 +128,7 @@ MatrixShop 是面向生存、经济和市场场景的模块化交易插件。当
128128

129129
如果你是从 `1.0.0` 升级,请先看:
130130

131-
- [1.6.2 发布说明](./release-notes-1-6-2)
131+
- [1.7.0 发布说明](./release-notes-1-7-0)
132132
- [1.5.0 发布说明](./release-notes-1-5-0)
133133
- [1.4.0 发布说明](./release-notes-1-4-0)
134134
- [1.3.0 发布说明](./release-notes-1-3-0)

0 commit comments

Comments
 (0)