From 64f12e571780539d1060df2b9dba8b00d69f4f1c Mon Sep 17 00:00:00 2001 From: Leonabcd123 <156839416+Leonabcd123@users.noreply.github.com> Date: Tue, 14 Apr 2026 22:02:51 +0300 Subject: [PATCH] docs(languages): update languages documentation --- docs/CONTRIBUTING.md | 2 +- docs/LANGUAGES.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d040161513aa..bbcbe28a6b91 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -67,7 +67,7 @@ If you want to contribute themes but don't know how, check [THEMES.md](/docs/THE - Do not include expletive words - Ensure that your contribution meets JSON standards (no trailing comma at the end of a list) -- Be sure to add your language to the `_list` and `_groups` files +- Be sure to add your language to the [packages/schemas/src/languages.ts](/packages/schemas/src/languages.ts) and [frontend/src/ts/constants/languages.ts](/frontend/src/ts/constants/languages.ts) files - Make sure the number of words in the file corresponds to the file name (for example: `languageName.json` is 200 words, `languageName_1k.json` is 1000 words, and so on) If you want to contribute languages but don't know how, check [LANGUAGES.md](/docs/LANGUAGES.md) diff --git a/docs/LANGUAGES.md b/docs/LANGUAGES.md index e65156da5992..5e1e4f1c7b5f 100644 --- a/docs/LANGUAGES.md +++ b/docs/LANGUAGES.md @@ -31,7 +31,7 @@ The contents of the file should be as follows: It is recommended that you familiarize yourselves with JSON before adding a language. For the `name` field, put the name of your language. `rightToLeft` indicates how the language is written. If it is written right to left then put `true`, otherwise put `false`. `ligatures` A ligature occurs when multiple letters are joined together to form a character [more details](). If there's joining in the words, which is the case in languages like (Arabic, Malayalam, Persian, Sanskrit, Central_Kurdish... etc.), then set the value to `true`, otherwise set it to `false`. For `bcp47` put your languages [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). If the words you're adding are ordered by frequency (most common words at the top, least at the bottom) set the value of `orderedByFrequency` to `true`, otherwise `false`. Finally, add your list of words to the `words` field. -Then, go to `packages/schemas/src/languages.ts` and add your new language name at the _end_ of the `LanguageSchema` enum. Make sure to end the line with a comma. Make sure to add all your language names if you have created multiple word lists of differing lengths in the same language. +Then, go to [packages/schemas/src/languages.ts](/packages/schemas/src/languages.ts) and add your new language name at the _end_ of the `LanguageSchema` enum. Make sure to end the line with a comma. Make sure to add all your language names if you have created multiple word lists of differing lengths in the same language. ```typescript export const LanguageSchema = z.enum([ @@ -42,7 +42,7 @@ export const LanguageSchema = z.enum([ ]); ``` -Then, go to `frontend/src/ts/constants/language.ts` and add your new language name to the `LanguageGroups` map. You can either add it to an existing group or add a new one. Make sure to add all your language names if you have created multiple word lists of differing lengths in the same language. +Then, go to [frontend/src/ts/constants/languages.ts](/frontend/src/ts/constants/languages.ts) and add your new language name to the `LanguageGroups` map. You can either add it to an existing group or add a new one. Make sure to add all your language names if you have created multiple word lists of differing lengths in the same language. ```typescript export const LanguageGroups: Record = {