openclaw/docs
openclaw/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
[BREAKGLASS] OpenClaw docs + translation https://docs.openclaw.ai
6,345 Commits 1 Branch 0 Tags 391 MiB
JavaScript 95%
TypeScript 5%
fbbd0fa900
Go to file
Peter Steinberger fbbd0fa900
ci: tolerate failed locale translation artifacts
2026-05-06 20:42:31 +01:00
.github/workflows ci: tolerate failed locale translation artifacts 2026-05-06 20:42:31 +01:00
.openclaw-sync chore(sync): mirror docs from openclaw/openclaw@66f3fac34a 2026-05-06 19:28:37 +00:00
docs chore(i18n): refresh translations 2026-05-06 19:42:09 +00:00
scripts/docs-site fix: gate docs chat behind GitHub verification 2026-05-06 20:16:28 +01:00
.gitignore feat: add GitHub Pages docs site 2026-05-05 23:49:31 +01:00
AGENTS.md ci: debounce docs translations 2026-05-06 20:24:02 +01:00
CLAUDE.md docs: add publish repo editing rules 2026-04-23 19:11:50 +01:00
LICENSE Initial commit 2026-04-05 09:03:25 +01:00
package-lock.json feat: add GitHub Pages docs site 2026-05-05 23:49:31 +01:00
package.json feat: publish source search index 2026-05-06 03:51:08 +01:00
README.md ci: debounce docs translations 2026-05-06 20:24:02 +01:00

README.md

openclaw-docs

Mirror repo for the published OpenClaw docs site.

Source of truth lives in openclaw/openclaw, under docs/.

How it works

  1. English docs are authored in openclaw/openclaw.
  2. openclaw/openclaw/.github/workflows/docs-sync-publish.yml mirrors the docs tree into this repo.
  3. This repo stores the published docs tree plus generated locale output.
  4. openclaw/docs/.github/workflows/translate-all.yml debounces docs changes, runs locale translation in parallel, and commits one aggregate locale refresh.
  5. .github/workflows/pages.yml builds dist/docs-site from the mirrored docs and deploys it to GitHub Pages.

Translation behavior

  • Locale pages under docs/<locale>/** are generated output.
  • Each translated page stores x-i18n.source_hash.
  • The translate workflow computes a pending file list before calling the model.
  • If no English source hashes changed, the workflow skips the expensive translation step entirely.
  • If files changed, only the pending files are translated.
  • The workflow retries transient model-format failures.
  • Locale outputs are uploaded as artifacts first, then committed together by the finalizer.
  • The weekly scheduled run uses full reconciliation mode to repair missed or flaky locale updates.

Editing rules

  • Do not treat this repo as the primary place for English doc edits.
  • Make English doc changes in openclaw/openclaw, then let sync copy them here.
  • Locale pages under docs/<locale>/** are generated output.
  • .openclaw-sync/source.json records which openclaw/openclaw commit this mirror was synced from.

GitHub Pages build

  • npm run docs:build renders the mirrored Mintlify-flavored docs into dist/docs-site.
  • npm run docs:smoke checks representative English and locale pages plus the Pagefind search bundle.
  • npm run docs:check runs both steps.
  • The generated site includes the language picker and static full-text search via Pagefind.

Secrets

  • OPENCLAW_DOCS_SYNC_TOKEN lives in openclaw/openclaw and lets the source repo push into this repo.
  • OPENCLAW_DOCS_I18N_OPENAI_API_KEY lives in this repo and powers locale translation refreshes.