图标样例 原始文档

CLAUDE 导读

Docs Guide：先抓住它真正发力的那一下

这一页不是在堆术语，它像把“Docs Guide”这台小机器搬到桌上，当着你的面拆开给你看。你先不用全记住，先抓住它到底在忙什么：Docs Guide。

先听这页的人话版

Docs Guide

这一页不是在堆术语，它像把“Docs Guide”这台小机器搬到桌上，当着你的面拆开给你看。你先不用全记住，先抓住它到底在忙什么：Docs Guide。

如果把这页当成“给普通人看的版本”，你最应该带走的是：它到底在教你一件什么事、什么时候要这样做、以及哪里最容易踩坑。

原始路径：/CLAUDE 章节数量：5 查看原文

第 1 站

Start Here

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

这段在解决什么

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

为什么值得看

这种内容决定了 OpenClaw 是“能做”还是“现在还不能做”，读懂它比记术语更重要。

真要动手时

你可以把这一节当成权限说明书，真正配置时优先盯住 default、required、allow、deny 这几个词。

先别急着背术语

如果把这一段摆成一个小场景，你会看到几样东西正在互相打招呼、拦路或者传东西。别急着记名词，先抓住它此刻到底在发生什么：Docs Guide This directory owns docs authoring, Mintlify link rules, and docs i18n policy.

像讲绘本

如果把这一段摆成一个小场景，你会看到几样东西正在互相打招呼、拦路或者传东西。别急着记名词，先抓住它此刻到底在发生什么：Docs Guide。

原文小纸条

# Docs Guide

像讲绘本

如果把这一段摆成一个小场景，你会看到几样东西正在互相打招呼、拦路或者传东西。别急着记名词，先抓住它此刻到底在发生什么：This directory owns docs authoring, Mintlify link rules, and docs i18n policy.

原文小纸条

This directory owns docs authoring, Mintlify link rules, and docs i18n policy.

第 2 站

Mintlify Rules

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

这段在解决什么

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

为什么值得看

这种内容决定了 OpenClaw 是“能做”还是“现在还不能做”，读懂它比记术语更重要。

真要动手时

你可以把这一节当成权限说明书，真正配置时优先盯住 default、required、allow、deny 这几个词。

先别急着背术语

这一小段像旁白，在提醒我们镜头已经切到下一站。

像准备清单

