Skip to content

Document target languages for translations workflow #5664

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document target languages for translations workflow #5664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions workflows/enable.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,17 @@

Add optional instructions appended to the workflow's base prompt. Use these instructions to adjust the style, tone, or other aspects unique to your project.

### Target languages

The translations workflow translates source content into the target languages you select. When you first enable the workflow, Mintlify pre-populates the target languages from the non-default languages defined in your [`docs.json` navigation](/organize/navigation#languages). You can change the selection at any time from the workflow's settings.

- The workflow uses the `default` language from your `docs.json` navigation as the source language. If no default is set, Mintlify falls back to the first listed language, then to English.

Check warning on line 64 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L64 

In general, use active voice instead of passive voice ('is set').
- You can only select languages supported by Mintlify's translation models. Unsupported or duplicate entries are ignored.

Check warning on line 65 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L65 

In general, use active voice instead of passive voice ('are ignored').
- The source language cannot be a target language.
- You must select at least one target language. The workflow will not run until at least one valid target language is configured.

Check warning on line 67 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L67 

Avoid using 'will'.

Check warning on line 67 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L67 

In general, use active voice instead of passive voice ('is configured').

<Note>
If your project has no non-default languages configured in `docs.json`, you must choose target languages in the workflow settings before enabling the translations workflow.
</Note>

<GitlabWorkflowSetup />
Loading