From 3fea798cf6477aff314978c96ab0cd7afe02c3f7 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-sync[bot]" Date: Sun, 12 Apr 2026 08:10:34 +0000 Subject: [PATCH] chore(sync): mirror docs from openclaw/openclaw@80730c53bd0523e4addb10022fdbc10f727a0421 --- .openclaw-sync/source.json | 4 ++-- docs/AGENTS.md | 28 ++++++++++++++++++++++++++++ docs/CLAUDE.md | 1 + 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/AGENTS.md create mode 120000 docs/CLAUDE.md diff --git a/.openclaw-sync/source.json b/.openclaw-sync/source.json index 326eee037..770cfd1cd 100644 --- a/.openclaw-sync/source.json +++ b/.openclaw-sync/source.json @@ -1,5 +1,5 @@ { "repository": "openclaw/openclaw", - "sha": "a9c7c2e1edf56dcdbc9c6b31c3410cbbaa6f1d60", - "syncedAt": "2026-04-12T08:08:28.544Z" + "sha": "80730c53bd0523e4addb10022fdbc10f727a0421", + "syncedAt": "2026-04-12T08:10:33.771Z" } diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 000000000..751f993a1 --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,28 @@ +# Docs Guide + +This directory owns docs authoring, Mintlify link rules, and docs i18n policy. + +## Mintlify Rules + +- 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](/configuration)`). +- Section cross-references should use anchors on root-relative paths (example: `[Hooks](/configuration#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`. + +## Docs Content Rules + +- 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`. + +## Docs i18n + +- 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//**` here. +- Treat English docs in this repo plus glossary files as the source of truth. +- Pipeline: update English docs here, update `docs/.i18n/glossary..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`. diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md new file mode 120000 index 000000000..47dc3e3d8 --- /dev/null +++ b/docs/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file