feat: Generate a JSON index

README.en.md

@@ -75,18 +75,36 @@ For each issue, please try to:
 
   For example, typing Chinese characters requires an IME. You can link to [Unicode FAQ on Chinese and Japanese](https://unicode.org/faq/han_cjk.html).
 
-
 But in most cases:
 
 - No need to provide a solution directly
 
   Just link it as `#workaround("https://…")`.
 
-
 - No need to describe comprehensively, nor is it recommended to propose improvements too much
 
   These contents can be initially proposed at [GitHub Issues](https://github.com/typst-doc-cn/clreq/issues/), and should eventually be forwarded to the Typst official.
 
+### Maintaining
+
+GitHub Actions are watching `#issue` and `#pull` annotated in the document, and will report in [🤖 Cron check · Issue #22](https://github.com/typst-doc-cn/clreq/issues/22) and pull request if their states change.
+
+We can update the document once we notice. There is no need to wait until Typst releases a new version.
+
+An example update is as below.
+
+```diff
+- #level.basic
++ #level.ok
+- #issue("typst#633")
+- #pull("typst#5777")
++ #issue("typst#633", closed: true)
++ #pull("typst#5777", merged: true)
+  #workaround("https://typst-doc-cn.github.io/guide/FAQ/cite-flying.html")
++
++ #till-next(now-fixed.with(last-affected: "0.13.1", last-level: "basic"))
+```
+
 ### Multilingual content (`babel`/`bbl`)
 
 - The `en` and `zh` fields are displayed in English and 中文 modes, respectively.
@@ -112,6 +130,30 @@ Tips:
 
 - Don’t pay special attention to line breaks and indentation. Just use tinymist (VS Code) / typstyle default settings. To make version comparison easier, we have set up a pull request robot to automatically format them.
 
+### Title formats
+
+- Top-level sections representing **categories**
+
+  The title should be as consistent as possible with [W3C Gap Analysis documents](https://www.w3.org/TR/clreq-gap/).
+
+- Low-level sections derscribing **specific gaps**
+
+  - For features that are needed but **not yet supported**, express titles as **phrases** whenever possible.
+
+    Examples:
+
+    - Vertical writing mode | 直排
+    - Customizing punctuation overhang | 定制标点悬挂
+
+  - For issues of **existing** features, express titles as **sentences** whenever possible.
+
+    Examples:
+
+    - Spacing between heading numbering and title is too wide | 标题编号与内容之间的空隙过宽
+    - Citation numbers are flying over their brackets | 引用编号的数字高于括号
+
+  - Do not edit the title after the gap is resolved, unless you have a good reason.
+
 ### Adding a code example
 
 Code examples will be compiled when rendering the website.
@@ -159,7 +201,7 @@ Simple examples are evaluated in a container and their states are shared across
 
 As a result:
 
-- Any page configuration is not allowed. 
+- Any page configuration is not allowed.
 
   If you just want to `#set page(width: …)`, then use `#show: block.with(width: …)` instead.
 

README.md

@@ -86,6 +86,26 @@ pnpm dev --open # ⇒ http://localhost:3000
 
   这些内容可初步在 [GitHub Issues](https://github.com/typst-doc-cn/clreq/issues/) 提出，最终应反馈给 Typst 官方。
 
+### 维护更新
+
+GitHub Actions 会监控文档中标记的`#issue`和`#pull`，发现状态变化就会在 [🤖 Cron check · Issue #22](https://github.com/typst-doc-cn/clreq/issues/22) 和 pull request 提醒。
+
+收到提醒即可更新文档，不必等到 Typst 发布新版本。
+
+更新示例如下。
+
+```diff
+- #level.basic
++ #level.ok
+- #issue("typst#633")
+- #pull("typst#5777")
++ #issue("typst#633", closed: true)
++ #pull("typst#5777", merged: true)
+  #workaround("https://typst-doc-cn.github.io/guide/FAQ/cite-flying.html")
++
++ #till-next(now-fixed.with(last-affected: "0.13.1", last-level: "basic"))
+```
+
 ### 多语言内容（`babel`/`bbl`）
 
 - `en`、`zh`两字段分别在 English、中文模式显示。
@@ -111,6 +131,30 @@ pnpm dev --open # ⇒ http://localhost:3000
 
 - 不用刻意关注换行与缩进，按 tinymist (VS Code) / typstyle 默认即可。为方便对比版本，已设置 pull request 机器人自动统一格式。
 
+### 标题格式
+
+- 表示**分类**的大章节
+
+  标题尽量与 [W3C 差距分析文档](https://www.w3.org/TR/clreq-gap/)保持一致。
+
+- 描述**具体差距**的小章节
+
+  - 对于需要支持但**尚不支持**的功能，标题尽量用**短语**表达。
+
+    示例：
+
+    - Vertical writing mode | 直排
+    - Customizing punctuation overhang | 定制标点悬挂
+
+  - 对于**已支持**功能存在的问题，标题尽量用**句子**表达。
+
+    示例：
+
+    - Spacing between heading numbering and title is too wide | 标题编号与内容之间的空隙过宽
+    - Citation numbers are flying over their brackets | 引用编号的数字高于括号
+
+  - 差距解决之后，尽量不再修改标题。
+
 ### 添加代码例子
 
 代码例子会在渲染网站时编译。