openclaw/docs
openclaw/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9255fea318
docs/README.md
Peter Steinberger 9255fea318
ci: slow zh-CN translation cadence
2026-04-05 11:15:55 +01:00

1.6 KiB
Raw Blame History

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 zh-CN output.
  4. openclaw/docs/.github/workflows/translate-zh-cn.yml runs once a day, on manual dispatch, and after release dispatches from openclaw/openclaw to refresh docs/zh-CN/**.

Translation behavior

  • zh-CN pages 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.
  • Published releases in openclaw/openclaw dispatch an extra zh-CN refresh so release-adjacent docs updates do not wait for the daily cron.

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.
  • zh-CN pages in docs/zh-CN/** are generated output.
  • .openclaw-sync/source.json records which openclaw/openclaw commit this mirror was synced from.

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 zh-CN translation refreshes.