这一串条目别硬背，把它当成“Mintlify Rules”门口贴出来的几张便签就行。它们在提醒你先备好什么、别漏掉什么、哪里最容易走错：Docs are hosted on Mintlify (https://docs…、Internal doc links in docs/**/*.md must s…、Section cross-references should use ancho…、Doc headings should avoid em dashes and a…。

原文小纸条
  • Docs are hosted on Mintlify (https://docs.openclaw.ai).
  • Internal doc links in docs/**/*.md must stay root-relative with no .md or .mdx suffix (example: Config).
  • Section cross-references should use anchors on root-relative paths (example: Hooks).
  • Doc headings should avoid em dashes and apostrophes because Mintlify anchor generation is brittle there.
  • README and other GitHub-rendered docs should keep absolute docs URLs so links work outside Mintlify.
  • Docs content must stay generic: no personal device names, hostnames, or local paths; use placeholders like user@gateway-host.

第 3 站

Docs Content Rules

这一节在讲一类能力是怎么工作的：它能做什么、不能做什么、适合在什么场景下调用。

这段在解决什么

这一节在讲一类能力是怎么工作的：它能做什么、不能做什么、适合在什么场景下调用。

为什么值得看

你理解的是能力边界，不只是功能名字。

真要动手时

如果这节里同时出现命令、配置和例子，优先先看例子，再回头看配置。

先别急着背术语

这一小段像旁白，在提醒我们镜头已经切到下一站。

像准备清单

这一串条目别硬背，把它当成“Docs Content Rules”门口贴出来的几张便签就行。它们在提醒你先备好什么、别漏掉什么、哪里最容易走错：For docs, UI copy, and picker lists, orde…、Keep bundled 新本领插件 naming consistent with…。

原文小纸条
  • For docs, UI copy, and picker lists, order services/providers alphabetically unless the section is explicitly describing runtime order or auto-detection order.
  • Keep bundled plugin naming consistent with the repo-wide plugin terminology rules in the root AGENTS.md.

第 4 站

Internal Docs

这一节主要在解释“Internal Docs”到底是干什么的，以及你什么时候会遇到它。

这段在解决什么

这一节主要在解释“Internal Docs”到底是干什么的，以及你什么时候会遇到它。

为什么值得看

如果你是第一次接触 OpenClaw，这一节最值得看的不是术语本身，而是它背后的使用场景和限制。

真要动手时

真正动手时，先看它有没有默认值、有没有必须打开的选项、以及会不会影响安全边界。

先别急着背术语

这一小段像旁白，在提醒我们镜头已经切到下一站。

像准备清单

这一串条目别硬背，把它当成“Internal Docs”门口贴出来的几张便签就行。它们在提醒你先备好什么、别漏掉什么、哪里最容易走错：Long-lived private operator docs belong i…、Repo-local internal scratch/mirror docs m…、Never add docs/internal/** pages to docs/…、scripts/docs-sync-publish.mjs excludes an…。

原文小纸条
  • Long-lived private operator docs belong in ~/Projects/manager/docs/.
  • Repo-local internal scratch/mirror docs may live under ignored docs/internal/.
  • Never add docs/internal/** pages to docs/docs.json navigation or link them from public docs.
  • scripts/docs-sync-publish.mjs excludes and prunes docs/internal/** from the public openclaw/docs publish repo if a page is force-added later.
  • Internal docs may mention repo paths, private app names, 1Password item names, and runbooks, but never include secret values.

第 5 站

Docs i18n

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

这段在解决什么

这一节在讲规则和边界：什么默认允许、什么必须显式打开、什么被禁止。

为什么值得看

这种内容决定了 OpenClaw 是“能做”还是“现在还不能做”，读懂它比记术语更重要。

真要动手时

你可以把这一节当成权限说明书，真正配置时优先盯住 default、required、allow、deny 这几个词。

先别急着背术语

如果把这一段摆成一个小场景，你会看到几样东西正在互相打招呼、拦路或者传东西。别急着记名词，先抓住它此刻到底在发生什么：---。

像准备清单

这一串条目别硬背，把它当成“Docs i18n”门口贴出来的几张便签就行。它们在提醒你先备好什么、别漏掉什么、哪里最容易走错：Foreign-language docs are not maintained…、Do not add or edit localized docs under d…、Treat English docs in this repo plus glos…、Pipeline: update English docs here, updat…。

原文小纸条
  • Foreign-language docs are not maintained in this repo. The generated publish output lives in the separate openclaw/docs repo (often cloned locally as ../openclaw-docs).
  • Do not add or edit localized docs under docs/<locale>/** here.
  • Treat English docs in this repo plus glossary files as the source of truth.
  • Pipeline: update English docs here, update docs/.i18n/glossary.<locale>.json as needed, then let the publish-repo sync and scripts/docs-i18n run in openclaw/docs.
  • Before rerunning scripts/docs-i18n, add glossary entries for any new technical terms, page titles, or short nav labels that must stay in English or use a fixed translation.
  • pnpm docs:check-i18n-glossary is the guard for changed English doc titles and short internal doc labels.
  • Translation memory lives in generated docs/.i18n/*.tm.jsonl files in the publish repo.
  • See docs/.i18n/README.md.
像讲绘本

如果把这一段摆成一个小场景，你会看到几样东西正在互相打招呼、拦路或者传东西。别急着记名词，先抓住它此刻到底在发生什么：---。

原文小纸条

---

AdSense 连接验证已经放在页面头部；广告单元等站点审批通过后再启用。

google-adsense-account: ca-pub-3833673520933536