chore(sync): mirror docs from openclaw/openclaw@dbfd96f4ec
This commit is contained in:
parent
3d8c6c5a4e
commit
259cc9fde3
@ -1,5 +1,5 @@
|
||||
{
|
||||
"repository": "openclaw/openclaw",
|
||||
"sha": "1ad5695aa483872f6bb1105100dd4281cbab1181",
|
||||
"syncedAt": "2026-04-05T10:16:35.715Z"
|
||||
"sha": "dbfd96f4eca2b3ed1f1fa6e4351718fb9dc82232",
|
||||
"syncedAt": "2026-04-05T10:33:29.967Z"
|
||||
}
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This folder stores translation config for the source docs repo.
|
||||
|
||||
Generated zh-CN pages and the live zh-CN translation memory live in the publish repo:
|
||||
Generated locale trees and live translation memory now live in the publish repo:
|
||||
|
||||
- repo: `openclaw/docs`
|
||||
- local checkout: `~/Projects/openclaw-docs`
|
||||
@ -11,7 +11,7 @@ Generated zh-CN pages and the live zh-CN translation memory live in the publish
|
||||
|
||||
- English docs are authored in `openclaw/openclaw`.
|
||||
- The source docs tree lives under `docs/`.
|
||||
- The source repo no longer keeps committed `docs/zh-CN/**`.
|
||||
- The source repo no longer keeps committed generated locale trees such as `docs/zh-CN/**` or `docs/ja-JP/**`.
|
||||
|
||||
## End-to-end flow
|
||||
|
||||
@ -20,20 +20,22 @@ Generated zh-CN pages and the live zh-CN translation memory live in the publish
|
||||
3. `openclaw/openclaw/.github/workflows/docs-sync-publish.yml` mirrors the docs tree into `openclaw/docs`.
|
||||
4. The sync script rewrites the publish `docs/docs.json` so `zh-Hans` navigation exists there even though it is no longer committed in the source repo.
|
||||
5. `openclaw/docs/.github/workflows/translate-zh-cn.yml` refreshes `docs/zh-CN/**` once a day, on demand, and after source-repo release dispatches.
|
||||
6. `openclaw/docs/.github/workflows/translate-ja-jp.yml` does the same for `docs/ja-JP/**`.
|
||||
|
||||
## Why the split exists
|
||||
|
||||
- Keep generated zh-CN output out of the main product repo.
|
||||
- Keep generated locale output out of the main product repo.
|
||||
- Keep Mintlify on a single published docs tree.
|
||||
- Preserve the built-in language switcher by letting the publish repo own `docs/zh-CN/**`.
|
||||
- Preserve the built-in language switcher by letting the publish repo own generated locale trees.
|
||||
|
||||
## Files in this folder
|
||||
|
||||
- `glossary.<lang>.json` — preferred term mappings used as prompt guidance.
|
||||
- `ja-navigation.json` — the `ja` Mintlify nav block reinserted into the publish repo during sync.
|
||||
- `zh-Hans-navigation.json` — the `zh-Hans` Mintlify nav block reinserted into the publish repo during sync.
|
||||
- `<lang>.tm.jsonl` — translation memory keyed by workflow + model + text hash.
|
||||
|
||||
In this repo, `docs/.i18n/zh-CN.tm.jsonl` is intentionally no longer committed.
|
||||
In this repo, generated locale TM files such as `docs/.i18n/zh-CN.tm.jsonl` and `docs/.i18n/ja-JP.tm.jsonl` are intentionally no longer committed.
|
||||
|
||||
## Glossary format
|
||||
|
||||
@ -57,11 +59,11 @@ Fields:
|
||||
|
||||
- `scripts/docs-i18n` still owns translation generation.
|
||||
- Doc mode writes `x-i18n.source_hash` into each translated page.
|
||||
- The publish workflow precomputes a pending file list by comparing the current English source hash to the stored zh-CN `x-i18n.source_hash`.
|
||||
- Each publish workflow precomputes a pending file list by comparing the current English source hash to the stored locale `x-i18n.source_hash`.
|
||||
- If the pending count is `0`, the expensive translation step is skipped entirely.
|
||||
- If there are pending files, the workflow translates only those files.
|
||||
- The publish workflow retries transient model-format failures, but unchanged files stay skipped because the same hash check runs on each retry.
|
||||
- The source repo also dispatches a zh-CN refresh after published GitHub releases so release docs can catch up without waiting for the daily cron.
|
||||
- The source repo also dispatches zh-CN and ja-JP refreshes after published GitHub releases so release docs can catch up without waiting for the daily cron.
|
||||
|
||||
## Operational notes
|
||||
|
||||
|
||||
18
docs/.i18n/ja-navigation.json
Normal file
18
docs/.i18n/ja-navigation.json
Normal file
@ -0,0 +1,18 @@
|
||||
{
|
||||
"language": "ja",
|
||||
"tabs": [
|
||||
{
|
||||
"tab": "はじめに",
|
||||
"groups": [
|
||||
{
|
||||
"group": "概要",
|
||||
"pages": ["ja-JP/index"]
|
||||
},
|
||||
{
|
||||
"group": "初回セットアップ",
|
||||
"pages": ["ja-JP/start/getting-started", "ja-JP/start/wizard"]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user