Document Template

一个来源的文档分三层：来源页、Observer 页和实体页。本分组本身就是一套可以复制的样板：这一页是来源页，下面是 Example Observer，再下面是 Example Entity。复制整个目录，再把内容换成实际的业务即可。实际的例子见 Desktop、Input Events 和 Input Event。

三层页面复制章节链接

一种业务类型和它的 EntitySchema 写在同一个实体页。同一类页面使用相同的章节顺序，业务特有的内容作为对应章节下的小节。

目录结构复制章节链接

template/
  meta.json                 来源页的导航
  index.mdx                 来源页
  example-observer/
    meta.json               Observer 页的导航
    index.mdx               Observer 页
    example-entity.mdx      实体页

来源目录的 meta.json：

{
  "title": "Document Template",
  "defaultOpen": false,
  "collapsible": true,
  "pagesIndex": "index",
  "pages": ["example-observer"]
}

来源页也可以用相对路径收录已有的 Observer 目录，例如 Desktop 收录 ../application-activity，文件不用移动。

写作要点复制章节链接

• 文字和用词遵循 Core · Conventions。
• 正文只写已确认的业务规则。尚未确认的标识、约束和策略集中列在“待定”中。
• 页首的结构图从共享的 observers/relations.json 取节点，关系数据只维护一份。
• 多个页面共用的规则写在一处，其他页面链接过去。