diff --git a/DOCS-SKILL.md b/DOCS-SKILL.md index 2eae1247e..82791c196 100644 --- a/DOCS-SKILL.md +++ b/DOCS-SKILL.md @@ -407,7 +407,7 @@ A few optional fields appear on specific page types: ## Page structure 1. **Frontmatter title:** the docs layout renders the `title` as the page H1. Do not add a `#` heading to the body. -2. **Intro:** 1–3 short sentences with no heading, stating what the page is and when to use it. Optionally one more italicized short line for constraints or scope. +2. **Intro:** 1–3 short sentences with no heading that add substance beyond the `description`: behavior, inputs, or when to use it. The docs layout already renders the `description` beneath the title, so the intro must not restate or paraphrase it. On reference pages especially, do not open with the description's summary sentence. Optionally one more italicized short line for constraints or scope. 3. **Sections:** use `##` for top-level body sections. @@ -695,6 +695,7 @@ These patterns are **blocked by CI** and will fail the build, so never use them ## Consistency checks before finishing - The page reflects real system behavior (verified against code and existing docs), not just restated formatting. +- The intro does not restate the frontmatter `description` (the layout renders the description under the title); the body opens with new detail. - Depth and vocabulary match the page audience. - Sections are grouped into a few meaningful H2s with H3 subsections, not many small one-off H2s. Consolidate or restructure if there are more than 6 H2 subsections. - First mention of the product on the page (and in the description) uses **General Translation**, not GT. diff --git a/docs/en-US/cli/guides/branching.mdx b/docs/en-US/cli/guides/branching.mdx index 95fa49b3c..9cebff4a1 100644 --- a/docs/en-US/cli/guides/branching.mdx +++ b/docs/en-US/cli/guides/branching.mdx @@ -11,7 +11,7 @@ related: --- -Branching tracks translations separately for each git branch. Use it when a feature branch adds or changes content and you want those translations isolated from production until the branch merges. +Use branching when a feature branch adds or changes content and you want those translations isolated from production until the branch merges. *Note: Branching is a General Translation Cloud feature and requires a paid plan. Without one, creating a non-default branch falls back to the default branch.* diff --git a/docs/en-US/cli/reference/commands/init.mdx b/docs/en-US/cli/reference/commands/init.mdx index f33dcc9e4..88d5614c5 100644 --- a/docs/en-US/cli/reference/commands/init.mdx +++ b/docs/en-US/cli/reference/commands/init.mdx @@ -5,9 +5,9 @@ description: Run the General Translation setup wizard to configure a project. AP --- -Runs the setup wizard that prepares a project for General Translation. This is the default command — running `npx gt` with no command runs `init`. +`init` is the default command: running `npx gt` with no command runs it. -The wizard detects your framework and, depending on the project, installs dependencies, configures your framework, creates a `gt.config.json`, and generates credentials. For a step-by-step walkthrough, see [Configuring the CLI](/docs/cli/guides/configuring). +The setup wizard detects your framework and, depending on the project, installs dependencies, configures your framework, creates a `gt.config.json`, and generates credentials. For a step-by-step walkthrough, see [Configuring the CLI](/docs/cli/guides/configuring). ```bash npx gt init diff --git a/docs/en-US/cli/reference/formats/plain-text-files.mdx b/docs/en-US/cli/reference/formats/plain-text-files.mdx index e26bf0f9b..50f161246 100644 --- a/docs/en-US/cli/reference/formats/plain-text-files.mdx +++ b/docs/en-US/cli/reference/formats/plain-text-files.mdx @@ -5,7 +5,7 @@ description: Translate plain text files with the General Translation CLI. API re --- -The CLI translates arbitrary plain text (`txt`) files. +The entire `txt` file is treated as translatable content, so no markup or structure is preserved or skipped. ## Configuration [#config] diff --git a/docs/en-US/cli/reference/keyed-metadata.mdx b/docs/en-US/cli/reference/keyed-metadata.mdx index e674a0314..7b8b182ca 100644 --- a/docs/en-US/cli/reference/keyed-metadata.mdx +++ b/docs/en-US/cli/reference/keyed-metadata.mdx @@ -5,7 +5,7 @@ description: Attach per-key translation instructions to General Translation JSON --- -Keyed metadata attaches translation instructions to individual keys in your JSON and YAML files. You provide a companion metadata file that mirrors the source file's key structure, with a metadata object at each leaf. +You provide a companion metadata file that mirrors the source file's key structure, with a metadata object at each leaf. Each object holds instructions for translating that one key. The CLI detects companion metadata files automatically, validates them against the source structure, and sends them to the translation engine. diff --git a/docs/en-US/integrations/mintlify/guides/managing-translations.mdx b/docs/en-US/integrations/mintlify/guides/managing-translations.mdx index ca42e0f53..e5fb34745 100644 --- a/docs/en-US/integrations/mintlify/guides/managing-translations.mdx +++ b/docs/en-US/integrations/mintlify/guides/managing-translations.mdx @@ -10,7 +10,7 @@ related: --- -After your Mintlify docs are set up, use this guide to add or remove languages, keep translations current as your content changes, and edit generated translations. +After your Mintlify docs are set up and translating, use this guide to keep them current as your content and language needs change. ## Keep translations up to date [#continuous] diff --git a/docs/en-US/integrations/sanity/reference/plugin-configuration.mdx b/docs/en-US/integrations/sanity/reference/plugin-configuration.mdx index 4642cc5c6..872e154e2 100644 --- a/docs/en-US/integrations/sanity/reference/plugin-configuration.mdx +++ b/docs/en-US/integrations/sanity/reference/plugin-configuration.mdx @@ -5,7 +5,7 @@ description: Configure the General Translation gt-sanity plugin for Sanity Studi --- -Configure General Translation in Sanity Studio with the `gtPlugin` function. Pass a single options object. +Register General Translation in your Sanity config with the `gtPlugin` function. Pass it a single options object. ```ts title="sanity.config.ts" import { gtPlugin } from 'gt-sanity'; diff --git a/docs/en-US/integrations/storyblok/reference/connection.mdx b/docs/en-US/integrations/storyblok/reference/connection.mdx index c070bf5cf..3572f6673 100644 --- a/docs/en-US/integrations/storyblok/reference/connection.mdx +++ b/docs/en-US/integrations/storyblok/reference/connection.mdx @@ -5,7 +5,7 @@ description: Reference for the settings used to connect a Storyblok space to Gen --- -The settings used to connect a Storyblok space to General Translation. You provide them once in the **Connect** dialog at **Project > Integrations**; General Translation stores them on the Project and uses them to call the Storyblok Management API. +You provide the connection settings once in the **Connect** dialog at **Project > Integrations**; General Translation stores them on the Project and uses them to call the Storyblok Management API. ## Overview [#overview] diff --git a/docs/en-US/integrations/storyblok/reference/supported-content.mdx b/docs/en-US/integrations/storyblok/reference/supported-content.mdx index 7486ddb96..0d8846a7c 100644 --- a/docs/en-US/integrations/storyblok/reference/supported-content.mdx +++ b/docs/en-US/integrations/storyblok/reference/supported-content.mdx @@ -5,7 +5,7 @@ description: Reference for the Storyblok field types General Translation transla --- -Which Storyblok field types General Translation translates, how it handles rich text and tables, and the data format it uses. General Translation walks each story's content tree, recurses into nested blocks, and extracts translatable fields. +General Translation walks each story's content tree, recurses into nested blocks, and extracts translatable fields. ## Overview [#overview] diff --git a/docs/en-US/node/reference/functions/declare-var.mdx b/docs/en-US/node/reference/functions/declare-var.mdx index e696fb073..649dbaced 100644 --- a/docs/en-US/node/reference/functions/declare-var.mdx +++ b/docs/en-US/node/reference/functions/declare-var.mdx @@ -5,7 +5,7 @@ description: Mark a value as non-derivable within a General Translation derive c --- -Marks a value as non-derivable — content that cannot be statically analyzed by the General Translation compiler. Use `declareVar` inside a [`derive`](/docs/node/reference/functions/derive) call to isolate the part of an expression that must be treated as a runtime variable. +A non-derivable value is one the General Translation compiler cannot statically analyze. Use `declareVar` inside a [`derive`](/docs/node/reference/functions/derive) call to isolate the part of an expression that must be treated as a runtime variable. ## Overview [#overview] diff --git a/docs/en-US/node/reference/functions/derive.mdx b/docs/en-US/node/reference/functions/derive.mdx index 474749d81..5f3a059fa 100644 --- a/docs/en-US/node/reference/functions/derive.mdx +++ b/docs/en-US/node/reference/functions/derive.mdx @@ -5,7 +5,7 @@ description: Mark computed content as derivable for General Translation extracti --- -Marks content that is computed from source code as derivable by the General Translation compiler and CLI. Use `derive` when a translated string interpolates a value that should be discovered during extraction rather than treated as a runtime variable. +Derivable content is computed in source code but resolves to a fixed set of values the CLI can translate. Use `derive` when a translated string interpolates a value that should be discovered during extraction rather than treated as a runtime variable. ## Overview [#overview] diff --git a/docs/en-US/node/reference/functions/get-locale.mdx b/docs/en-US/node/reference/functions/get-locale.mdx index cc4fcd911..b9294045f 100644 --- a/docs/en-US/node/reference/functions/get-locale.mdx +++ b/docs/en-US/node/reference/functions/get-locale.mdx @@ -5,7 +5,7 @@ description: Read the active locale for the current request in General Translati --- -Returns the current locale for the active request context. Call it inside a [`withGT`](/docs/node/reference/functions/with-gt) scope to read the locale bound for the request. +Returns the active locale as a BCP 47 code. Call it inside a [`withGT`](/docs/node/reference/functions/with-gt) scope to read the locale bound for the request. ## Overview [#overview] diff --git a/docs/en-US/node/reference/functions/get-locales.mdx b/docs/en-US/node/reference/functions/get-locales.mdx index 6d418d9d2..6a496d40b 100644 --- a/docs/en-US/node/reference/functions/get-locales.mdx +++ b/docs/en-US/node/reference/functions/get-locales.mdx @@ -5,7 +5,7 @@ description: List the supported locales configured in General Translation gt-nod --- -Returns the list of supported locales configured in [`initializeGT`](/docs/node/reference/functions/initialize-gt). +Returns the array of supported BCP 47 locale codes you set in [`initializeGT`](/docs/node/reference/functions/initialize-gt). ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-currency.mdx b/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-currency.mdx index 2b970aef3..9b3719be6 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-currency.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-currency.mdx @@ -5,7 +5,7 @@ description: Format a currency value by locale on a GT instance. API reference f --- -Formats a numeric value as a localized currency string on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. General Translation uses the built-in `Intl.NumberFormat` API with the currency style, so amounts render with the correct symbol, grouping, and decimal conventions for each locale. +General Translation uses the built-in `Intl.NumberFormat` API with the currency style, so amounts render with the correct symbol, grouping, and decimal conventions for each locale. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-list.mdx b/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-list.mdx index 18e9cc238..cc5710cd0 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-list.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/formatting/format-list.mdx @@ -5,7 +5,7 @@ description: Format an array into a locale-aware list string on a GT instance. A --- -Formats an array into a single locale-aware list string on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. General Translation uses the built-in `Intl.ListFormat` API to join items with the correct separators and conjunction ("and") or disjunction ("or") wording for each locale. +General Translation uses the built-in `Intl.ListFormat` API to join items with the correct separators and conjunction ("and") or disjunction ("or") wording for each locale. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/locales/determine-locale.mdx b/docs/en-US/platform/core/reference/gt-class-methods/locales/determine-locale.mdx index 990e567e3..1eec6fd4c 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/locales/determine-locale.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/locales/determine-locale.mdx @@ -5,7 +5,7 @@ description: Find the best matching locale from a list of approved locales. API --- -Determines the best matching locale from a list of approved locales based on user preferences, on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. General Translation implements locale negotiation to find the most suitable locale when an exact match is not available. +General Translation implements locale negotiation to find the most suitable locale when an exact match is not available. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/locales/get-locale-direction.mdx b/docs/en-US/platform/core/reference/gt-class-methods/locales/get-locale-direction.mdx index f4ce9e85e..4dcac42ac 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/locales/get-locale-direction.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/locales/get-locale-direction.mdx @@ -5,7 +5,7 @@ description: Return the text direction for a locale. API reference for getLocale --- -Determines the text direction of a locale on a [GT](/docs/platform/core/reference/gt-class/constructor) instance, using the `Intl.Locale` API. General Translation returns `'ltr'` for left-to-right languages or `'rtl'` for right-to-left languages. +General Translation returns `'ltr'` for left-to-right languages or `'rtl'` for right-to-left languages. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/locales/is-same-dialect.mdx b/docs/en-US/platform/core/reference/gt-class-methods/locales/is-same-dialect.mdx index 7548b8aac..0ebcd25ae 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/locales/is-same-dialect.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/locales/is-same-dialect.mdx @@ -5,7 +5,7 @@ description: Check whether two locales represent the same dialect. API reference --- -Checks whether multiple BCP-47 locale codes represent the same dialect on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. General Translation compares the language and region components of locale codes to determine whether they represent the same linguistic variety. +General Translation compares the language and region components of locale codes to determine whether they represent the same linguistic variety. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-alias-locale.mdx b/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-alias-locale.mdx index 7e3e974b7..b139f6ca3 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-alias-locale.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-alias-locale.mdx @@ -5,7 +5,7 @@ description: Resolve a locale alias to the locale code used by a custom mapping. --- -Resolves a canonical locale code back to its original alias locale code when a custom mapping is configured, on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. This is the inverse of [`resolveCanonicalLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale). General Translation uses aliases so you can expose your own locale codes while mapping them to standard BCP-47 codes internally. +Returns the alias code you exposed for a canonical locale, when a custom mapping is configured, on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. This is the inverse of [`resolveCanonicalLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale). General Translation uses aliases so you can expose your own locale codes while mapping them to standard BCP-47 codes internally. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale.mdx b/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale.mdx index 0fc8174f5..5c3dfa617 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale.mdx @@ -5,7 +5,7 @@ description: Resolve a locale alias to its canonical locale code on a GT instanc --- -Resolves a locale alias to the canonical BCP-47 locale code used internally, on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. This is the inverse of [`resolveAliasLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale). General Translation uses a custom mapping so you can expose your own locale codes while translating and formatting against standard codes internally. +Returns the canonical BCP-47 code that General Translation uses internally for a locale alias, on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. This is the inverse of [`resolveAliasLocale`](/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale). General Translation uses a custom mapping so you can expose your own locale codes while translating and formatting against standard codes internally. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/translation/check-job-status.mdx b/docs/en-US/platform/core/reference/gt-class-methods/translation/check-job-status.mdx index c8819b177..4ce436822 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/translation/check-job-status.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/translation/check-job-status.mdx @@ -5,7 +5,7 @@ description: Check the current status of a translation or setup job. API referen --- -Checks the current status of one or more General Translation jobs by their identifiers. Use it to monitor the asynchronous operations started by [`setupProject`](/docs/platform/core/reference/gt-class-methods/translation/setup-project) or [`enqueueFiles`](/docs/platform/core/reference/gt-class-methods/translation/enqueue-files). +Monitor the asynchronous operations started by [`setupProject`](/docs/platform/core/reference/gt-class-methods/translation/setup-project) or [`enqueueFiles`](/docs/platform/core/reference/gt-class-methods/translation/enqueue-files) by polling their job status. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/translation/download-file-batch.mdx b/docs/en-US/platform/core/reference/gt-class-methods/translation/download-file-batch.mdx index 9a27588c1..7b7d10385 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/translation/download-file-batch.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/translation/download-file-batch.mdx @@ -5,7 +5,7 @@ description: Download multiple translated files in one request. API reference fo --- -Downloads multiple source or translation files in a single batch request with General Translation. Use it instead of many individual [`downloadFile`](/docs/platform/core/reference/gt-class-methods/translation/download-file) calls to reduce network overhead. +Fetch several source or translation files in one request instead of making many individual [`downloadFile`](/docs/platform/core/reference/gt-class-methods/translation/download-file) calls, which reduces network overhead. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class-methods/translation/translate.mdx b/docs/en-US/platform/core/reference/gt-class-methods/translation/translate.mdx index e566531e7..86e8e2471 100644 --- a/docs/en-US/platform/core/reference/gt-class-methods/translation/translate.mdx +++ b/docs/en-US/platform/core/reference/gt-class-methods/translation/translate.mdx @@ -5,7 +5,7 @@ description: Translate one string or structured content entry into a target loca --- -Translates a single string or structured content entry from a source locale into a target locale. This is the primary translation method on a [GT](/docs/platform/core/reference/gt-class/constructor) instance. +`translate` is the primary translation method on a [GT](/docs/platform/core/reference/gt-class/constructor) instance, for translating one string or structured content entry at a time. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/gt-class/set-config.mdx b/docs/en-US/platform/core/reference/gt-class/set-config.mdx index ce01b7847..4afe40de7 100644 --- a/docs/en-US/platform/core/reference/gt-class/set-config.mdx +++ b/docs/en-US/platform/core/reference/gt-class/set-config.mdx @@ -5,7 +5,7 @@ description: Update configuration on an existing GT instance. API reference for --- -Updates the configuration of an existing [GT](/docs/platform/core/reference/gt-class/constructor) instance. Use it to change API credentials, locales, and other settings after the instance was created with General Translation. +Change the API credentials, locales, and other settings of a [GT](/docs/platform/core/reference/gt-class/constructor) instance after it was created, without constructing a new one. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/types/gt-constructor-params.mdx b/docs/en-US/platform/core/reference/types/gt-constructor-params.mdx index ec13a8828..08b6a1bdd 100644 --- a/docs/en-US/platform/core/reference/types/gt-constructor-params.mdx +++ b/docs/en-US/platform/core/reference/types/gt-constructor-params.mdx @@ -5,7 +5,7 @@ description: Configuration options accepted by the GT constructor. API reference --- -`GTConstructorParams` defines the configuration options accepted by the General Translation [Constructor](/docs/platform/core/reference/gt-class/constructor) when initializing a [`GT`](/docs/platform/core/reference/gt-class/constructor) instance. +`GTConstructorParams` is the object passed to the General Translation [constructor](/docs/platform/core/reference/gt-class/constructor) to configure a [`GT`](/docs/platform/core/reference/gt-class/constructor) instance's API credentials, locales, and endpoints. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/types/jsx-element.mdx b/docs/en-US/platform/core/reference/types/jsx-element.mdx index 64a7ada36..f4977d927 100644 --- a/docs/en-US/platform/core/reference/types/jsx-element.mdx +++ b/docs/en-US/platform/core/reference/types/jsx-element.mdx @@ -5,7 +5,7 @@ description: Structured JSX-like element used in translatable content. API refer --- -`JsxElement` represents a structured, HTML-like element inside translatable [`JsxChildren`](/docs/platform/core/reference/types/jsx-children) content. It captures an element's tag, identifier, GT properties, and child content in a compact, serializable form. +`JsxElement` lets General Translation preserve an element's structure inside translatable [`JsxChildren`](/docs/platform/core/reference/types/jsx-children) content. It captures an element's tag, identifier, GT properties, and child content in a compact, serializable form. ## Overview [#overview] diff --git a/docs/en-US/platform/core/reference/types/variable.mdx b/docs/en-US/platform/core/reference/types/variable.mdx index 848e3fe9e..0abed5507 100644 --- a/docs/en-US/platform/core/reference/types/variable.mdx +++ b/docs/en-US/platform/core/reference/types/variable.mdx @@ -5,7 +5,7 @@ description: Placeholder for dynamic content in translatable messages. API refer --- -`Variable` represents a placeholder for dynamic content inside translatable [`JsxChildren`](/docs/platform/core/reference/types/jsx-children) content. Each variable has a key and an optional formatting type so General Translation can substitute and format runtime values. +`Variable` carries a key and an optional formatting type, so General Translation can substitute and format runtime values inside translatable [`JsxChildren`](/docs/platform/core/reference/types/jsx-children) content. ## Overview [#overview] diff --git a/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx b/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx index 299722d15..dd421eff3 100644 --- a/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx +++ b/docs/en-US/platform/dashboard/guides/reviewing-translations.mdx @@ -10,8 +10,6 @@ related: --- -Use the Dashboard to review translations and make manual edits. - ## Basic review workflow [#basic-review-workflow] 1. Open your Project in the Dashboard. diff --git a/docs/en-US/platform/dashboard/reference/project-settings.mdx b/docs/en-US/platform/dashboard/reference/project-settings.mdx index 72afef8d8..189bf349d 100644 --- a/docs/en-US/platform/dashboard/reference/project-settings.mdx +++ b/docs/en-US/platform/dashboard/reference/project-settings.mdx @@ -3,7 +3,7 @@ title: "Project settings" description: "Project settings control how an individual Project appears and how its translations are delivered." --- -Project settings control how an individual Project appears and how its translations are delivered. +Each Project in the Dashboard has its own settings, separate from Organization-wide settings. Use them to rename the Project, change its source locale, enable CDN delivery or AI Context, copy the Project ID, and delete the Project. ## General settings [#general-settings] diff --git a/docs/en-US/platform/dashboard/reference/supported-locales.mdx b/docs/en-US/platform/dashboard/reference/supported-locales.mdx index 1f452236e..c7ac71d3e 100644 --- a/docs/en-US/platform/dashboard/reference/supported-locales.mdx +++ b/docs/en-US/platform/dashboard/reference/supported-locales.mdx @@ -5,7 +5,7 @@ description: Search the locales supported by the General Translation platform. --- -A list of the 110+ locales currently supported by General Translation. A machine-readable list is available at [`/locales.json`](/locales.json). +For programmatic use, the full list of 110+ supported locales is served at [`/locales.json`](/locales.json). ## Search locales [#search-locales] diff --git a/docs/en-US/platform/index.mdx b/docs/en-US/platform/index.mdx index 4e73b1f74..f21140e4f 100644 --- a/docs/en-US/platform/index.mdx +++ b/docs/en-US/platform/index.mdx @@ -5,7 +5,7 @@ description: Browse docs for the General Translation Platform, including the Das --- -Browse docs for the General Translation Platform. +These sections cover the Dashboard, the core `generaltranslation` library, Locadex, and the HTTP API. diff --git a/docs/en-US/platform/locadex/reference/agent.mdx b/docs/en-US/platform/locadex/reference/agent.mdx index 85a4c265a..5881e8d9f 100644 --- a/docs/en-US/platform/locadex/reference/agent.mdx +++ b/docs/en-US/platform/locadex/reference/agent.mdx @@ -5,9 +5,7 @@ description: Reference for the Locadex Agent page, repository status, languages, --- -The Agent page is the main status page for Locadex. - -Open it from **Locadex > Agent** in the Project sidebar. +Open the Agent page from **Locadex > Agent** in the Project sidebar. ## Repository [#repository] diff --git a/docs/en-US/platform/locadex/reference/vm-image.mdx b/docs/en-US/platform/locadex/reference/vm-image.mdx index 84687ae4f..8c05ac0b8 100644 --- a/docs/en-US/platform/locadex/reference/vm-image.mdx +++ b/docs/en-US/platform/locadex/reference/vm-image.mdx @@ -5,9 +5,7 @@ description: Reference for the sandbox environment Locadex uses to run workflows --- -Locadex runs workflows in a sandboxed environment. - -The sandbox installs dependencies, runs configured commands, updates files, and prepares pull request changes. +The sandbox environment where Locadex runs each workflow installs dependencies, runs configured commands, updates files, and prepares pull request changes. ## Environment variables [#environment-variables] diff --git a/docs/en-US/platform/openapi/reference/context/context-status.mdx b/docs/en-US/platform/openapi/reference/context/context-status.mdx index 2c6480d03..4dbc882db 100644 --- a/docs/en-US/platform/openapi/reference/context/context-status.mdx +++ b/docs/en-US/platform/openapi/reference/context/context-status.mdx @@ -6,7 +6,7 @@ description: Track the status of a General Translation context generation job. A method: GET --- -Returns the status of a context generation job started by [Generate translation context](/docs/platform/openapi/reference/context/generate-context). +Look up a context generation job created by [Generate translation context](/docs/platform/openapi/reference/context/generate-context) to check its progress. *Note: this endpoint is retained for backward compatibility. For new integrations, use [Get translation job status](/docs/platform/openapi/reference/translation/job-status), which reports status for any queued job.* diff --git a/docs/en-US/platform/openapi/reference/files/upload-source.mdx b/docs/en-US/platform/openapi/reference/files/upload-source.mdx index 37a2eadca..b9692f554 100644 --- a/docs/en-US/platform/openapi/reference/files/upload-source.mdx +++ b/docs/en-US/platform/openapi/reference/files/upload-source.mdx @@ -6,7 +6,7 @@ description: Upload one or more source files to a General Translation Project be method: POST --- -Uploads source files to a Project so they can be queued for translation. Send file content as base64, one to 100 files per request. +Send one to 100 source files per request, with each file's content base64-encoded, to add them to a Project for translation. ## Overview [#overview] diff --git a/docs/en-US/python/reference/classes/storage-adapter.mdx b/docs/en-US/python/reference/classes/storage-adapter.mdx index 335701cfb..de7b211ac 100644 --- a/docs/en-US/python/reference/classes/storage-adapter.mdx +++ b/docs/en-US/python/reference/classes/storage-adapter.mdx @@ -5,7 +5,7 @@ description: Abstract base class for per-request locale storage in General Trans --- -The abstract base class for adapters that store and read the per-request locale. Subclass it to control where the current locale lives (for example, a framework's request context). The default implementation is [`ContextVarStorageAdapter`](/docs/python/reference/classes/context-var-storage-adapter). +Subclass `StorageAdapter` to control where the current locale lives (for example, a framework's request context). The default implementation is [`ContextVarStorageAdapter`](/docs/python/reference/classes/context-var-storage-adapter). ## Overview [#overview] diff --git a/docs/en-US/python/reference/classes/translations-loader.mdx b/docs/en-US/python/reference/classes/translations-loader.mdx index b1e6571c6..55c5f024e 100644 --- a/docs/en-US/python/reference/classes/translations-loader.mdx +++ b/docs/en-US/python/reference/classes/translations-loader.mdx @@ -5,7 +5,7 @@ description: The callable type for custom translation loaders in General Transla --- -The type of a custom translation loader — the callback you pass as `load_translations` to bring your own translations. It maps a locale code to a translations dict. +`TranslationsLoader` is the type of the callback you pass as `load_translations` to bring your own translations. It maps a locale code to a translations dict. *Note: `TranslationsLoader` is a **type alias**, not a class, protocol, or ABC. You do not subclass it; you provide any callable that matches its shape.* diff --git a/docs/en-US/python/reference/functions/declare-var.mdx b/docs/en-US/python/reference/functions/declare-var.mdx index d1825aab3..01850a1dc 100644 --- a/docs/en-US/python/reference/functions/declare-var.mdx +++ b/docs/en-US/python/reference/functions/declare-var.mdx @@ -5,7 +5,7 @@ description: Mark a dynamic value as a non-translatable variable in General Tran --- -Marks a dynamic value as a non-translatable variable so it is preserved across languages. Use it for values known only at runtime, such as user names, emails, and counts, embedded inside a [`t`](/docs/python/reference/functions/t) call. +A non-translatable variable is a dynamic value that stays unchanged across languages. Use `declare_var` for values known only at runtime, such as user names, emails, and counts, embedded inside a [`t`](/docs/python/reference/functions/t) call. ## Overview [#overview] diff --git a/docs/en-US/python/reference/functions/extract-variables.mdx b/docs/en-US/python/reference/functions/extract-variables.mdx index dd8a7ae32..5e0fe9fee 100644 --- a/docs/en-US/python/reference/functions/extract-variables.mdx +++ b/docs/en-US/python/reference/functions/extract-variables.mdx @@ -5,7 +5,7 @@ description: Filter reserved GT keys from an options dict to get user variables --- -Returns only the user interpolation variables from an options dict, removing the reserved General Translation keys. It is the helper [`t`](/docs/python/reference/functions/t), [`msg`](/docs/python/reference/functions/msg), and [`interpolate_message`](/docs/python/reference/functions/interpolate-message) use to separate variables from options. +Returns a new dict with only the user interpolation variables, dropping reserved General Translation keys such as `_context`. It is the helper [`t`](/docs/python/reference/functions/t), [`msg`](/docs/python/reference/functions/msg), and [`interpolate_message`](/docs/python/reference/functions/interpolate-message) use to separate variables from options. ## Overview [#overview] diff --git a/docs/en-US/python/reference/functions/hash-message.mdx b/docs/en-US/python/reference/functions/hash-message.mdx index 11ae2ba35..727acb7f6 100644 --- a/docs/en-US/python/reference/functions/hash-message.mdx +++ b/docs/en-US/python/reference/functions/hash-message.mdx @@ -5,7 +5,7 @@ description: Hash an ICU MessageFormat string for translation lookup in General --- -Hashes an ICU MessageFormat string into the hex key used to look up its translation. This is the same hash [`t`](/docs/python/reference/functions/t) computes internally, so you can use it to build or inspect a translation dictionary. +Returns the hex key used to look up an ICU MessageFormat string's translation, computed by hashing the string. This is the same hash [`t`](/docs/python/reference/functions/t) computes internally, so you can use it to build or inspect a translation dictionary. ## Overview [#overview] diff --git a/docs/en-US/python/reference/functions/interpolate-message.mdx b/docs/en-US/python/reference/functions/interpolate-message.mdx index b65fd2700..0e865e2cf 100644 --- a/docs/en-US/python/reference/functions/interpolate-message.mdx +++ b/docs/en-US/python/reference/functions/interpolate-message.mdx @@ -5,7 +5,7 @@ description: Interpolate variables into an ICU MessageFormat string in General T --- -Interpolates variables into an ICU MessageFormat string. This is the low-level formatter that [`t`](/docs/python/reference/functions/t) and [`t_fallback`](/docs/python/reference/functions/t-fallback) build on; it does not perform a translation lookup. +`interpolate_message` is the low-level formatter that [`t`](/docs/python/reference/functions/t) and [`t_fallback`](/docs/python/reference/functions/t-fallback) build on. It fills an ICU MessageFormat string with variable values and does not perform a translation lookup. ## Overview [#overview] diff --git a/docs/en-US/python/reference/functions/msg.mdx b/docs/en-US/python/reference/functions/msg.mdx index 3e6ec606f..ec71cbcb6 100644 --- a/docs/en-US/python/reference/functions/msg.mdx +++ b/docs/en-US/python/reference/functions/msg.mdx @@ -5,7 +5,7 @@ description: Register a message with its translation options as an encoded strin --- -Registers a message together with its translation options and returns an encoded string that can be decoded later. Use it when you build a message in one place and resolve it in another. +Returns an encoded string that carries a message and its translation options together, so it can be decoded and resolved later. Use it when you build a message in one place and resolve it in another. ## Overview [#overview] diff --git a/docs/en-US/python/reference/functions/t-fallback.mdx b/docs/en-US/python/reference/functions/t-fallback.mdx index 350626834..370c6ff9e 100644 --- a/docs/en-US/python/reference/functions/t-fallback.mdx +++ b/docs/en-US/python/reference/functions/t-fallback.mdx @@ -5,7 +5,7 @@ description: Interpolate a string without a translation lookup in General Transl --- -Interpolates variables into a message string without performing a translation lookup. Use it for strings that should be interpolated but not translated, such as content already in the default locale. +Use `t_fallback` for strings that should be interpolated but not translated, such as content already in the default locale. Because it never looks up a translation, it works without an initialized manager. ## Overview [#overview] diff --git a/docs/en-US/react/(frameworks)/nextjs/reference/functions/create-next-middleware.mdx b/docs/en-US/react/(frameworks)/nextjs/reference/functions/create-next-middleware.mdx index bfd5cfc0b..f71e5d74b 100644 --- a/docs/en-US/react/(frameworks)/nextjs/reference/functions/create-next-middleware.mdx +++ b/docs/en-US/react/(frameworks)/nextjs/reference/functions/create-next-middleware.mdx @@ -5,7 +5,7 @@ description: Add locale routing and detection to a Next.js app with General Tran --- -The `createNextMiddleware` function from `gt-next/middleware` adds locale-based routing and detection to a Next.js app. It detects each visitor's locale, persists it in a cookie, and routes them to the localized version of a page. +The `createNextMiddleware` function from `gt-next/middleware` detects each visitor's locale, persists it in a cookie, and routes them to the localized version of a page. Use the [App Router middleware guide](/docs/react/nextjs/app-router-middleware) or [Pages Router middleware guide](/docs/react/nextjs/pages-router-middleware) for router-specific setup. diff --git a/docs/en-US/react/reference/components/datetime.mdx b/docs/en-US/react/reference/components/datetime.mdx index aef67de04..114a5b2e0 100644 --- a/docs/en-US/react/reference/components/datetime.mdx +++ b/docs/en-US/react/reference/components/datetime.mdx @@ -5,7 +5,7 @@ description: Format a date and time for the active locale with General Translati --- -The `` component renders a date or time formatted for the active locale. It supports custom formatting options and locale overrides. +The `` component displays a `Date` value as a localized date, time, or both. It supports custom formatting options and locale overrides. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/components/locale-selector.mdx b/docs/en-US/react/reference/components/locale-selector.mdx index fa9a63437..7d7fcda3d 100644 --- a/docs/en-US/react/reference/components/locale-selector.mdx +++ b/docs/en-US/react/reference/components/locale-selector.mdx @@ -5,7 +5,7 @@ description: Render a dropdown for switching the active locale with General Tran --- -The `` component renders a dropdown that lets users switch the active locale. It is a client-side component. +The `` component is a prebuilt, client-side dropdown of your app's configured locales, so you can add a working language switcher without building your own. *Available in `gt-react`, `gt-next`, and `gt-tanstack-start`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/components/num.mdx b/docs/en-US/react/reference/components/num.mdx index 50e95ddad..04f74dabd 100644 --- a/docs/en-US/react/reference/components/num.mdx +++ b/docs/en-US/react/reference/components/num.mdx @@ -5,7 +5,7 @@ description: Format a number for the active locale with General Translation gt-r --- -The `` component renders a number formatted for the active locale. It is a variable component for use inside a [``](/docs/react/reference/components/t), or on its own. +The `` component applies locale-aware digit grouping and decimal formatting to a number. It is a variable component for use inside a [``](/docs/react/reference/components/t), or on its own. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/components/plural.mdx b/docs/en-US/react/reference/components/plural.mdx index 2816f33e3..e837001b4 100644 --- a/docs/en-US/react/reference/components/plural.mdx +++ b/docs/en-US/react/reference/components/plural.mdx @@ -5,7 +5,7 @@ description: Render count-based content using the active locale's plural rules w --- -The `` component conjugates a sentence based on a count, using the active locale's plural rules. It selects the right form for a number — English needs two ("one item" / "two items"), while other languages need up to six. +The `` component swaps its wording based on a count so the sentence agrees with the number in each language. English needs two ("one item" / "two items"), while other languages need up to six. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/components/region-selector.mdx b/docs/en-US/react/reference/components/region-selector.mdx index 6b0a3b23a..ac56c316d 100644 --- a/docs/en-US/react/reference/components/region-selector.mdx +++ b/docs/en-US/react/reference/components/region-selector.mdx @@ -5,7 +5,7 @@ description: Render a dropdown for switching the active region with General Tran --- -The `` component renders a dropdown that lets users switch the active region. It is a client-side component that reads region data from the [``](/docs/react/reference/components/gt-provider) context. +The `` component gives users a prebuilt dropdown for selecting their region, without you building a custom selector. It is a client-side component that reads region data from the [``](/docs/react/reference/components/gt-provider) context. *Available in `gt-react` and `gt-next`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/components/relative-time.mdx b/docs/en-US/react/reference/components/relative-time.mdx index 9d01ce2cf..268397711 100644 --- a/docs/en-US/react/reference/components/relative-time.mdx +++ b/docs/en-US/react/reference/components/relative-time.mdx @@ -5,7 +5,7 @@ description: Format a localized relative time such as "2 hours ago" with General --- -The `` component renders a localized relative time, such as "2 hours ago" or "in 3 days". It works either by auto-selecting the best unit from a `Date`, or from an explicit value and unit. +The `` component renders relative-time wording with the unit and phrasing conventions of the active locale. It works either by auto-selecting the best unit from a `Date`, or from an explicit value and unit. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-default-locale.mdx b/docs/en-US/react/reference/hooks/use-default-locale.mdx index 7b3f7f701..24b32fd93 100644 --- a/docs/en-US/react/reference/hooks/use-default-locale.mdx +++ b/docs/en-US/react/reference/hooks/use-default-locale.mdx @@ -5,7 +5,7 @@ description: Read the source (default) locale with General Translation gt-react. --- -The `useDefaultLocale` hook returns the application's default (source) locale from the [``](/docs/react/reference/components/gt-provider) context. This is the fallback language, used when a user's preferred locale is unavailable. +The `useDefaultLocale` hook returns your app's fallback language, used when a user's preferred locale is unavailable. It reads this default (source) locale from the [``](/docs/react/reference/components/gt-provider) context. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-locale-direction.mdx b/docs/en-US/react/reference/hooks/use-locale-direction.mdx index 4eb8d3bf1..2a7dd8ad2 100644 --- a/docs/en-US/react/reference/hooks/use-locale-direction.mdx +++ b/docs/en-US/react/reference/hooks/use-locale-direction.mdx @@ -5,7 +5,7 @@ description: Read the text direction for a locale with General Translation gt-re --- -The `useLocaleDirection` hook returns the text direction — `'ltr'` or `'rtl'` — for the current locale, or for a locale you specify. +The `useLocaleDirection` hook tells you whether a locale is written left-to-right (`'ltr'`) or right-to-left (`'rtl'`), defaulting to the active locale when you do not pass one. *Available in `gt-react`, `gt-next`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-locale-properties.mdx b/docs/en-US/react/reference/hooks/use-locale-properties.mdx index 402a7d897..742abb52a 100644 --- a/docs/en-US/react/reference/hooks/use-locale-properties.mdx +++ b/docs/en-US/react/reference/hooks/use-locale-properties.mdx @@ -5,7 +5,7 @@ description: Read display metadata for a locale with General Translation gt-reac --- -The `useLocaleProperties` hook returns display metadata for a locale — its name, native name, language, region, and script. +The `useLocaleProperties` hook resolves a locale code into its human-readable details: name, native name, language, region, and script. *Available in `gt-react`, `gt-next`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-locale-selector.mdx b/docs/en-US/react/reference/hooks/use-locale-selector.mdx index a20e4ade1..c619d6050 100644 --- a/docs/en-US/react/reference/hooks/use-locale-selector.mdx +++ b/docs/en-US/react/reference/hooks/use-locale-selector.mdx @@ -5,7 +5,7 @@ description: Build a custom locale switcher with General Translation gt-react. A --- -The `useLocaleSelector` hook returns the state needed to build a custom locale switcher: the active locale, the available locales, a locale-properties helper, and a setter. +The `useLocaleSelector` hook exposes the pieces for a custom language switcher: the active locale, the available locales, a locale-properties helper, and a setter to change the locale. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-locales.mdx b/docs/en-US/react/reference/hooks/use-locales.mdx index 805fe0b0b..686ce0ee7 100644 --- a/docs/en-US/react/reference/hooks/use-locales.mdx +++ b/docs/en-US/react/reference/hooks/use-locales.mdx @@ -5,7 +5,7 @@ description: List the supported locales with General Translation gt-react. API r --- -The `useLocales` hook returns the list of supported locales from the [``](/docs/react/reference/components/gt-provider) context. +The `useLocales` hook returns the locale codes your app supports as an array of strings, read from the [``](/docs/react/reference/components/gt-provider) context. Use it to render or iterate the available locales, such as when building a custom language switcher. *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-region-selector.mdx b/docs/en-US/react/reference/hooks/use-region-selector.mdx index 9100e8be3..110dda740 100644 --- a/docs/en-US/react/reference/hooks/use-region-selector.mdx +++ b/docs/en-US/react/reference/hooks/use-region-selector.mdx @@ -5,7 +5,7 @@ description: Build a custom region switcher with General Translation gt-react. A --- -The `useRegionSelector` hook returns the data and handlers needed to build a custom region selector: the active region, available regions, region metadata, and functions to update the region or locale. +The `useRegionSelector` hook exposes the pieces for a custom region picker: the active region, the available regions, region metadata, and functions to update the region or locale. *Available in `gt-react` and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.* diff --git a/docs/en-US/react/reference/hooks/use-translations.mdx b/docs/en-US/react/reference/hooks/use-translations.mdx index aa3455332..31bea6133 100644 --- a/docs/en-US/react/reference/hooks/use-translations.mdx +++ b/docs/en-US/react/reference/hooks/use-translations.mdx @@ -5,7 +5,7 @@ description: Look up string translations from a dictionary by id with General Tr --- -The `useTranslations` hook accesses string translations from the [translation dictionary](/docs/react/guides/translating-with-dictionaries) by id. This is the dictionary-based alternative to the [``](/docs/react/reference/components/t) component and [`useGT`](/docs/react/reference/hooks/use-gt). +The `useTranslations` hook returns a function for reading pre-translated strings from your [translation dictionary](/docs/react/guides/translating-with-dictionaries), resolved into the active locale by id. This is the dictionary-based alternative to the [``](/docs/react/reference/components/t) component and [`useGT`](/docs/react/reference/hooks/use-gt). *Available in `gt-react`, `gt-next`, `gt-tanstack-start`, and `gt-react-native`. Examples import from `gt-react`; import from your framework's package instead.*