From 7fcda3bb01414f5919e540961df9ed68c7d0360d Mon Sep 17 00:00:00 2001 From: LukeGus Date: Wed, 7 Oct 2026 22:38:33 -0500 Subject: [PATCH] chore: update translation guidance, only en.json needs editing --- CONTRIBUTING.md | 2 +- src/ui/locales/README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d0ce623b..0e97834e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,7 +57,7 @@ npm run format # format the code with Prettier ## Guidelines - Follow the existing code style. The frontend uses React, Tailwind CSS and shadcn components in `src/ui/`. -- Never hardcode text. Use `t()` and add the English string to `src/ui/locales/en.json`. Other languages are translated on [Crowdin](https://docs.termix.site/translations). +- Never hardcode text. Use `t()` and add the English string to `src/ui/locales/en.json`. That's the only locale file you need to update. Other languages are translated automatically, and if an automatic translation is wrong you can fix it in that language's file. - Keep the UI flat and square. Avoid rounded corners on panels, cards and dialogs. - Use the theme variables (like `var(--bg-base)` and `var(--text-primary)`) instead of fixed colors. - There is one component tree for desktop and mobile. Use `src/ui/hooks/use-mobile.ts` for layout changes. diff --git a/src/ui/locales/README.md b/src/ui/locales/README.md index 19fe8f3f4..094c3a098 100644 --- a/src/ui/locales/README.md +++ b/src/ui/locales/README.md @@ -1,3 +1,5 @@ -# Do Not Edit Translated Files +# Translations -Only `en.json` is edited by hand. Every other file here is translated through Crowdin and will be overwritten. See the [docs](https://docs.termix.site/translations) to help translate. +Only `en.json` needs to be updated. Every other language in `translated/` is filled in automatically for any string that doesn't have a translation yet. + +If an automatic translation is wrong, fix it in that language's file. Strings that already have a translation are never overwritten.