mirror of
https://github.com/motajs/template.git
synced 2026-11-17 01:24:30 +08:00
docs(10-20): 高级 I 改为库文档风格(示例+注释)
- 删除七篇中的六步实操结构,改为叙述 + 带注释示例 - 移除 [模板] / [需改] 代码标记,验证段改为叙述 - 记录用户第 1 轮修订意见与构建结论
This commit is contained in:
1 parent
453839cc07
commit
68e1f6f72c
8 files changed
+227
-267
No files matched your search
@@ -0,0 +1,33 @@
|
||||
# 高级 I 用户修订记录
|
||||
|
||||
## 第 1 轮
|
||||
|
||||
**时间:** 2026-10-20
|
||||
**用户意见:** 按 D-59 修订全部 7 篇高级 I 文档:删除中级教程式的「目标 / 改哪里 / 复制什么 / 改什么 / 怎么验证 / 注意」六步实操块,改为正常库文档风格——用带注释的完整示例讲解,概念与验证写成叙述,不再手把手分步。
|
||||
**修改方式:** 派发子代理执行(只改 `docs/advanced/*.md`)。
|
||||
**状态:已处理**
|
||||
|
||||
### 逐篇处置
|
||||
|
||||
| 篇目 | 处置 |
|
||||
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `index.md` | 本身没有六步块;把「怎么验证你读懂了」改为「读完这一层应该能做什么」,保留分层、阅读路径与 D-55 取舍原则。 |
|
||||
| `declarative-vs-imperative.md` | 「给怪物加一条光环」改为叙述 + 带注释的 `special` 示例(说明键、范围、矩形/十字与三项百分比),验证改为叙述;保留 `ISpecial23Value`、`aura.ts` 转换器与叠加告警。 |
|
||||
| `plugin-system.md` | 模板六步改为「示例:一个完整插件」:完整 `MyPlugin` 类(含 `import`、生命周期与注释)→ `list.ts` 追加注册示例;删除 `[模板]` / `[需改]` 标记,验证改为叙述,保留 id 唯一性、依赖串/对象两种形态与错误码。 |
|
||||
| `saveable-content.md` | 模板六步改为「示例:一个可存档对象」完整类 + 「示例:把可存档对象接到插件里」;删除 `[模板]` / `[需改]` 标记;`structuredClone`、压缩参数省略、注册时机等说明保留,验证改为叙述。 |
|
||||
| `replay-consistency.md` | 「给一个内置方法补录像标记」的六步改为叙述 + 装饰器片段 + 收集区间示例;保留 `getOrInsert` 练习、错误码 `161`、去标记后告警消失的解释,验证改为叙述。 |
|
||||
| `data-stores.md` | 「模板:登记一条原始定义」与「把一批自定义内容注册进 Store」两处六步改为带注释的 `addTile` 示例与批量登记示例;保留四个 Store 的字段、错误码与 `fromRaw` / `addLayer` 时机说明,验证改为叙述。 |
|
||||
| `hooks-in-depth.md` | 「只处理指定图层」「地图级钩子里筛图层」两处六步改为完整钩子类 + 注册片段;保留 `===` 身份比较、`alias` 不是身份、`afterLoad` 可能取不到楼层时的显式提示,验证改为叙述。 |
|
||||
|
||||
### 其他
|
||||
|
||||
- 所有高级 I 文档中的 `[模板]` / `[需改]` 代码注释标记一并移除,改为普通解释性注释。
|
||||
- D-47 占位(`高级 II · …` / `高级 III · …` 与 `<!-- TODO(advanced-*) -->`)保留。
|
||||
- D-55(新增系统优先用插件)与 D-58(不强制模板章节)保持原样。
|
||||
- 未修改 `config.ts`、生产代码与渲染端内容。
|
||||
|
||||
### 构建
|
||||
|
||||
- `cmd /c "pnpm exec prettier --write docs/advanced/*.md"`:七篇全部 unchanged。
|
||||
- `cmd /c "node node_modules/prettier/bin/prettier.cjs --check ..."`:全部通过。
|
||||
- `cmd /c "pnpm exec tsx docs/.vitepress/init.ts && pnpm docs:build"`:`build complete`,无 dead link。
|
||||
Reference in new issue
Block a user