Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-07-17 16:37:43 +00:00
Code Issues Projects Releases Wiki Activity
super-productivity/docs/wiki/2.18-Contribute-Translations.md
Corey Newton c2b18683d8
docs/wiki content v0.7 (#6568) 
* docs(wiki): add new Quickstart to help with using Sync

There is a slew of notes that try to explain or show this so a
Quickstart can help bring everything into one place.

* docs(wiki): combine "First Steps" into single note with relevant links

* docs(wiki): update index notes

* docs(wiki): fix remaining broken external links

* docs(wiki): add core developer How-To guides to orient first-time devs

The majority of the documentation is currently spread across several
files ins "docs/" and READMEs. Over time these can be consolidated into
the wiki while retaining the common CONTRIBUTING.md as a valid entry
point.

* docs(wiki): add basic guides for plugins and issue integration

As with the core development docs, there is too much to add here right
now. These notes will serve as a simple entry to other resources.

* docs(wiki): add basic reference note for theming

* docs(wiki): add basic Translation guide

* docs(wiki): rename Theming and linting to clean up headings

* docs(wiki): add heading lint exception for GH-specific nav pages; rework sidebar and index pages

Sidebar should be a quick-access for the more common topics grouped
thematically with the X.00 notes simply enumerating all the notes where
appropriate.
2026-02-20 21:13:38 +01:00

1.3 KiB
Raw Permalink Blame History

Contribute Translations

How to add or update translations for Super Productivity.

Translations are JSON files in src/assets/i18n/ (e.g. de.json, fr.json). English (en.json) is the fallback: missing or empty values show the English text.

Steps

  1. Open the language file in src/assets/i18n/ for your locale.
  2. Edit string values only. Keep the same nested structure and SCREAMING_SNAKE_CASE keys.
  3. Leave a key as "" if you want the English fallback; do not copy English text into empty strings unless you are providing a real translation.
  4. Run the app locally (2.11-Run-the-Development-Server) and check the UI.
  5. Submit a pull request with the changed JSON file(s).

Format and Conventions

  • Nested JSON; only change the string values, not keys or structure.
  • Prefer short, clear text (UI space is limited).
  • Use en.json as the reference for context and key names.

Translation Tooling

For finding missing keys and keeping files in sync, use the script described in the repo:

docs/i18n-script-usage.md (and tools/add-missing-i18n-variables.js).

Full contributor notes: docs/TRANSLATING.md.

Related