From 93415ebbd7244a3b4c985fd9fd5260b49ffc892e Mon Sep 17 00:00:00 2001 From: Marco Beretta <81851188+berry-13@users.noreply.github.com> Date: Mon, 10 Feb 2025 15:02:33 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20Update=20Language=20Requ?= =?UTF-8?q?est=20Template=20&=20Update=20README=20(#5766)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README.md * Update NEW-LANGUAGE-REQUEST.yml * Updated: README.md Removed: TRANSLATION.md --------- Co-authored-by: Ruben Talstra --- .../ISSUE_TEMPLATE/NEW-LANGUAGE-REQUEST.yml | 4 +- .github/TRANSLATION.md | 70 ------------------- README.md | 6 +- 3 files changed, 5 insertions(+), 75 deletions(-) delete mode 100644 .github/TRANSLATION.md diff --git a/.github/ISSUE_TEMPLATE/NEW-LANGUAGE-REQUEST.yml b/.github/ISSUE_TEMPLATE/NEW-LANGUAGE-REQUEST.yml index d924019b9a9..5fddced9f87 100644 --- a/.github/ISSUE_TEMPLATE/NEW-LANGUAGE-REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/NEW-LANGUAGE-REQUEST.yml @@ -1,7 +1,7 @@ name: New Language Request description: Request to add a new language for LibreChat translations. title: "New Language Request: " -labels: ["enhancement", "i18n"] +labels: ["✨ enhancement", "🌍 i18n"] body: - type: markdown attributes: @@ -30,4 +30,4 @@ body: description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/.github/CODE_OF_CONDUCT.md). options: - label: I agree to follow this project's Code of Conduct - required: true \ No newline at end of file + required: true diff --git a/.github/TRANSLATION.md b/.github/TRANSLATION.md deleted file mode 100644 index 080505048fe..00000000000 --- a/.github/TRANSLATION.md +++ /dev/null @@ -1,70 +0,0 @@ -# LibreChat Translation Guide - -Thank you for your interest in translating LibreChat! We rely on community contributions to make our application accessible to users around the globe. We manage all translations using [Locize](https://locize.com), a powerful translation management system that integrates seamlessly with our project. - -## How Translations Work - -- **Centralized Management:** All translation strings for LibreChat are managed in a single location on Locize. This allows us to keep translations consistent across all parts of the application. -- **Automatic Updates:** Changes made in Locize are automatically synchronized with our project. You can see the current translation progress for each language via the dynamic badges in our GitHub repository. -- **Community Driven:** We welcome contributions in all languages. Your help ensures that more users can enjoy LibreChat in their native language. - -## Getting Started - -### 1. Create a Locize Account - -If you don't already have an account, please register using our invite link: - -[Register at Locize](https://www.locize.app/register?invitation=t1VDfqoRvj8eUkd1JasxxrBCCI4SAqeeofa2YumAgmVDRxkr4vO1jKqNmpaNCv7H) - -This invitation will give you access to our translation project once you’ve created your account. - - -## Adding a New Language - -If you do not see your language listed in our current translation table, please help us expand our language support by following these steps: - -1. **Create a New Issue:** Open a new issue in the GitHub repository. -2. **Use the Template:** When creating your issue, please select the **New Language Request** template. This template will guide you through providing all the necessary details, including: - - The full name of your language (e.g., Spanish, Mandarin). - - The [ISO 639-1](https://www.w3schools.com/tags/ref_language_codes.asp) code for your language (e.g., es for Spanish). -3. **Collaborate with Maintainers:** Our maintainers will review your issue and work with you to integrate the new language. Once approved, your language will appear in the translation progress table, and you can start contributing translations. - - -## Translation Progress - -Below is our current translation progress for some of the supported languages. Feel free to check these badges and help us improve the translations further: - -| Language | Translation Progress Badge | -|---------------------------------------|----------------------------| -| **English (en)** | ![EN Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'en'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=EN:+) | -| **Arabic (ar)** | ![AR Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'ar'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=AR:+) | -| **German (de)** | ![DE Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'de'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=DE:+) | -| **Spanish (es)** | ![ES Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'es'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=ES:+) | -| **Finnish (fi)** | ![FI Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'fi'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=FI:+) | -| **French (fr)** | ![FR Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'fr'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=FR:+) | -| **Hebrew (he)** | ![HE Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'he'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=HE:+) | -| **Indonesian (id)** | ![ID Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'id'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=ID:+) | -| **Italian (it)** | ![IT Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'it'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=IT:+) | -| **Japanese (ja)** | ![JA Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'ja'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=JA:+) | -| **Korean (ko)** | ![KO Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'ko'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=KO:+) | -| **Dutch (nl)** | ![NL Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'nl'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=NL:+) | -| **Polish (pl)** | ![PL Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'pl'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=PL:+) | -| **Portuguese (pt)** | ![PT Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'pt'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=PT:+) | -| **Russian (ru)** | ![RU Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'ru'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=RU:+) | -| **Swedish (sv)** | ![SV Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'sv'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=SV:+) | -| **Turkish (tr)** | ![TR Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'tr'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=TR:+) | -| **Vietnamese (vi)** | ![VI Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'vi'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=VI:+) | -| **Chinese (Simplified) (zh)** | ![ZH Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'zh'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=ZH:+) | -| **Chinese (Traditional) (zh-Hant)** | ![ZH-HANT Badge](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&color=2096F3&label=Locize&query=%24.versions%5B'latest'%5D.languages%5B'zh-Hant'%5D.translatedPercentage&url=https://api.locize.app/badgedata/4cb2598b-ed4d-469c-9b04-2ed531a8cb45&suffix=%+translated&link=https://www.locize.com&prefix=ZH-HANT:+) | - ---- - -## Need Help? - -If you have any questions about the translation process or need assistance getting started, please feel free to: - -- Open an issue in this repository. -- Join our [Discord community](https://discord.librechat.ai) to chat with fellow translators and contributors. -- Contact one of the project maintainers directly. - -Your contributions help make LibreChat better for users worldwide. Happy translating! diff --git a/README.md b/README.md index 0a04518c452..2e662ac262f 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@

- + Translation Progress @@ -179,7 +179,7 @@ Contributions, suggestions, bug reports and fixes are welcome! For new features, components, or extensions, please open an issue and discuss before sending a PR. -If you'd like to help translate LibreChat into your language, we'd love your contribution! Improving our translations not only makes LibreChat more accessible to users around the world but also enhances the overall user experience. Please check out our [Translation Guide](.github/TRANSLATION.md). +If you'd like to help translate LibreChat into your language, we'd love your contribution! Improving our translations not only makes LibreChat more accessible to users around the world but also enhances the overall user experience. Please check out our [Translation Guide](https://www.librechat.ai/docs/translation). --- @@ -199,4 +199,4 @@ We thank [Locize](https://locize.com) for their translation management tools tha Locize Logo -

\ No newline at end of file +