From f2a72a568e3da38741cfc20bf179edeaedfa03e2 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Mon, 4 Mar 2024 10:58:03 -0800 Subject: [PATCH] docs: update i18n/README.md --- .gitignore | 1 + i18n/readme.md | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 44912a41b..3c8c881fa 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,5 @@ build/ content/ i18n/ !i18n/en/ +!i18n/README.md docs/v** diff --git a/i18n/readme.md b/i18n/readme.md index 07cc79f42..bdff2c49e 100644 --- a/i18n/readme.md +++ b/i18n/readme.md @@ -12,11 +12,12 @@ Some of the files that are generated are `code.json`, `navbar.json`, For the website's source language (`en-US`), these JSON files are **not** used by Docusaurus. Rather, they serve as source files for our [Crowdin](https://crowdin.com/project/electron) internationalization (i18n) -workflow. The [`electron/i18n`](https://github.com/electron/i18n) repository -periodically updates these source strings on Crowdin via -[GitHub Actions](https://github.com/electron/i18n/actions/workflows/schedule-update-source-content.yml). +workflow. To keep everything in sync, there is a pre-commit hook that automatically deletes and creates again the `en-US` folder and its contents when `docusaurus.config.js` or `sidebars.js` are modified. -The script the hook invokes is in `/scripts/update-l10n-sources.js`. +The script the hook invokes is in `/scripts/update-l10n-sources.ts`. + +For details on how to contribute to the i18n of the Electron docs, please +see [i18n.md](../i18n.md).