From b1e6ed89f80b51e3e78b728ca936b7ed5adb6cbd Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sun, 9 Aug 2026 04:34:03 +0000 Subject: [PATCH] docs: rename Directives to Custom Prompts Co-authored-by: Archie McKenzie --- DOCS-SKILL.md | 8 +++---- docs/en-US/overview/for-coding-agents.mdx | 2 +- docs/en-US/overview/key-concepts.mdx | 2 +- docs/en-US/platform/dashboard/get-started.mdx | 4 ++-- .../guides/adding-translation-context.mdx | 22 +++++++++---------- .../platform/dashboard/reference/api-keys.mdx | 2 +- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/DOCS-SKILL.md b/DOCS-SKILL.md index b17480407..cfb1a66d8 100644 --- a/DOCS-SKILL.md +++ b/DOCS-SKILL.md @@ -178,7 +178,7 @@ Use a bolded breadcrumb with `>`: **Project > Automations**, **Project > Context ### Product and term casing -Always capitalize these as product terms: **Dashboard**, **Locadex**, **Core**, **Google Drive**, **Project** (and **Projects**), **Context Group** (and **Context Groups**), **Glossary**, **Directive** (and **Directives**), and **Autoderive** (the CLI feature). Also capitalize the product scopes **Organization** and **Enterprise**, and **GitHub**. Lowercase "group" when they are not part of the proper term. +Always capitalize these as product terms: **Dashboard**, **Locadex**, **Core**, **Google Drive**, **Project** (and **Projects**), **Context Group** (and **Context Groups**), **Glossary**, **Custom Prompt** (and **Custom Prompts**), and **Autoderive** (the CLI feature). Also capitalize the product scopes **Organization** and **Enterprise**, and **GitHub**. Lowercase "group" when they are not part of the proper term. *Note: capitalize **Autoderive** only when referring to the feature in prose; the* `gt.config.json` *key stays lowercase in code as* `autoderive`*. Do not write "General Translation Autoderive" — the feature name stands on its own.* @@ -426,7 +426,7 @@ description: How to use labels, notes, and comments to coordinate translation re ``` - **Frontmatter is YAML, not plain prose.** Parse every touched page after bulk frontmatter edits. Quote or rewrite scalar values containing YAML-significant punctuation, especially a colon followed by a space (`: `), a leading special character, or an inline `#`; visual inspection and a successful Markdown render are not sufficient. -- `title`: **sentence case** — capitalize only the first word, except proper/product names (Dashboard, Locadex, Core, Organization, Project, Enterprise, Context Group, Glossary, Directives, GitHub). No trailing spaces. The docs layout renders this value as the page H1, so do not repeat it as a `#` heading in the body. +- `title`: **sentence case** — capitalize only the first word, except proper/product names (Dashboard, Locadex, Core, Organization, Project, Enterprise, Context Group, Glossary, Custom Prompts, GitHub). No trailing spaces. The docs layout renders this value as the page H1, so do not repeat it as a `#` heading in the body. - **React component reference titles use JSX syntax.** Quote the complete tag in frontmatter (`title: ""`) so the page title and sidebar display ``, not `T`. - `description`: no backticks, and **end with a period** (a question ends with `?` instead) — the description is used verbatim as the HTML meta description and in machine-readable indexes (`llms.txt`), where backticks render as literal characters. Refer to a component by its angle-bracket tag with no backticks (``, ``), not the bare word; where the same description appears in a `` body, escape the tag as `` so the MDX still parses. Name the relevant capability directly; do not add **General Translation** when the section, title, or feature name already makes ownership clear. If the product name is genuinely needed, spell out **General Translation**, never GT. Phrasing depends on page type: - **Guides** lead with **"How to…"** for SEO. Write **one concise sentence** that states what the reader will accomplish and names the relevant capability or tool without automatically branding it. Add enough scope to distinguish the description from the title, but **do not** restate the title, enumerate every subsection, or append a `: this guide covers …` checklist. For a guide that explains a concept rather than a task, use a question instead. *Examples:* "How to upload, translate, and download files with the generaltranslation library." / "How to review translations, make manual edits, and compare locales in the Dashboard." / "What are locale codes, and how are they used across the translation stack?" @@ -531,7 +531,7 @@ Anatomy: 1. Open your Organization in the Dashboard. 2. Go to the **Context** page. 3. Create a **Context Group**. -4. Add a **Glossary** (for terminology) and/or **Directives** (for style and tone). +4. Add a **Glossary** (for terminology) and/or **Custom Prompts** (for style and tone). 5. **Assign** your Context Group to relevant Project(s). 6. Generate translations or apply updates to existing translations. ``` @@ -813,7 +813,7 @@ CI validates every `meta.json`: entries must resolve, every navigable child must - Navigation separators use `>`, not `->`. - `.md` link suffix usage is consistent within the file. - Notes and tips use the established format for their page type and are consistent across sibling pages. -- Product/term casing matches the canonical list (Dashboard, Locadex, Core, Google Drive, Project, Context Group, Glossary, Directives, Organization, Enterprise, GitHub). +- Product/term casing matches the canonical list (Dashboard, Locadex, Core, Google Drive, Project, Context Group, Glossary, Custom Prompts, Organization, Enterprise, GitHub). - Reference descriptions end with a second sentence: `API reference for X.` for API/library pages, or `Reference for X.` for non-API reference pages (ending with a period). - No broken internal links (verify the target file exists). - `related.links` follow the page-type rule: quickstart/entry pages point to four of that section's guides (or all if the section has fewer than four); guide pages link **all** the section's other guides, trimming to the four most relevant only when there are more than four others; neither links reference pages or quickstarts (the guide-less OpenAPI section is the only exception). diff --git a/docs/en-US/overview/for-coding-agents.mdx b/docs/en-US/overview/for-coding-agents.mdx index ca564ab31..c188e1a9e 100644 --- a/docs/en-US/overview/for-coding-agents.mdx +++ b/docs/en-US/overview/for-coding-agents.mdx @@ -238,5 +238,5 @@ Most setup is the same across agents; these are the few places the guidance diff Agents are reliable for mechanical i18n work, but translation quality and configuration still need a human. Use this split: - **Hand to the agent:** wrapping user-facing copy in [``](/docs/react/reference/components/t), adding [`useGT()`](/docs/react/reference/hooks/use-gt) for standalone strings, scaffolding `gt.config.json`, and running [`npx gt init`](/docs/cli/reference/commands/init). -- **Verify by hand:** the [translation context](/docs/overview/key-concepts#context) (Glossary and Directives) the agent writes, the locale configuration (`defaultLocale` and `locales`), and that dynamic or private values are wrapped in [``](/docs/react/reference/components/var). +- **Verify by hand:** the [translation context](/docs/overview/key-concepts#context) (Glossary and Custom Prompts) the agent writes, the locale configuration (`defaultLocale` and `locales`), and that dynamic or private values are wrapped in [``](/docs/react/reference/components/var). - **Never let the agent do:** hand-editing generated translation files, or hardcoding already-translated strings instead of translating source copy with the CLI. diff --git a/docs/en-US/overview/key-concepts.mdx b/docs/en-US/overview/key-concepts.mdx index 836425ee0..8e45b33f4 100644 --- a/docs/en-US/overview/key-concepts.mdx +++ b/docs/en-US/overview/key-concepts.mdx @@ -81,7 +81,7 @@ Context helps General Translation: General Translation applies context through **Context Groups**, which combine two parts: - **Glossary** defines key terms: product names, feature names, and technical terms that need consistent treatment. -- **Directives** define style and tone: audience, formality, conventions, and formatting. +- **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. diff --git a/docs/en-US/platform/dashboard/get-started.mdx b/docs/en-US/platform/dashboard/get-started.mdx index a9e72f864..466e02071 100644 --- a/docs/en-US/platform/dashboard/get-started.mdx +++ b/docs/en-US/platform/dashboard/get-started.mdx @@ -57,9 +57,9 @@ 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 Directives 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 [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 Directives, 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 [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 [Define translation context](/docs/platform/dashboard/guides/adding-translation-context). diff --git a/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx b/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx index 08993578e..fdc5c15ce 100644 --- a/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx +++ b/docs/en-US/platform/dashboard/guides/adding-translation-context.mdx @@ -1,7 +1,7 @@ --- title: Adding translation context -description: How to use Context Groups, Glossary, and Directives to guide AI translations. +description: How to use Context Groups, Glossary, and Custom Prompts to guide AI translations. related: links: - /docs/platform/dashboard/guides/reviewing-translations @@ -20,7 +20,7 @@ General Translation applies reusable translation instructions through Context Gr 1. Open your Organization in the Dashboard. 2. Go to the **Context** page. 3. Create a **Context Group**. -4. Add a **Glossary** (for terminology) and/or **Directives** (for style and tone). +4. Add a **Glossary** (for terminology) and/or **Custom Prompts** (for style and tone). 5. **Assign** your Context Group to relevant Project(s). 6. Generate translations or apply updates to existing translations. @@ -28,11 +28,11 @@ General Translation applies reusable translation instructions through Context Gr ## What are Context Groups? [#context-groups] -**Context Groups** define consistent instructions for translation. Each Context Group includes a Glossary and Directives: +**Context Groups** define consistent instructions for translation. Each Context Group includes a Glossary and Custom Prompts: 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.* -b) **Directives** define **style and tone**: audience, formality, conventions, and formatting. *Example: Use active voice, avoid jargon, and use formal “Sie.”* +b) **Custom Prompts** define **style and tone**: audience, formality, 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. @@ -50,9 +50,9 @@ Add terms to the Context Group that should own them. If the same term appears in Use **Search terms** to find an existing Glossary entry. -## Using style and tone in Directives [#using-style-tone] +## Using style and tone in Custom Prompts [#using-style-tone] -Use Directives for translation instructions that are broader than a single term. Directives are useful for: +Use Custom Prompts for translation instructions that are broader than a single term. Custom Prompts are useful for: - Style and tone - Target audience @@ -60,9 +60,9 @@ Use Directives for translation instructions that are broader than a single term. - Locale-specific style rules - Product or domain-specific instructions -Directives can be global or locale-specific. Use locale-specific directives when guidance should apply only to one target language or region. +Custom Prompts can be global or locale-specific. Use locale-specific Custom Prompts when guidance should apply only to one target language or region. -Use **Search directives** to filter the current Context Group. +Use **Search custom prompts** to filter the current Context Group. ## How to create and assign a Context Group [#create-assign-context] @@ -77,7 +77,7 @@ You can create a Context Group from your Organization page or from a specific Pr 1. Open **Context** in the Organization sidebar. 2. Click the plus sign and **Create new group**. 3. Enter a name and confirm. -4. Add relevant **Glossary** terms and **Directives**. +4. Add relevant **Glossary** terms and **Custom Prompts**. 5. Open each relevant Project. 6. Assign the group from the Project's **Context** tab. 7. Use the **Translate** button to use AI to generate translations for Glossary terms for each target locale. @@ -91,7 +91,7 @@ Context Groups are applied every time AI generates translations, including Locad 1. Open **Context** in the Project sidebar. 2. Click the plus sign and **Create new group**. 3. Enter a name and confirm. Select the checkbox to **Autogenerate context** from your Project files. -4. Add relevant **Glossary** terms and **Directives**. +4. Add relevant **Glossary** terms and **Custom Prompts**. 5. Use the **Translate** button to use AI to generate translations for Glossary terms for each target locale. When you create a Context Group from a Project, it is still created at the Organization level. GT automatically assigns it to the current Project. @@ -102,7 +102,7 @@ When you create a Context Group from a Project, it is still created at the Organ In most cases, you should directly assign or reassign Projects to Context Groups. -However, for major changes, you can also use **Export** to download a group's Glossary and Directives. Then use **Import** to fill an empty Glossary and Directives from a supported file. +However, for major changes, you can also use **Export** to download a group's Glossary and Custom Prompts. Then use **Import** to fill an empty Glossary and Custom Prompts from a supported file. ## Set priority when groups overlap [#priority] diff --git a/docs/en-US/platform/dashboard/reference/api-keys.mdx b/docs/en-US/platform/dashboard/reference/api-keys.mdx index 1fc08be72..7acf75f22 100644 --- a/docs/en-US/platform/dashboard/reference/api-keys.mdx +++ b/docs/en-US/platform/dashboard/reference/api-keys.mdx @@ -26,7 +26,7 @@ Permissions are configured per resource. `Write` includes `Read`. | ----------------------- | ------------------------------------- | ----------------------------------------------------- | | **Project creation** | Not applicable | Create new Projects in the Organization | | **Files** | Read Project files and translations | Upload source content and write translated files | -| **Context** | Read Project and Organization context | Manage context groups, glossary, and directives | +| **Context** | Read Project and Organization context | Manage context groups, glossary, and custom prompts | | **Runtime translation** | Not applicable | Translate content on demand | | **Translation queue** | Not applicable | Queue file translation jobs for background processing | | **Project settings** | Not applicable | Update Project settings such as the default locale and CDN delivery |