Translation Maintenance Workflow

For general documentation commands (build, deploy, screenshots, README generation), see Documentation Tools.

Overview

Dokyumenteshan Docusaurus i18n ka upayog karti hai, jahan English default locale hai. Source dokyumenteshan docs/ mein sthit hai; anuvad i18n/{locale}/ ke neeche likhe jaate hain. Samarthit locales: en-GB (default), fr, de, es, pt-BR, hi-Latn, zh-Hans.

AI translation for the app UI, Docusaurus markdown/JSON, and SVG assets is handled by ai-i18n-tools from the repository root, configured in ai-i18n-tools.config.json (not inside documentation/). Set OPENROUTER_API_KEY when running translate commands.

When English documentation changes

1. Edit source in documentation/docs/ (English only).
2. Docusaurus UI strings (theme labels, navbar, etc.): if needed, run pnpm write-translations in documentation/ so i18n/en/*.json picks up new keys.
3. Heading IDs: pnpm write-heading-ids (from documentation/).
4. Translate from the repo root (or use the shortcuts below from documentation/):
   • pnpm i18n:extract — refresh src/locales/strings.json from t('…') in the Next.js app.
   • pnpm i18n:translate:docs — translate markdown/JSON into documentation/i18n/ per config.
   • pnpm i18n:translate:svg — translate SVGs under documentation/static/img as configured.
   • Or run everything: pnpm i18n:translate.
5. Build: cd documentation && pnpm build (all locales).

From inside documentation/, the same flows are wired as pnpm translate → root i18n:translate, plus pnpm translate:docs, translate:ui, translate:svg, translate:status, i18n:extract, i18n:sync.

Glossary

• UI terminology for documentation is driven by glossary.uiGlossary in ai-i18n-tools.config.json, pointing at src/locales/strings.json (the catalog produced by pnpm i18n:extract).
• Overrides live in documentation/glossary-user.csv (glossary.userGlossary in config). See the ai-i18n-tools glossary docs for column format.
• Generate a CSV template: pnpm i18n:glossary-generate (root).

Cache

Translation cache for ai-i18n-tools is under .translation-cache/ at the repo root (cacheDir in ai-i18n-tools.config.json). It is gitignored. Use pnpm i18n:status and the CLI’s --force / cache flags per ai-i18n-tools documentation when you need a full refresh.

Heading IDs and anchors

Use explicit IDs so links stay stable across languages:

## This is a heading \{#this-is-a-heading}

cd documentation
pnpm write-heading-ids

Ignore lists

Use .translate-ignore at the repo root (same idea as .gitignore) for paths the doc translator should skip, if you add one for your workflow.

Docusaurus theme JSON

pnpm write-translations extracts Docusaurus UI strings into documentation/i18n/en/. The ai-i18n-tools translate-docs step (with markdownOutput.style: "docusaurus") fills translated JSON under each locale alongside markdown, per ai-i18n-tools.config.json.

Samasya Nivaran

• OPENROUTER_API_KEY Nirdharit nahin kiya gaya — ise export karen ya repo root mein .env.local mein joden.
• Model / gunavatta — openrouter.translationModels aur sambandhit vikalpon ko ai-i18n-tools.config.json mein adjust karen.
• Shabdavali — documentation/glossary-user.csv ko edit karen ya UI strings ko pun: utpann karen aur extract + translate ko pun: chalayen.

Nayi Bhaasha {#adding-a-new-language} Jodna

1. Docusaurus i18n.locales aur localeConfigs ko documentation/docusaurus.config.ts mein locale joden.
2. targetLocales ko ai-i18n-tools.config.json (repo root) mein bhi vahi locale joden.
3. Root par pnpm i18n:generate-ui-languages chalayen, phir avashyakta anusar pnpm i18n:extract / translate commands chalayen.