diff --git a/DOCS-SKILL.md b/DOCS-SKILL.md index cfb1a66d8..058f554ed 100644 --- a/DOCS-SKILL.md +++ b/DOCS-SKILL.md @@ -504,7 +504,7 @@ Only document capabilities that actually exist, and resolve anything uncertain a A "common workflow" section is a bulleted roundup that points readers to the main tasks or settings from a landing page (as in the Dashboard get-started **Key workflows** and **Configuration** lists). Each bullet starts with the action, then a short description, then a link: ```text -- **Define context and key terms for translation:** use Context Groups to guide terminology and style across Projects. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +- **Define context and key terms for translation:** use Context Groups to guide terminology and style across Projects. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). ``` Use common workflow sections on **Get Started pages and other overview/landing pages** to surface the primary tasks, instead of duplicating full how-tos inline. Do not use them mid-guide, where ordered steps belong. diff --git a/docs/en-US/integrations/mintlify/guides/translating-content.mdx b/docs/en-US/integrations/mintlify/guides/translating-content.mdx index 769348e70..eaa98a88a 100644 --- a/docs/en-US/integrations/mintlify/guides/translating-content.mdx +++ b/docs/en-US/integrations/mintlify/guides/translating-content.mdx @@ -43,4 +43,4 @@ Translation happens at the Markdown and MDX syntax level, so your structure and ## Context-aware translation [#context] -Translations are produced by AI agents that understand technical terminology and the surrounding content, so meaning and product terms stay consistent across languages. To steer terminology and tone across your Project, define translation context in the Dashboard. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +Translations are produced by AI agents that understand technical terminology and the surrounding content, so meaning and product terms stay consistent across languages. To steer terminology and tone across your Project, define translation context in the Dashboard. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). diff --git a/docs/en-US/overview/key-concepts.mdx b/docs/en-US/overview/key-concepts.mdx index 8e45b33f4..e610128f2 100644 --- a/docs/en-US/overview/key-concepts.mdx +++ b/docs/en-US/overview/key-concepts.mdx @@ -83,7 +83,7 @@ General Translation applies context through **Context Groups**, which combine tw - **Glossary** defines key terms: product names, feature names, and technical terms that need consistent treatment. - **Custom Prompts** define style and tone: audience, formality, conventions, and formatting. -See [Adding translation context](/docs/platform/dashboard/guides/adding-translation-context) to set this up. +See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations) to set this up. ## Static and dynamic content [#content] diff --git a/docs/en-US/platform/dashboard/get-started.mdx b/docs/en-US/platform/dashboard/get-started.mdx index 466e02071..01443297d 100644 --- a/docs/en-US/platform/dashboard/get-started.mdx +++ b/docs/en-US/platform/dashboard/get-started.mdx @@ -6,7 +6,7 @@ navTitle: "Get started" related: links: - /docs/platform/dashboard/guides/reviewing-translations - - /docs/platform/dashboard/guides/adding-translation-context + - /docs/platform/dashboard/guides/defining-context-for-translations - /docs/platform/dashboard/guides/using-ask-ai - /docs/platform/dashboard/guides/managing-billing @@ -16,7 +16,7 @@ The Dashboard is the web app for reviewing translations, guiding the AI with con ## Key workflows [#key-workflows] -- **Define context and key terms for translation:** use Context Groups to guide terminology and style across Projects. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +- **Define context and key terms for translation:** use Context Groups to guide terminology and style across Projects. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). - **Review and edit translations:** compare locales, make manual edits, and inspect version history. See [Reviewing and editing translations](/docs/platform/dashboard/guides/reviewing-translations). - **Add annotations:** label entries, add notes, and discuss translation decisions with your team. See [Adding annotations](/docs/platform/dashboard/guides/adding-annotations). - **Automate the whole process:** see [Locadex](/docs/platform/locadex/quickstart) to automate localization setup and maintenance. @@ -57,11 +57,11 @@ If you do not see a page, check that you are in the right Organization or Projec **Can I edit translations after they are generated?** Yes. Use the **Translations** page to review and edit generated translations. You can also use annotations to label entries, add notes, and discuss translations with your team. See [Reviewing and editing translations](/docs/platform/dashboard/guides/reviewing-translations). -**What is context?** Context tells AI how to interpret and translate your product. It helps preserve brand and product names, resolve ambiguous words (like whether "cells" refers to rooms, phones, bacteria, or spreadsheets), and keep style consistent across your Organization and Projects. GT applies context through Context Groups, which include a Glossary for terminology and Custom Prompts for tone and style. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +**What is context?** Context tells AI how to interpret and translate your product. It helps preserve brand and product names, resolve ambiguous words (like whether "cells" refers to rooms, phones, bacteria, or spreadsheets), and keep style consistent across your Organization and Projects. GT applies context through Context Groups, which include a Glossary for terminology and Custom Prompts for tone and style. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). -**How do I share terminology across Projects?** Create a Context Group at the Organization level with shared Glossary terms and Custom Prompts, then assign it to multiple Projects. Changes to the group apply everywhere it is assigned. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +**How do I share terminology across Projects?** Create a Context Group at the Organization level with shared Glossary terms and Custom Prompts, then assign it to multiple Projects. Changes to the group apply everywhere it is assigned. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). -**How do I update existing translations after changing the Glossary?** Select relevant terms and use Apply Glossary to update existing translations that contain selected Glossary terms. See [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). +**How do I update existing translations after changing the Glossary?** Select relevant terms and use Apply Glossary to update existing translations that contain selected Glossary terms. See [Defining context for translations](/docs/platform/dashboard/guides/defining-context-for-translations). **How do I regenerate translations?** For code and uploaded translation files, use the CLI or Locadex to run a new translation pass; the Dashboard's **Translations** page does not run full-file retranslation. Linked Google Drive files can be regenerated with **Force retranslation** from the [Google Drive integration](/docs/integrations/google-drive/guides/managing-translations#force). diff --git a/docs/en-US/platform/dashboard/guides/adding-annotations.mdx b/docs/en-US/platform/dashboard/guides/adding-annotations.mdx index d4fc97392..39d1165f4 100644 --- a/docs/en-US/platform/dashboard/guides/adding-annotations.mdx +++ b/docs/en-US/platform/dashboard/guides/adding-annotations.mdx @@ -5,7 +5,7 @@ description: How to coordinate translation reviews by entry and locale with labe related: links: - /docs/platform/dashboard/guides/reviewing-translations - - /docs/platform/dashboard/guides/adding-translation-context + - /docs/platform/dashboard/guides/defining-context-for-translations - /docs/platform/dashboard/guides/using-ask-ai - /docs/platform/dashboard/guides/managing-billing diff --git a/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx b/docs/en-US/platform/dashboard/guides/defining-context-for-translations.mdx similarity index 73% rename from docs/en-US/platform/dashboard/guides/adding-translation-context.mdx rename to docs/en-US/platform/dashboard/guides/defining-context-for-translations.mdx index dcf4b5113..10bc1f5b2 100644 --- a/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx +++ b/docs/en-US/platform/dashboard/guides/defining-context-for-translations.mdx @@ -1,7 +1,7 @@ --- -title: Adding translation context -description: How to use Context Groups, Glossary, and Custom Prompts to guide AI translations. +title: Defining context for translations +description: How to keep terminology, voice, and style consistent across translations using Context Groups. related: links: - /docs/platform/dashboard/guides/reviewing-translations @@ -11,30 +11,28 @@ related: --- -Define how your product should be translated, including **terminology and style** that should stay consistent across Projects and across your whole Organization. - -General Translation applies reusable translation instructions through Context Groups. +Define the highest-quality translations of your product — including key terminology, brand voice, and style. Use Context Groups to apply shared guidance across your app, website, documentation, slides, and every other surface. ## Basic context workflow [#basic-context-workflow] -1. Open your Organization in the Dashboard. +1. Open your Organization in the **[Dashboard](https://dash.generaltranslation.com)**. 2. Go to the **Context** page. 3. Create a **Context Group**. -4. Use the **Glossary** and **Custom Prompts** tabs to add terminology and style guidance. -5. **Assign** your Context Group to relevant Project(s). -6. Generate translations or apply updates to existing translations. +4. Add a **Glossary** (for terminology) and **Custom Prompts** (for style and tone). +5. **Assign** your Context Group to relevant Projects. +6. Generate your translations or apply updates to existing translations. ## What are Context Groups? [#context-groups] -**Context Groups** define consistent instructions for translation. Each Context Group includes a Glossary and Custom Prompts: +**Context Groups** are reusable instructions for translation. Assign a group to one or more Projects to apply consistent terminology and voice across translations. *For example, the same Context Group can be applied across your app, website, documentation, and sales decks.* -a) **Glossary** defines **key terms**: product and brand names, features, and technical terms. *Example: Locadex is the GT agent. This product name should never be translated.* +a) The **Glossary** defines wording and how key terms should be handled: including product terms, brand names, features, and technical terms. *Example: Keep "Locadex" untranslated in every locale.* -b) **Custom Prompts** define **style and tone**: audience, formality, conventions, and formatting. *Example: Use active voice, avoid jargon, and use formal “Sie.”* +b) **Custom Prompts** define how translations should sound: including audience, formality, voice, conventions, and formatting. *Example: Use active voice, avoid jargon, and use formal "Sie."* -All Context Groups are stored at the Organization-wide level. They can then be applied to one or more Projects. +Context Groups live at the Organization level. We recommend applying a Context Group across all your Projects, and then adding additional project-specific Context Groups if surfaces differ in terminology or style. ## Using key terms in the Glossary [#using-key-terms] @@ -74,7 +72,7 @@ You can create a Context Group from your Organization page or from a specific Pr *Use the Organization-level flow when you want to create a shared group first, then assign it to one or more Projects.* -1. Open **Context** in the Organization sidebar. +1. Open **Context** in the **[Organization](https://dash.generaltranslation.com)** sidebar. 2. Click the plus sign and **Create new group**. 3. Enter a name and confirm. 4. Use the **Glossary** and **Custom Prompts** tabs to add relevant context. diff --git a/docs/en-US/platform/dashboard/guides/managing-billing.mdx b/docs/en-US/platform/dashboard/guides/managing-billing.mdx index f1ffa73cc..1d53c42fe 100644 --- a/docs/en-US/platform/dashboard/guides/managing-billing.mdx +++ b/docs/en-US/platform/dashboard/guides/managing-billing.mdx @@ -5,7 +5,7 @@ description: How to manage plans, usage-based pricing, prepaid credits, and auto related: links: - /docs/platform/dashboard/guides/reviewing-translations - - /docs/platform/dashboard/guides/adding-translation-context + - /docs/platform/dashboard/guides/defining-context-for-translations - /docs/platform/dashboard/guides/adding-annotations - /docs/platform/dashboard/guides/using-ask-ai diff --git a/docs/en-US/platform/dashboard/guides/meta.json b/docs/en-US/platform/dashboard/guides/meta.json index 8231bdec4..9352b5534 100644 --- a/docs/en-US/platform/dashboard/guides/meta.json +++ b/docs/en-US/platform/dashboard/guides/meta.json @@ -2,7 +2,7 @@ "title": "Guides", "description": "Browse how-to Guides for using the General Translation Dashboard.", "pages": [ - "./adding-translation-context", + "./defining-context-for-translations", "./reviewing-translations", "./adding-annotations", "./using-ask-ai", diff --git a/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx b/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx index 9144fa5e4..7a60542e4 100644 --- a/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx +++ b/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx @@ -4,7 +4,7 @@ title: Reviewing and editing translations description: How to review translations, make manual edits, and compare locales in the Dashboard. related: links: - - /docs/platform/dashboard/guides/adding-translation-context + - /docs/platform/dashboard/guides/defining-context-for-translations - /docs/platform/dashboard/guides/adding-annotations - /docs/platform/dashboard/guides/using-ask-ai - /docs/platform/dashboard/guides/managing-billing diff --git a/docs/en-US/platform/dashboard/guides/using-ask-ai.mdx b/docs/en-US/platform/dashboard/guides/using-ask-ai.mdx index eb17b7048..592c46e7a 100644 --- a/docs/en-US/platform/dashboard/guides/using-ask-ai.mdx +++ b/docs/en-US/platform/dashboard/guides/using-ask-ai.mdx @@ -5,7 +5,7 @@ description: How to use Ask AI to answer product questions, open cited docs, and related: links: - /docs/platform/dashboard/guides/reviewing-translations - - /docs/platform/dashboard/guides/adding-translation-context + - /docs/platform/dashboard/guides/defining-context-for-translations - /docs/platform/dashboard/guides/adding-annotations - /docs/platform/dashboard/guides/managing-billing