From 9e13397edf451adc7539a17812c6e68c67da3339 Mon Sep 17 00:00:00 2001 From: moss-bryophyta <261561981+moss-bryophyta@users.noreply.github.com> Date: Wed, 17 Jun 2026 08:06:54 -0700 Subject: [PATCH] fix: backtick package names in prose and correct i.e. abbreviation Per the docs style guide, package names (gt-next, gt-react, gt-react-native) should always appear in backticks when referenced in prose. Adds backticks to body prose and Accordion titles that were missing them. Also fixes 'ie' -> 'i.e.,' in the with-gt-config locale mode description. --- docs/en-US/cli/faqs.mdx | 2 +- docs/en-US/cli/formats/gt.mdx | 2 +- docs/en-US/locadex/next.mdx | 2 +- docs/en-US/next-lint/index.mdx | 2 +- docs/en-US/next/concepts/compiler.mdx | 2 +- docs/en-US/next/faqs.mdx | 4 ++-- docs/en-US/next/guides/cache-components.mdx | 4 ++-- docs/en-US/next/index.mdx | 2 +- docs/en-US/react-native/faqs.mdx | 2 +- docs/en-US/react-native/tutorials/quickstart-expo.mdx | 2 +- docs/en-US/react-native/tutorials/quickstart.mdx | 2 +- docs/en-US/react/faqs.mdx | 2 +- docs/en-US/react/index.mdx | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/en-US/cli/faqs.mdx b/docs/en-US/cli/faqs.mdx index 32e9381b..a5ecff6c 100644 --- a/docs/en-US/cli/faqs.mdx +++ b/docs/en-US/cli/faqs.mdx @@ -11,7 +11,7 @@ The [`translate`](/docs/cli/translate) command requires a production API key, wh Run it in your CI/CD pipeline **before** building your app for production. It should not be used during development — in development, use development API keys for on-demand translation instead. -### Can I use the CLI with libraries other than gt-next and gt-react? +### Can I use the CLI with libraries other than `gt-next` and `gt-react`? Yes. The CLI can generate translations for third-party i18n libraries like [next-intl](https://next-intl.dev/) and [i18next](https://react.i18next.com/). It can also translate standalone JSON, Markdown, MDX, JS, and TS files. diff --git a/docs/en-US/cli/formats/gt.mdx b/docs/en-US/cli/formats/gt.mdx index 4274138b..522854ad 100644 --- a/docs/en-US/cli/formats/gt.mdx +++ b/docs/en-US/cli/formats/gt.mdx @@ -9,7 +9,7 @@ This tutorial will show you how to automatically manage your project's translati **Note:** This should only be used when you are shipping a production build. - If you are using gt-next, gt-react, or gt-react-native in development, this + If you are using `gt-next`, `gt-react`, or `gt-react-native` in development, this command is not needed. diff --git a/docs/en-US/locadex/next.mdx b/docs/en-US/locadex/next.mdx index 1f3e3ea0..173b9078 100644 --- a/docs/en-US/locadex/next.mdx +++ b/docs/en-US/locadex/next.mdx @@ -12,7 +12,7 @@ It takes 5 minutes to install. Locadex: -- Configures your project to use the gt-next i18n library +- Configures your project to use the `gt-next` i18n library - Modifies your React components and strings to support multilingual content - Translates your app into as many languages as you need - Continuously internationalizes and translates as you push new content diff --git a/docs/en-US/next-lint/index.mdx b/docs/en-US/next-lint/index.mdx index 989ee7f9..fa870b05 100644 --- a/docs/en-US/next-lint/index.mdx +++ b/docs/en-US/next-lint/index.mdx @@ -7,7 +7,7 @@ description: ESLint plugin for gt-next components. This is in alpha. Subject to changes. -ESLint plugin that catches common translation errors in gt-next components. +ESLint plugin that catches common translation errors in `gt-next` components. ## Installation diff --git a/docs/en-US/next/concepts/compiler.mdx b/docs/en-US/next/concepts/compiler.mdx index 8dc05aa8..30090c21 100644 --- a/docs/en-US/next/concepts/compiler.mdx +++ b/docs/en-US/next/concepts/compiler.mdx @@ -3,7 +3,7 @@ title: Compiler description: gt-next's Rust-based SWC plugin --- -gt-next includes a Rust-based SWC plugin that performs build-time analysis to catch common translation errors and optimize performance. +`gt-next` includes a Rust-based SWC plugin that performs build-time analysis to catch common translation errors and optimize performance. ## Features diff --git a/docs/en-US/next/faqs.mdx b/docs/en-US/next/faqs.mdx index cbd40ed6..c7d52231 100644 --- a/docs/en-US/next/faqs.mdx +++ b/docs/en-US/next/faqs.mdx @@ -5,7 +5,7 @@ description: Frequently asked questions about gt-next ### What happens if there are missing translations in production? -If a translation for some content is missing in production, gt-next automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. +If a translation for some content is missing in production, `gt-next` automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. ### Why do I have to install the CLI tool? @@ -30,7 +30,7 @@ In production, `` won't do this, so your API keys are never exposed to the cl The `` component doesn't support translating dynamic content and variables directly, because the translations could potentially change with every re-render. However, you can still include dynamic content inside a `` by wrapping it with ``, ``, or `` components. This is similar to how other libraries handle string interpolation. -gt-next also has a [``](/docs/next/api/components/tx) server-side component which translates content at runtime and supports dynamic content, but it requires an API key. +`gt-next` also has a [``](/docs/next/api/components/tx) server-side component which translates content at runtime and supports dynamic content, but it requires an API key. ### Can I deploy my app without depending on GT servers? diff --git a/docs/en-US/next/guides/cache-components.mdx b/docs/en-US/next/guides/cache-components.mdx index 6a39f2ec..f48802c6 100644 --- a/docs/en-US/next/guides/cache-components.mdx +++ b/docs/en-US/next/guides/cache-components.mdx @@ -3,7 +3,7 @@ title: Cache Components description: Setting up Cache Components in gt-next --- -This guide shows how to use gt-next with Next.js Cache Components to optimize internationalized applications. +This guide shows how to use `gt-next` with Next.js Cache Components to optimize internationalized applications. --- @@ -15,7 +15,7 @@ If you have not already, follow the [Next.js Cache Components guide](https://nex ### Enable cache components and configure request functions -Enable cache components in your Next.js config, and define custom `getLocale` and `getRegion` request functions that use `next/root-params` so that gt-next can resolve the locale inside cached components. +Enable cache components in your Next.js config, and define custom `getLocale` and `getRegion` request functions that use `next/root-params` so that `gt-next` can resolve the locale inside cached components. Your `[locale]` segment must be a **root parameter** — the first dynamic segment in your app directory, with no `app/layout.tsx` above it. Your root layout must live inside `app/[locale]/`. diff --git a/docs/en-US/next/index.mdx b/docs/en-US/next/index.mdx index 2d4b8683..7f87aef3 100644 --- a/docs/en-US/next/index.mdx +++ b/docs/en-US/next/index.mdx @@ -206,7 +206,7 @@ npx gt auth - + Yes. Without API keys, `gt-next` works as a standard i18n library. You won't get on-demand translation in development, but you can still: - Provide your own translation files manually - Use all components (``, ``, `LocaleSelector`, etc.) diff --git a/docs/en-US/react-native/faqs.mdx b/docs/en-US/react-native/faqs.mdx index 09b63ed7..b2cc2059 100644 --- a/docs/en-US/react-native/faqs.mdx +++ b/docs/en-US/react-native/faqs.mdx @@ -5,7 +5,7 @@ description: Frequently asked questions about gt-react-native ### What happens if there are missing translations in production? -If a translation for some content is missing in production, gt-react-native automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. +If a translation for some content is missing in production, `gt-react-native` automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. ### Why do I have to install the CLI tool? diff --git a/docs/en-US/react-native/tutorials/quickstart-expo.mdx b/docs/en-US/react-native/tutorials/quickstart-expo.mdx index c59975bc..4f3d99c9 100644 --- a/docs/en-US/react-native/tutorials/quickstart-expo.mdx +++ b/docs/en-US/react-native/tutorials/quickstart-expo.mdx @@ -262,7 +262,7 @@ npx gt auth - + Yes. Without API keys, `gt-react-native` works as a standard i18n library. You won't get on-demand translation in development, but you can still: - Provide your own translation files manually - Use all components (``, ``, `LocaleSelector`, etc.) diff --git a/docs/en-US/react-native/tutorials/quickstart.mdx b/docs/en-US/react-native/tutorials/quickstart.mdx index 9368835a..c41653ee 100644 --- a/docs/en-US/react-native/tutorials/quickstart.mdx +++ b/docs/en-US/react-native/tutorials/quickstart.mdx @@ -259,7 +259,7 @@ npx gt auth - + Yes. Without API keys, `gt-react-native` works as a standard i18n library. You won't get on-demand translation in development, but you can still: - Provide your own translation files manually - Use all components (``, ``, `LocaleSelector`, etc.) diff --git a/docs/en-US/react/faqs.mdx b/docs/en-US/react/faqs.mdx index 1414fb32..ebf6b68d 100644 --- a/docs/en-US/react/faqs.mdx +++ b/docs/en-US/react/faqs.mdx @@ -5,7 +5,7 @@ description: Frequently asked questions about gt-react ### What happens if there are missing translations in production? -If a translation for some content is missing in production, gt-react automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. +If a translation for some content is missing in production, `gt-react` automatically falls back to the original source text. Your app will still render correctly — users will just see the default language for that piece of content. ### Why do I have to install the CLI tool? diff --git a/docs/en-US/react/index.mdx b/docs/en-US/react/index.mdx index 024fe556..52052a72 100644 --- a/docs/en-US/react/index.mdx +++ b/docs/en-US/react/index.mdx @@ -256,7 +256,7 @@ npx gt auth - + Yes. Without API keys, `gt-react` works as a standard i18n library. You won't get on-demand translation in development, but you can still: - Provide your own translation files manually - Use all components (``, ``, `LocaleSelector`, etc.)