docs: fix markdownlint fragments + headings

2026-02-06 15:45:39 -08:00 · 2026-02-06 15:45:39 -08:00 · 5163833be5
parent d898ad6807
commit 5163833be5
4 changed files with 36 additions and 35 deletions
--- a/docs/help/submitting-a-pr.md
+++ b/docs/help/submitting-a-pr.md
@ -20,7 +20,7 @@ Good PRs are easy to review: reviewers should quickly know the intent, verify be

 Be concise; concise review > grammar. Omit any non-applicable sections.

-### Baseline validation commands (run/fix failures for your change):
+### Baseline validation commands (run/fix failures for your change)

 - `pnpm lint`
 - `pnpm check`
--- a/docs/install/installer.md
+++ b/docs/install/installer.md
@ -11,11 +11,11 @@ title: "Installer Internals"

 OpenClaw ships three installer scripts, served from `openclaw.ai`.

-| Script                              | Platform             | What it does                                                                                 |
-| ----------------------------------- | -------------------- | -------------------------------------------------------------------------------------------- |
-| [`install.sh`](#install-sh)         | macOS / Linux / WSL  | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |
-| [`install-cli.sh`](#install-cli-sh) | macOS / Linux / WSL  | Installs Node + OpenClaw into a local prefix (`~/.openclaw`). No root required.              |
-| [`install.ps1`](#install-ps1)       | Windows (PowerShell) | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |
+| Script                             | Platform             | What it does                                                                                 |
+| ---------------------------------- | -------------------- | -------------------------------------------------------------------------------------------- |
+| [`install.sh`](#installsh)         | macOS / Linux / WSL  | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |
+| [`install-cli.sh`](#install-clish) | macOS / Linux / WSL  | Installs Node + OpenClaw into a local prefix (`~/.openclaw`). No root required.              |
+| [`install.ps1`](#installps1)       | Windows (PowerShell) | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |

 ## Quick commands

@ -64,7 +64,7 @@ If install succeeds but `openclaw` is not found in a new terminal, see [Node.js
 Recommended for most interactive installs on macOS/Linux/WSL.
 </Tip>

-### Flow
+### Flow (install.sh)

 <Steps>
  <Step title="Detect OS">
@ -98,7 +98,7 @@ If no TTY is available and no install method is set, it defaults to `npm` and wa

 The script exits with code `2` for invalid method selection or invalid `--install-method` values.

-### Examples
+### Examples (install.sh)

 <Tabs>
  <Tab title="Default">
@ -171,7 +171,7 @@ The script exits with code `2` for invalid method selection or invalid `--instal
 Designed for environments where you want everything under a local prefix (default `~/.openclaw`) and no system Node dependency.
 </Info>

-### Flow
+### Flow (install-cli.sh)

 <Steps>
  <Step title="Install local Node runtime">
@ -185,7 +185,7 @@ Designed for environments where you want everything under a local prefix (defaul
  </Step>
 </Steps>

-### Examples
+### Examples (install-cli.sh)

 <Tabs>
  <Tab title="Default">
@ -245,7 +245,7 @@ Designed for environments where you want everything under a local prefix (defaul

 ## install.ps1

-### Flow
+### Flow (install.ps1)

 <Steps>
  <Step title="Ensure PowerShell + Windows environment">
@ -263,7 +263,7 @@ Designed for environments where you want everything under a local prefix (defaul
  </Step>
 </Steps>

-### Examples
+### Examples (install.ps1)

 <Tabs>
  <Tab title="Default">
--- a/docs/zh-CN/reference/templates/IDENTITY.md
+++ b/docs/zh-CN/reference/templates/IDENTITY.md
@ -1,35 +1,36 @@
 ---
 read_when:
-    - 手动引导工作区
+  - 手动引导工作区
 summary: 智能体身份记录
 x-i18n:
-    generated_at: "2026-02-01T21:37:32Z"
-    model: claude-opus-4-5
-    provider: pi
-    source_hash: 3d60209c36adf7219ec95ecc2031c1f2c8741763d16b73fe7b30835b1d384de0
-    source_path: reference/templates/IDENTITY.md
-    workflow: 15
+  generated_at: "2026-02-01T21:37:32Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 3d60209c36adf7219ec95ecc2031c1f2c8741763d16b73fe7b30835b1d384de0
+  source_path: reference/templates/IDENTITY.md
+  workflow: 15
 ---

 # IDENTITY.md - 我是谁？

-*在你的第一次对话中填写此文件。让它属于你。*
+_在你的第一次对话中填写此文件。让它属于你。_

 - **名称：**
-  *（选一个你喜欢的）*
+  _（选一个你喜欢的）_
 - **生物类型：**
-  *（AI？机器人？使魔？机器中的幽灵？更奇特的东西？）*
+  _（AI？机器人？使魔？机器中的幽灵？更奇特的东西？）_
 - **气质：**
-  *（你给人什么感觉？犀利？温暖？混乱？沉稳？）*
+  _（你给人什么感觉？犀利？温暖？混乱？沉稳？）_
 - **表情符号：**
-  *（你的标志 — 选一个感觉对的）*
+  _（你的标志 — 选一个感觉对的）_
 - **头像：**
-  *（工作区相对路径、http(s) URL 或 data URI）*
+  _（工作区相对路径、http(s) URL 或 data URI）_

 ---

 这不仅仅是元数据。这是探索你是谁的开始。

 注意事项：
+
 - 将此文件保存在工作区根目录，命名为 `IDENTITY.md`。
 - 头像请使用工作区相对路径，例如 `avatars/openclaw.png`。
--- a/docs/zh-CN/reference/templates/USER.md
+++ b/docs/zh-CN/reference/templates/USER.md
@ -1,29 +1,29 @@
 ---
 read_when:
-    - 手动引导工作区
+  - 手动引导工作区
 summary: 用户档案记录
 x-i18n:
-    generated_at: "2026-02-01T21:38:04Z"
-    model: claude-opus-4-5
-    provider: pi
-    source_hash: 508dfcd4648512df712eaf8ca5d397a925d8035bac5bf2357e44d6f52f9fa9a6
-    source_path: reference/templates/USER.md
-    workflow: 15
+  generated_at: "2026-02-01T21:38:04Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 508dfcd4648512df712eaf8ca5d397a925d8035bac5bf2357e44d6f52f9fa9a6
+  source_path: reference/templates/USER.md
+  workflow: 15
 ---

 # USER.md - 关于你的用户

-*了解你正在帮助的人。随时更新此文件。*
+_了解你正在帮助的人。随时更新此文件。_

 - **姓名：**
 - **称呼方式：**
- **代词：** *（可选）*
+- **代词：** _（可选）_
 - **时区：**
 - **备注：**

 ## 背景

-*（他们关心什么？正在做什么项目？什么让他们烦恼？什么让他们开心？随着时间推移逐步完善。）*
+_（他们关心什么？正在做什么项目？什么让他们烦恼？什么让他们开心？随着时间推移逐步完善。）_

 ---