Skip to content

Commit fb9b574

Browse files
chore: Platform section update with new heading and minor improvements (#1054)
1 parent 7cf223a commit fb9b574

27 files changed

+532
-511
lines changed

package-lock.json

Lines changed: 385 additions & 375 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@
2626
"og-images": "npm run generate-og-images && npm run convert-og-images"
2727
},
2828
"dependencies": {
29-
"@docusaurus/babel": "^3.9.1",
30-
"@docusaurus/core": "^3.9.1",
31-
"@docusaurus/mdx-loader": "^3.9.1",
32-
"@docusaurus/plugin-content-docs": "^3.9.1",
33-
"@docusaurus/preset-classic": "^3.9.1",
34-
"@docusaurus/theme-classic": "^3.9.1",
35-
"@docusaurus/theme-common": "^3.9.1",
36-
"@docusaurus/utils": "^3.9.1",
29+
"@docusaurus/babel": "^3.9.2",
30+
"@docusaurus/core": "^3.9.2",
31+
"@docusaurus/mdx-loader": "^3.9.2",
32+
"@docusaurus/plugin-content-docs": "^3.9.2",
33+
"@docusaurus/preset-classic": "^3.9.2",
34+
"@docusaurus/theme-classic": "^3.9.2",
35+
"@docusaurus/theme-common": "^3.9.2",
36+
"@docusaurus/utils": "^3.9.2",
3737
"@emotion/react": "^11.11.4",
3838
"@emotion/styled": "^11.11.5",
3939
"@mui/icons-material": "^5.15.15",
@@ -63,10 +63,10 @@
6363
]
6464
},
6565
"devDependencies": {
66-
"@docusaurus/eslint-plugin": "^3.9.1",
67-
"@docusaurus/module-type-aliases": "^3.9.1",
68-
"@docusaurus/plugin-client-redirects": "^3.9.1",
69-
"@docusaurus/tsconfig": "^3.9.1",
66+
"@docusaurus/eslint-plugin": "^3.9.2",
67+
"@docusaurus/module-type-aliases": "^3.9.2",
68+
"@docusaurus/plugin-client-redirects": "^3.9.2",
69+
"@docusaurus/tsconfig": "^3.9.2",
7070
"@types/imagemagick": "0.0.31",
7171
"@types/node": "18.6.3",
7272
"@types/react": "^18.2.29",
Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: about_tolgee
3-
title: About Tolgee
4-
sidebar_label: About Tolgee
3+
title: What is Tolgee? Developer-Friendly TMS
4+
sidebar_label: What is Tolgee?
55
slug: /
66
image: /img/og-images/platform.png
77
---
@@ -11,34 +11,34 @@ import { ReviewAuthor } from '../shared/_ReviewAuthor';
1111
Tolgee is a **localization platform** that allows you to translate your application into any language without modifying your code.
1212
It is designed to be used with web applications, but it can be used also with mobile apps and desktop applications.
1313

14-
Tolgee is a developer-focused platform, so it is **easy to integrate** with your application.
14+
Tolgee is a developer-focused Translation Management System (TMS) that helps with internationalization (i18n), and it is **easy to integrate** with your application.
1515
No more looking for keys in your source code, no more editing localization files, and no more manual exporting data for translators.
1616

17-
## Features
17+
<ReviewAuthor
18+
author={{
19+
imageURL: '/img/reviewers/thibaud.jpeg',
20+
name: 'Thibaud C.',
21+
title: 'Lead Developper',
22+
}}
23+
description="Tolgee is very easy to use and to integrate with i18n libraries. We like it a lot for its collaboration capabilities."
24+
capterraReview="https://www.capterra.com/p/10002120/Tolgee/reviews/Capterra___4438876/"
25+
/>
26+
27+
## Key Features of Tolgee Localization Platform
1828

1929
- **Developer-friendly** - Tolgee is designed to be easy to integrate with your application. There are integrations for web frameworks via the [Tolgee JS SDK](/js-sdk) and for native mobile apps via the [Tolgee iOS SDK](/ios-sdk) and [Tolgee Android SDK](/android-sdk).
2030
- **Easy to use** - Tolgee is easy to use for developers, but also for translators, so you can easily involve your translators into your localization process.
2131
- **Open-source** - Tolgee is open-source, you can contribute to the project on our [GitHub repository](https://github.com/tolgee/tolgee-platform). You can also [host your own instance](/platform/self_hosting/getting_started) of Tolgee, so you can have full control over your data.
2232
- **Free** - Our **cloud version** includes Business plan with 10,000 keys is **free for any open-source projects**. For commercial projects, you can use Tolgee for free up to 500 keys. For more information, see [pricing](https://tolgee.io/pricing).
2333
- **In-context editor** - Tolgee provides in-context editor, so translators can easily translate your application without leaving your application.
24-
- **AI translator**[AI Translator](/platform/translation_process/ai_translator) can make software localization much faster and more autonomous. It provides more accurate translations than general translators as it gathers context through Tolgee's native JS SDKs, which provide in-context dialogs.
34+
- **AI translator**[AI Translator](/platform/translation_process/ai_translator) can make software localization much faster and more autonomous. It provides more accurate translations than general translators as it gathers context through Tolgee's native JS SDKs, which provide in-context dialogs.
2535

26-
## Intrigued yet?
36+
## Start using Tolgee
2737

2838
If you want to try Tolgee, you can [sign up](https://app.tolgee.io/sign_up) for free and start using it right away. After you sign up, you will be able to [create your first project](/platform/getting_started/creating_project) and start translating your application.
2939

3040
## Other Tolgee Docs
3141

32-
- [JavaScript SDK](/js-sdk)
42+
- [Tolgee JavaScript SDKs](/js-sdk)
3343
- [Tolgee CLI](/tolgee-cli)
34-
- [REST API](/api)
35-
36-
<ReviewAuthor
37-
author={{
38-
imageURL: '/img/reviewers/thibaud.jpeg',
39-
name: 'Thibaud C.',
40-
title: 'Lead Developper',
41-
}}
42-
description="Tolgee is very easy to use and to integrate with i18n libraries. We like it a lot for its collaboration capabilities."
43-
capterraReview="https://www.capterra.com/p/10002120/Tolgee/reviews/Capterra___4438876/"
44-
/>
44+
- [Tolgee REST API](/api)

platform/getting_started/creating_project.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
---
22
id: creating_project
3-
title: Creating Project
4-
sidebar_label: Creating Project
3+
title: How to Create a Project in Tolgee
4+
sidebar_label: How to Create a Project
55
image: /img/og-images/platform.png
66
---
77

88
import { ScreenRecording } from '../shared/_ScreenRecording';
99

1010
After logging in or clicking on Tolgee logo in left top corner, you will be redirected to the Projects list view.
1111

12+
## Tolgee Project Setup: A Tutorial Setting Up Base Language
13+
1214
To create a project, click the `+ Add` button in the upper right corner. Then fill the name of the project and select the languages (you can also create a custom language).
1315

14-
You need to select one of the languages as a **base language** this language will be used as a source of translations. You can add more languages later in the [Languages settings](/platform/projects_and_organizations/languages#editing-languages).
16+
You need to select one of the languages as a **base language** - this language will be used as a source of translations. You can add languages to a project later in the [Languages settings](/platform/projects_and_organizations/languages#edit-language-settings-and-properties).
1517

1618
<ScreenRecording>
1719
<source src="/create-project.mov" />

platform/getting_started/translation_content.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
id: files_and_integrations
3-
title: Translation Files and Integrations
4-
sidebar_label: Translation Files and Integrations
3+
title: Import and Export Translation Files
4+
sidebar_label: Import and Export Files
55
description: Learn how you can import existing files into the project and use our JS SDK or Android SDK to seamlessly integrate your code with your Tolgee project.
66
image: /img/og-images/platform.png
77
---
88

99
After you have [created a project](creating_project), you can import existing files into the project, use our JS SDK or Android SDK to seamlessly integrate your code with your Tolgee project, or use our API to integrate your project with your own system.
1010

11-
## Importing files
11+
## How to Import Translation Files into Tolgee
1212

13-
To import existing translation files into your project, open the created project and click on the `Import` menu item.
14-
Then select what language and [namespace](/platform/translation_keys/namespaces) (not required) you want to import the files into and click the `Import` button.
13+
To import existing translation files (or, in other words, localization files) into your project (like JSON translation files), open the created project and click on the `Import` menu item.
14+
Then select what language and [namespace](/platform/translation_keys/namespaces) (not required) you want to import the files into and click the `Import` button. This way you can bulk import translations and save time on manually adding translations.
1515

16-
More information about importing files can be found in the [Import](/platform/projects_and_organizations/import) page.
16+
More information about importing files and file format can be found in the [Import](/platform/projects_and_organizations/import) page.
1717

18-
## Exporting files
18+
## How to Export Translation Files into Tolgee
1919

2020
To export the translations, open the project and click on the `Export` menu item.
2121
Then select what languages, file formats and [namespaces](/platform/translation_keys/namespaces) you want to export and click the `Export` button.
2222

2323
More information about exporting files can be found in the [Export](/platform/projects_and_organizations/export) page.
2424

25-
## JS SDK
25+
## JavaScript SDK Integration for Localization
2626

2727
Tolgee provides a [JS SDK](/js-sdk) that can be used to easily integrate your Tolgee project with your codebase.
2828
This way, you can use the same translation keys in your code as you use in your Tolgee project.
@@ -31,11 +31,11 @@ In production mode, you should use data exported from the Tolgee platform.
3131
To export the translation files, see [exporting translations](/platform/projects_and_organizations/export).
3232
Then provide the data via Tolgee configuration options described in [Providing static data](/js-sdk/providing-static-data).
3333

34-
## iOS SDK
34+
## iOS SDK for Localization
3535

3636
Tolgee provides a native [iOS SDK](/ios-sdk) with a great support for SwiftUI that integrates with your app and supports OTA updates of strings from a CDN.
3737

38-
## Android SDK
38+
## Android SDK for Localization
3939

4040
Tolgee also provides an [Android SDK](/android-sdk) for native Android apps, including Jetpack Compose support. Follow the Android docs to:
4141

platform/projects_and_organizations/ai_settings.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
id: ai-settings
3-
title: AI Settings
3+
title: AI Translation Settings
44
image: /img/og-images/platform.png
55
---
66

77
import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';
88

9-
## Prompts section
9+
## Custom AI Prompts for AI translation
1010

1111
<ScreenshotWrapper
1212
alt="Providing project description"
@@ -15,12 +15,12 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';
1515

1616
In this section, you can see all custom prompts for the current project.
1717

18-
### Adding new prompt
18+
### Create Custom Translation Prompts
1919

2020
Click on `+ Prompt` (or `OpenAi Playground` if the list is empty); this will redirect you to the
2121
[AI Playground](../translation_process/ai_playground.mdx) with default prompt, which you can edit and save as a custom prompt.
2222

23-
### Managing prompts
23+
### Edit and Manage AI Prompts
2424

2525
Click on the`` icon next to any custom prompt to see a prompt menu.
2626

@@ -31,15 +31,15 @@ Click on the`⋮` icon next to any custom prompt to see a prompt menu.
3131

3232
From here you can edit the prompt (redirects to the playground with the selected prompt opened), rename or delete the prompt.
3333

34-
## Context data (formerly AI customization)
34+
## AI Context Data (formerly AI customization)
3535

3636
:::info
3737
This feature is only available with a Business subscription or higher on Tolgee cloud and Subscribed Self-hosted
3838
instances with [AI translator](/platform/translation_process/ai_translator) enabled as the translation provider.
3939
:::
4040

4141
If you wish to enhance the results from the [AI translator](/platform/translation_process/ai_translator),
42-
you can customize it according to your needs. Tolgee enables you to input key descriptions,
42+
you can customize AI translation according to your needs. Tolgee enables you to input key descriptions,
4343
project descriptions, or language notes. This information is provided along with the actual string
4444
that requires translation. It helps to understand the context of your translation project and provide
4545
more accurate translations.

platform/projects_and_organizations/content_delivery.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: content_delivery
3-
title: Content Delivery
4-
sidebar_label: Content Delivery
3+
title: Content Delivery (Deploy Files to Cloud)
4+
sidebar_label: Content Delivery to Cloud
55
description: Content Delivery will deploy your localization files to reliable and fast cloud storage so you can confidently use them in your application.
66
image: /img/og-images/platform.png
77
---
@@ -71,7 +71,7 @@ Content delivery is made to be rapidly available all around the world, so we pri
7171

7272
> Read more about [providing Tolgee SDK with static data](/js-sdk/providing-static-data).
7373
74-
## Manual publishing
74+
## Manual publishing of Localization Files
7575

7676
If you opted out of automatic publishing, you can do so manually in the list of content deliveries by `Publish` button.
7777

platform/projects_and_organizations/editing_translations.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
id: editing_translations
3-
title: Editing translations
4-
sidebar_label: Editing translations
3+
title: How to Edit Translations in Tolgee
4+
sidebar_label: How to Edit Translations
55
image: /img/og-images/platform.png
66
---
77

88
For editing translation strings, Tolgee provides an editor, which helps translators translate strings in a
99
convenient way.
1010

11-
## The translations view
11+
## How to Edit Translation Strings: The Translations View
1212
The translations view enables you to access translation keys, the translation text in the target languages. It allows you to
1313
add comments or see the history. When translating, you can also get the results from [machine translation](../translation_process/machine_translation.mdx) providers and
1414
[translation memory](../translation_process/translation_memory.mdx).
@@ -19,8 +19,8 @@ import { ScreenshotWrapper } from "../shared/_ScreenshotWrapper";
1919
alt="Translations View" />
2020

2121
## Editing the translation
22-
You can enter translation editing mode by clicking on the translation text. This will open the translation editor.
23-
When editing translation, translation memory, machine translation, comments and history are displayed in the right panel.
22+
You can edit translations by entering editing mode by clicking on the translation text. This will open the translation editor.
23+
When using the localization editor, translation memory, automatic translation (machine translation and AI translation), comments and history are displayed in the right panel.
2424

2525
### Editing translation with placeholders
2626
When translation text contains placeholders, their code is hidden by default. So you don't have to understand the actual
@@ -37,16 +37,16 @@ To add a new placeholder, you can just type the placeholder syntax into the tran
3737
will be automatically visualized. Read more about [Tolgee Universal ICU placeholders here](/platform/translation_process/tolgee_universal_icu_placeholders)
3838
to know about all the supported placeholder types and syntax.
3939

40-
### Editing placeholders as a code
41-
Sometimes, you might want to edit the whole message as a code with placeholders and HTML tags. You can do that by switching
40+
### Code Mode vs Visual Mode
41+
Sometimes, you might want to edit the whole message as a code with placeholders and HTML tags instead of using translation editor. You can do that by switching
4242
the editor to the code mode in top right of the current language translation editor above the translation input.
4343

4444
<ScreenshotWrapper src="/img/docs/platform/editing_translations/code_mode.webp"
4545
alt="Switching to code mode" />
4646

4747
This way, you can switch between the code and visual mode to edit the translation.
4848

49-
## Editing plurals
49+
## Managing and Using Plural Translations
5050
When editing plural translations, each plural form is displayed in a separate input.
5151

5252
<ScreenshotWrapper src="/img/docs/platform/editing_translations/editing_plurals.webp"

platform/projects_and_organizations/export.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: export
3-
title: Export
4-
sidebar_label: Export
3+
title: Export Translation Files
4+
sidebar_label: Export Translation Files
55
description: Translations can be exported from Tolgee. You can currently export translations in two formats (JSON and XLIFF)
66
image: /img/og-images/platform.png
77
---
@@ -10,35 +10,35 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';
1010

1111
Translations can be exported from Tolgee. You can currently export translations in [many different formats](/platform/supported_formats), and you can also export only specific translations, e.g., only the ones that are not translated yet.
1212

13-
## Exporting from Tolgee
13+
## Export Translations from Tolgee Dashboard
1414

1515
To export translations from Tolgee, select project, and then choose the "Export" item from the sidebar.
1616

1717
![img](/img/docs/platform/project_menu_export.webp)
1818

1919
Then you can choose the following options:
2020

21-
- **States** which translations should be exported. You can choose multiple states.
22-
- **Languages** which languages should be exported (all languages are exported by default).
23-
- **Format** select the format of the exported file. Currently, we support only JSON and XLIFF formats.
24-
- **Namespaces** which namespaces should be exported (all namespaces are exported by default). Learn more about namespaces in [this article](/platform/translation_keys/namespaces).
25-
- **Nested structure** whether the exported file should be structured as nested objects or not (based on the "." separator in key names). This option is available **only for JSON format**.
21+
- **States** - which translations should be exported. You can choose multiple states.
22+
- **Languages** - which languages should be exported (all languages are exported by default).
23+
- **Format** - select the format of the exported file. Currently, we support only JSON and XLIFF formats.
24+
- **Namespaces** - which namespaces should be exported (all namespaces are exported by default). Learn more about namespaces in [this article](/platform/translation_keys/namespaces).
25+
- **Nested structure** - whether the exported file should be structured as nested objects or not (based on the "." separator in key names). This option is available **only for JSON format**.
2626

2727
When you are done, click the `Export` button and the file will be downloaded.
2828

2929
<ScreenshotWrapper src="/img/docs/platform/export.webp" alt="Export options" />
3030

3131
> If you want to specify exactly which keys need to be exported, you can go to [Batch operations](../translation_keys/batch_operations.mdx) and export from there.
3232
33-
## Exporting via CLI
33+
## Export Translations via CLI
3434

3535
You can also export translations via [Tolgee CLI](/tolgee-cli). To do so, you need to have the Tolgee CLI installed. You can find the installation instructions [here](/tolgee-cli/installation).
3636

3737
Then you can use the [`tolgee pull`](/tolgee-cli/push-pull-strings#pulling-strings) command to export translations.
3838

3939
The command exports strings from the platform, and saves them in a folder of your choice. You can use this to download strings from Tolgee before bundling your app for production.
4040

41-
## Exporting via API
41+
## Export Translations via REST API
4242

4343
You can also export translations via REST API, e.g., via the `curl` utility:
4444

platform/projects_and_organizations/import.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
id: import
3-
title: Import
4-
sidebar_label: Import
5-
image: /img/og-images/platform.png
3+
title: Import Translation Files
4+
sidebar_label: Import Translation Files
5+
image: /img/og-images/platform.png
66
---
77

8-
Tolgee supports importing existing translations from various formats. You can import translations from JSON, XLIFF, and PO files.
8+
Tolgee supports importing existing translations from various formats. Here is the list of [Tolgee supported formats](/platform/supported_formats).
9+
10+
You can import translations from JSON, XLIFF, PHP, C/C++, Python, Apple Strings, Apple Stringsdict, Apple Strings Catalog, Apple XLIFF, Android XML, Compose Multiplatform XML, Flutter ARB, Ruby YAML, i18next, CSV, .NET RESX, and XLSX files.
911

1012
import { ScreenshotWrapper } from "../shared/_ScreenshotWrapper";
1113

12-
## Importing to Tolgee
14+
## Importing Translation Files to Tolgee
1315

1416
To import translations to Tolgee, you need to have a project created. You can create a project in the [Projects](/platform/getting_started/creating_project) section.
1517
After creating a project, you can import translations to it by navigating to the "Import" page.
@@ -26,7 +28,7 @@ When you are done, click the `Import` button and the file will be imported into
2628

2729
<ScreenshotWrapper src="/img/docs/platform/import/import_file.webp" alt="Import file" />
2830

29-
### Resolving conflicts
31+
### Resolving conflicts during import
3032

3133
When you import a file, Tolgee will check if the imported strings already exist in the project. If there are some **conflicts** in the strings, you will be prompted to **resolve them**.
3234

0 commit comments

Comments
 (0)