Skip to content

Update translations page #834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified images/translations/translations-dashboard-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/translations/translations-dashboard-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions translations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@

Start with a complete translation of your documentation into each of your preferred languages. This approach ensures complete coverage in each language and automatically updates your `docs.json` file.

You can initiate a complete translation from the translations page in your [dashboard](https://dashboard.mintlify.com/settings/organization/translations).
You can initiate a complete translation from the translations page in your [dashboard](https://dashboard.mintlify.com/settings).

1. Select **Start translation**.
2. Select the first language that you want to translate your content to and then select **Start translation**.
3. The translation process will create a new branch and pull request in your Mintlify project repository with the translated content. Larger documentation sets may take longer to process.
1. Select **Translations** in the left sidebar.
1. Select **Configure**.
2. Select the languages that you want to translate your content to and then select **Save configuration**.
3. The translation process will create a new branch and pull request in your docs repository with the translated content. Larger documentation sets may take longer to process.
4. Review the pull request and merge it.
5. Repeat the process for each language that you want to translate to.

<Info>
An automated translation is stored under a directory named after the [language code](/navigation#languages) that you have selected.
Expand All @@ -64,7 +64,7 @@
4. The translation job creates a separate branch and pull request containing the translated changes for your review.

<Info>
Mintlify will never automatically publish translations to production. You must review and merge each translation pull request before the changes are live.
Mintlify will never automatically publish translations to production. You must review and merge each translation pull request before the changes are live.
</Info>

The automatic translation job doesn't handle manual changes to the localized files or the `docs.json` navigation trees well. Make all changes in your English content and let the translation service manage the localized versions.
Expand Down Expand Up @@ -92,7 +92,7 @@
* **Ambiguous link anchors**: Accurately describe where a link goes and avoid ambiguous link anchors like `Click here`. When possible, use the exact title of the page or resource that a link points to.
* **Avoid**: "Click `[here](path/to/getting-started-guide)` to learn more about the setup process."
* **Better**: "Learn more about the setup process in our `[getting started guide](path/to/getting-started-guide)`."
* **Nominalizations**: Verbs or adjectives turned into nouns, often ending in -ion, -ment, or -ness. Use active verbs instead.

Check warning on line 95 in translations.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

translations.mdx#L95

Did you really mean 'Nominalizations'?
* **Avoid**: "The configuration of your navigation requires a valid `docs.json`."
* **Better**: "You must have a valid `docs.json` to configure your navigation."
* **Stacked modifiers**: Multiple nouns or adjectives grouped together create ambiguity about relationships between words.
Expand Down