From 09455332a5dc29f2ca00deee7e6acc873f845f52 Mon Sep 17 00:00:00 2001 From: Taylor Fang Date: Fri, 17 Jul 2026 10:47:39 -0700 Subject: [PATCH] fixing bugs and updating machine-readable files --- DOCS-SKILL.md | 6 +- llms.txt | 339 +++++++++++++++++++++++++++++++++++++++++++ sitemap.md | 392 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 734 insertions(+), 3 deletions(-) create mode 100644 llms.txt create mode 100644 sitemap.md diff --git a/DOCS-SKILL.md b/DOCS-SKILL.md index c070f1f30..c69456823 100644 --- a/DOCS-SKILL.md +++ b/DOCS-SKILL.md @@ -250,12 +250,12 @@ The **overview** section doubles as a **landing hub**: its `meta.json` lists the ### Machine-readable outputs -The docs are written to be consumed by LLMs and agents, not only humans. Alongside the filetree, publish two machine-readable maps at the repo root, both **generated from the** `meta.json` **filetree** (never hand-edited): +The docs are written to be consumed by LLMs and agents, not only humans. Alongside the filetree, maintain two machine-readable maps at the repo root, both mirroring the `meta.json` filetree: - `llms.txt` — an [llmstxt.org](https://llmstxt.org/)-style index for LLMs and agents: an H1, a one-line blockquote summary, then per-section lists of `- [Title](url): description` links. - `sitemap.md` — a linked, hierarchical map of every published page in navigation order. -Regenerate both whenever you add, rename, remove, or reorder pages, so they stay in sync with the `meta.json` filetree. **Only include pages that actually exist** — omit in-progress sections and manifest-only stubs, and keep every link resolvable. +**Whenever you add, rename, remove, or reorder any page, update `llms.txt` and `sitemap.md` in the same change** so they stay in sync with the `meta.json` filetree — a page addition is not complete until both maps reflect it. Match the existing order, titles, and descriptions (use each page's frontmatter `title` and `description`), skip `meta.json` separators and cross-section link entries (they duplicate real pages), and drop the `(route-group)` segment from URLs. **Only include pages that actually exist** — omit in-progress sections and manifest-only stubs, and keep every link resolvable. ### Agent-navigable by default @@ -715,6 +715,6 @@ These patterns are **blocked by CI** and will fail the build, so never use them - 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). -- **Machine-readable outputs are in sync:** every entry in each `meta.json` `pages` array resolves to a real file, and `llms.txt` and `sitemap.md` have been regenerated so they list only existing pages. +- **Machine-readable outputs are in sync:** every entry in each `meta.json` `pages` array resolves to a real file, and `llms.txt` and `sitemap.md` have been updated in the same change so they list only existing pages, in filetree order. - No typos; body prose sentences end with periods, and so do descriptions (a description that is a question ends with `?`; section-root tab subtitles take no period). diff --git a/llms.txt b/llms.txt new file mode 100644 index 000000000..c85b2a14d --- /dev/null +++ b/llms.txt @@ -0,0 +1,339 @@ +# General Translation + +> General Translation is a full-stack localization platform: open-source i18n libraries, a CLI, and a translation API, Dashboard, and AI agent for translating apps and content into any language. + +## Overview + +- [Introduction](https://generaltranslation.com/docs/overview/get-started): Get started with General Translation's full stack for localization and internationalization. +- [Key concepts](https://generaltranslation.com/docs/overview/key-concepts): Understanding the core concepts behind General Translation: including internationalization, localization, translation, locales, and context +- [Using coding agents](https://generaltranslation.com/docs/overview/for-coding-agents): How to use AI coding agents and LLMs with General Translation by pointing them at the machine-readable docs, the MCP server, and our drop-in agent guide. + +## Platform + +- [Platform](https://generaltranslation.com/docs/platform): Browse docs for the General Translation Platform, including the Dashboard, Locadex, Core library, and OpenAPI. +- [Get started with the Dashboard](https://generaltranslation.com/docs/platform/dashboard/get-started): Learn how the Dashboard is organized and where to find common translation workflows. +- [Adding translation context](https://generaltranslation.com/docs/platform/dashboard/guides/adding-translation-context): How to use Context Groups with Glossary (key terms) and Directives (tone and style) to guide AI translation in the General Translation Dashboard. +- [Reviewing and editing translations](https://generaltranslation.com/docs/platform/dashboard/guides/reviewing-translations): How to review and edit translations in the General Translation Dashboard: this guide covers manual edits, comparing locales, and inspecting version history. +- [Adding annotations](https://generaltranslation.com/docs/platform/dashboard/guides/adding-annotations): How to use labels, notes, and comments to coordinate translation review by entry and locale in the General Translation Dashboard. +- [Managing billing](https://generaltranslation.com/docs/platform/dashboard/guides/managing-billing): How to manage billing in General Translation: this guide covers plans, usage-based pricing, prepaid credits, and auto-reload in the Dashboard. +- [API keys](https://generaltranslation.com/docs/platform/dashboard/reference/api-keys): Create and manage Project and Organization API keys for apps, local development, and automation. +- [API reference](https://generaltranslation.com/docs/platform/dashboard/reference/api-reference): Find the public General Translation API endpoints, authentication details, and OpenAPI spec. +- [Webhooks](https://generaltranslation.com/docs/platform/dashboard/reference/webhooks): Configure webhook endpoints, verify signatures, and handle translation events from General Translation. +- [Organization settings](https://generaltranslation.com/docs/platform/dashboard/reference/organization-settings): Manage Organization members, roles, invitations, and default settings. +- [Roles and permissions](https://generaltranslation.com/docs/platform/dashboard/reference/roles-and-permissions): Understand the default Organization roles, permission categories, and how permissions inherit across Enterprises, Organizations, and Projects. +- [Project settings](https://generaltranslation.com/docs/platform/dashboard/reference/project-settings): Project settings control how an individual Project appears and how its translations are delivered. +- [Supported locales](https://generaltranslation.com/docs/platform/dashboard/reference/supported-locales): Search the locales supported by the General Translation platform. +- [Quickstart](https://generaltranslation.com/docs/platform/locadex/quickstart): Learn how to use Locadex, the AI agent which connects your codebase, translations, and content sources. It’s the fastest way to run General Translation's full-stack localization. +- [Configuring Locadex workflows](https://generaltranslation.com/docs/platform/locadex/guides/configuring-workflows): How to configure when Locadex runs codegen, translation, and locale update workflows. +- [Using Locadex in a monorepo](https://generaltranslation.com/docs/platform/locadex/guides/using-in-monorepos): How to use Locadex within a monorepo: this guide covers configuring the app root directory and commands. +- [Auto-merging Locadex PRs](https://generaltranslation.com/docs/platform/locadex/guides/auto-merging-prs): How to configure Locadex to merge pull requests automatically when checks pass. +- [Managing languages](https://generaltranslation.com/docs/platform/locadex/guides/managing-languages): How to choose the source locale and target languages Locadex uses for translation workflows. +- [Adding environment variables](https://generaltranslation.com/docs/platform/locadex/guides/adding-environment-variables): How to add key-value environment variables that Locadex injects into the sandbox when workflows run. +- [Viewing workflow history](https://generaltranslation.com/docs/platform/locadex/guides/viewing-workflow-history): How to view recent and past Locadex workflow runs from the Agent and History pages. +- [Agent page](https://generaltranslation.com/docs/platform/locadex/reference/agent): Reference for the Locadex Agent page, repository status, languages, and recent workflow runs. +- [Configuration](https://generaltranslation.com/docs/platform/locadex/reference/config): Reference for Locadex general settings, workflows, languages, secrets, and danger zone actions. +- [VM image](https://generaltranslation.com/docs/platform/locadex/reference/vm-image): Reference for the sandbox environment Locadex uses to run workflows. +- [Quickstart](https://generaltranslation.com/docs/platform/core/quickstart): Learn what the `generaltranslation` Core library does, when to use it, and how to translate your first string. +- [Understanding locale codes](https://generaltranslation.com/docs/platform/core/guides/locale-codes): What are locale codes, and how are they used in the General Translation stack? +- [Translating strings](https://generaltranslation.com/docs/platform/core/guides/translating-strings): How to translate strings, batches of strings, and structured content directly from code with the generaltranslation library. +- [Translating files](https://generaltranslation.com/docs/platform/core/guides/translating-files): How to translate files with the generaltranslation library: this guide covers uploading a source file, enqueuing translation, checking status, and downloading the translated file. +- [Constructor](https://generaltranslation.com/docs/platform/core/reference/gt-class/constructor): Initialize a GT instance with API keys, Project settings, default locales, and locale mappings. API reference for Constructor. +- [setConfig](https://generaltranslation.com/docs/platform/core/reference/gt-class/set-config): Update configuration on an existing GT instance. API reference for setConfig. +- [translate](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/translate): Translate one string or structured content entry into a target locale with General Translation. API reference for translate. +- [translateMany](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/translate-many): Translate multiple strings or structured content entries in one request. API reference for translateMany. +- [uploadSourceFiles](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/upload-source-files): Upload source files to a Project before queueing translation. API reference for uploadSourceFiles. +- [uploadTranslations](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/upload-translations): Upload existing translated files that correspond to source files. API reference for uploadTranslations. +- [enqueueFiles](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/enqueue-files): Queue uploaded source files for translation into one or more target locales. API reference for enqueueFiles. +- [awaitJobs](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/await-jobs): Poll queued translation jobs until they complete, fail, or time out. API reference for awaitJobs. +- [checkJobStatus](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/check-job-status): Check the current status of a translation or setup job. API reference for checkJobStatus. +- [queryFileData](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/query-file-data): Check translation status and metadata for uploaded or translated files. API reference for queryFileData. +- [querySourceFile](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/query-source-file): Retrieve source file metadata and related translation information. API reference for querySourceFile. +- [downloadFile](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/download-file): Download one translated file after translation is complete. API reference for downloadFile. +- [downloadFileBatch](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/download-file-batch): Download multiple translated files in one request. API reference for downloadFileBatch. +- [setupProject](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/setup-project): Prepare uploaded files for Project translation workflows. API reference for setupProject. +- [getProjectData](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/get-project-data): Read Project-level metadata and translation configuration. API reference for getProjectData. +- [createTag](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/create-tag): Create a tag for grouping or identifying file versions. API reference for createTag. +- [Project and file management](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/project/project-management): Manage a General Translation Project's info, branches, file moves, CDN publishing, and edit diffs from a GT instance. API reference for the Project and file management methods. +- [formatNum](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-num): Format numbers, currency, percentages, and numeric values by locale. API reference for formatNum. +- [formatCurrency](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-currency): Format a currency value by locale on a GT instance. API reference for formatCurrency. +- [formatDateTime](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-date-time): Format dates and times by locale. API reference for formatDateTime. +- [formatRelativeTime](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time): Format relative time values such as minutes ago or days from now. API reference for formatRelativeTime. +- [formatRelativeTimeFromDate](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time-from-date): Format relative time from a date compared with the current time or another date. API reference for formatRelativeTimeFromDate. +- [formatMessage](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-message): Format ICU-style messages with variables and locale-aware values. API reference for formatMessage. +- [formatList](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-list): Format an array into a locale-aware list string on a GT instance. API reference for formatList. +- [formatListToParts](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-list-to-parts): Format a list into locale-aware parts for custom rendering. API reference for formatListToParts. +- [formatCutoff](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-cutoff): Truncate text with locale-aware cutoff characters and terminators. API reference for formatCutoff. +- [determineLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/determine-locale): Find the best matching locale from a list of approved locales. API reference for determineLocale. +- [getLocaleDirection](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-direction): Return the text direction for a locale. API reference for getLocaleDirection. +- [getLocaleEmoji](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-emoji): Return an emoji marker for a locale or region. API reference for getLocaleEmoji. +- [getLocaleName](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-name): Return a human-readable locale name. API reference for getLocaleName. +- [getLocaleProperties](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties): Return detailed language, script, region, and direction properties for a locale. API reference for getLocaleProperties. +- [getRegionProperties](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-region-properties): Return region metadata for a locale or region code. API reference for getRegionProperties. +- [isValidLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale): Check whether a value is a valid locale code. API reference for isValidLocale. +- [isSameLanguage](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-same-language): Check whether two locales share the same base language. API reference for isSameLanguage. +- [isSameDialect](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-same-dialect): Check whether two locales represent the same dialect. API reference for isSameDialect. +- [isSupersetLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-superset-locale): Check whether one locale can represent another more specific locale. API reference for isSupersetLocale. +- [requiresTranslation](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/requires-translation): Check whether translation is needed between two locales. API reference for requiresTranslation. +- [standardizeLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/standardize-locale): Normalize a locale code into a standard format. API reference for standardizeLocale. +- [resolveAliasLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale): Resolve a locale alias to the locale code used by a custom mapping. API reference for resolveAliasLocale. +- [resolveCanonicalLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale): Resolve a locale alias to its canonical locale code on a GT instance. API reference for resolveCanonicalLocale. +- [formatNum](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-num): Format numbers, currency, percentages, and numeric values without a GT instance. API reference for formatNum. +- [formatCurrency](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-currency): Format a currency value by locale without a GT instance. API reference for formatCurrency. +- [formatDateTime](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-date-time): Format dates and times without a GT instance. API reference for formatDateTime. +- [formatRelativeTime](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-relative-time): Format relative time values without a GT instance. API reference for formatRelativeTime. +- [formatRelativeTimeFromDate](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-relative-time-from-date): Format relative time from a date without a GT instance. API reference for formatRelativeTimeFromDate. +- [formatMessage](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-message): Format ICU-style messages without a GT instance. API reference for formatMessage. +- [formatList](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-list): Format an array into a locale-aware list string without a GT instance. API reference for formatList. +- [formatListToParts](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-list-to-parts): Format a list into locale-aware parts without a GT instance. API reference for formatListToParts. +- [formatCutoff](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-cutoff): Truncate text with locale-aware cutoff characters without a GT instance. API reference for formatCutoff. +- [determineLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/determine-locale): Find the best matching locale without a GT instance. API reference for determineLocale. +- [getLocaleDirection](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-direction): Return text direction for a locale without a GT instance. API reference for getLocaleDirection. +- [getLocaleEmoji](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-emoji): Return an emoji marker for a locale or region without a GT instance. API reference for getLocaleEmoji. +- [getLocaleName](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-name): Return a human-readable locale name without a GT instance. API reference for getLocaleName. +- [getLocaleProperties](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-properties): Return detailed locale properties without a GT instance. API reference for getLocaleProperties. +- [getRegionProperties](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-region-properties): Return region metadata without a GT instance. API reference for getRegionProperties. +- [isValidLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-valid-locale): Check whether a value is a valid locale code without a GT instance. API reference for isValidLocale. +- [isSameLanguage](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-same-language): Check whether two locales share the same base language without a GT instance. API reference for isSameLanguage. +- [isSameDialect](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-same-dialect): Check whether two locales represent the same dialect without a GT instance. API reference for isSameDialect. +- [isSupersetLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-superset-locale): Check whether one locale can represent another more specific locale without a GT instance. API reference for isSupersetLocale. +- [requiresTranslation](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/requires-translation): Check whether translation is needed between two locales without a GT instance. API reference for requiresTranslation. +- [standardizeLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/standardize-locale): Normalize a locale code into a standard format without a GT instance. API reference for standardizeLocale. +- [resolveAliasLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/resolve-alias-locale): Resolve a locale alias to the locale code used by a custom mapping without a GT instance. API reference for resolveAliasLocale. +- [resolveCanonicalLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/resolve-canonical-locale): Resolve a locale alias to its canonical locale code without a GT instance. API reference for resolveCanonicalLocale. +- [Content](https://generaltranslation.com/docs/platform/core/reference/types/content): Supported content formats for translation. API reference for Content type. +- [CustomMapping](https://generaltranslation.com/docs/platform/core/reference/types/custom-mapping): Custom locale mappings and locale property overrides. API reference for CustomMapping type. +- [DataFormat](https://generaltranslation.com/docs/platform/core/reference/types/data-format): Supported translation data format values. API reference for DataFormat type. +- [EnqueueFilesOptions](https://generaltranslation.com/docs/platform/core/reference/types/enqueue-files-options): Options for queueing uploaded files for translation with General Translation. API reference for EnqueueFilesOptions type. +- [EntryMetadata](https://generaltranslation.com/docs/platform/core/reference/types/entry-metadata): Metadata for adding context to string translation entries. API reference for EntryMetadata type. +- [TranslateManyEntry](https://generaltranslation.com/docs/platform/core/reference/types/translate-many-entry): Input shape for translate and translateMany entries. API reference for TranslateManyEntry type. +- [FileToTranslate](https://generaltranslation.com/docs/platform/core/reference/types/file-to-translate): File input structure for file translation workflows. API reference for FileToTranslate type. +- [GTConstructorParams](https://generaltranslation.com/docs/platform/core/reference/types/gt-constructor-params): Configuration options accepted by the GT constructor. API reference for GTConstructorParams type. +- [JsxChildren](https://generaltranslation.com/docs/platform/core/reference/types/jsx-children): JSX content structure for translatable children. API reference for JsxChildren type. +- [JsxElement](https://generaltranslation.com/docs/platform/core/reference/types/jsx-element): Structured JSX-like element used in translatable content. API reference for JsxElement type. +- [LocaleProperties](https://generaltranslation.com/docs/platform/core/reference/types/locale-properties): Language, script, region, and direction metadata for a locale. API reference for LocaleProperties type. +- [TranslateManyResult](https://generaltranslation.com/docs/platform/core/reference/types/translate-many-result): Result array returned by batch translation. API reference for TranslateManyResult type. +- [TranslationResult](https://generaltranslation.com/docs/platform/core/reference/types/translation-result): Success or error result returned by General Translation translation methods. API reference for TranslationResult type. +- [Variable](https://generaltranslation.com/docs/platform/core/reference/types/variable): Placeholder for dynamic content in translatable messages. API reference for Variable type. +- [Overview](https://generaltranslation.com/docs/platform/openapi/overview): Learn how to use the public General Translation API endpoints and the OpenAPI spec. +- [Upload source files](https://generaltranslation.com/docs/platform/openapi/reference/files/upload-source): Upload one or more source files to a General Translation Project before queuing translation. API reference for Upload source files. +- [Upload translations](https://generaltranslation.com/docs/platform/openapi/reference/files/upload-translations): Upload translated files to a General Translation Project that match previously uploaded source files. API reference for Upload translations. +- [Submit file diffs](https://generaltranslation.com/docs/platform/openapi/reference/files/submit-diffs): Submit diffs for changed source or translated content to a General Translation Project instead of uploading full files. API reference for Submit file diffs. +- [Download files](https://generaltranslation.com/docs/platform/openapi/reference/files/download-many): Download multiple translated files from a General Translation Project in one request. API reference for Download files. +- [Download file](https://generaltranslation.com/docs/platform/openapi/reference/files/download): Download a single translated file from a General Translation Project for a locale or version. API reference for Download file. +- [Publish files](https://generaltranslation.com/docs/platform/openapi/reference/files/publish-files): Mark a General Translation Project's translated files as published so they are ready for delivery. API reference for Publish files. +- [Get file information](https://generaltranslation.com/docs/platform/openapi/reference/files/file-info): Inspect General Translation source file metadata, versions, locales, and translation state. API reference for Get file information. +- [Get translation status](https://generaltranslation.com/docs/platform/openapi/reference/files/translation-status): Check translation progress and availability by file and locale in a General Translation Project. API reference for Get translation status. +- [Move files](https://generaltranslation.com/docs/platform/openapi/reference/files/move-files): Move or rename files in a General Translation Project. API reference for Move files. +- [Get orphaned files](https://generaltranslation.com/docs/platform/openapi/reference/files/orphaned-files): Find General Translation files that are no longer connected to current source files. API reference for Get orphaned files. +- [Generate context](https://generaltranslation.com/docs/platform/openapi/reference/context/generate-context): Generate General Translation Project glossary terms and translation instructions from source files. API reference for Generate translation context. +- [Check context freshness](https://generaltranslation.com/docs/platform/openapi/reference/context/check-freshness): Check whether General Translation Project context is missing, stale, or ready to refresh. API reference for Check context freshness. +- [Get context generation status](https://generaltranslation.com/docs/platform/openapi/reference/context/context-status): Track the status of a General Translation context generation job. API reference for Get context generation status. +- [Translate at runtime](https://generaltranslation.com/docs/platform/openapi/reference/translation/translate-runtime): Translate strings or structured content directly from an application or service with General Translation. API reference for Translate content at runtime. +- [Queue translations](https://generaltranslation.com/docs/platform/openapi/reference/translation/queue): Queue uploaded source files for background translation in a General Translation Project. API reference for Queue translations. +- [Get translation job status](https://generaltranslation.com/docs/platform/openapi/reference/translation/job-status): Retrieve status for a queued translation job in General Translation. API reference for Get translation job status. +- [Get Project info](https://generaltranslation.com/docs/platform/openapi/reference/project/project-info): Read General Translation Project metadata, settings, and configuration details. API reference for Get Project information. +- [Update Project info](https://generaltranslation.com/docs/platform/openapi/reference/project/update-project): Update General Translation Project-level settings from automation. API reference for Update Project information. +- [Get branch info](https://generaltranslation.com/docs/platform/openapi/reference/project/branch-info): Inspect branch metadata and General Translation Project branch state. API reference for Get branch information. +- [Create a branch](https://generaltranslation.com/docs/platform/openapi/reference/project/create-branch): Create a branch, or rename and confirm the default branch, in a General Translation Project. API reference for Create a branch. +- [Create or update tag](https://generaltranslation.com/docs/platform/openapi/reference/project/upsert-tag): Create or update a tag on General Translation file versions for release tracking. API reference for Create or update tag. + +## CLI + +- [Quickstart](https://generaltranslation.com/docs/cli/quickstart): Learn what the General Translation CLI does, when to use it, and how to translate your first project. +- [Configuring the CLI](https://generaltranslation.com/docs/cli/guides/configuring): How to set up a General Translation gt.config.json: this guide covers configuring your locales, files, and storage options. +- [Generating translations](https://generaltranslation.com/docs/cli/guides/generating-translations): How to translate your project with the General Translation CLI: this guide covers generating translations and saving them to your codebase or the CDN. +- [Managing translations](https://generaltranslation.com/docs/cli/guides/managing-translations): How to manage translations with the General Translation CLI: this guide covers splitting the workflow into upload, enqueue, and download stages, staging translations for review, and syncing local edits. +- [Tracking translations by branch](https://generaltranslation.com/docs/cli/guides/branching): How to track translations separately per git branch with General Translation while you work on features. +- [Using auto-derived translations](https://generaltranslation.com/docs/cli/guides/using-autoderive): How to automatically generate a separate translation entry for each interpolated value with Autoderive in the General Translation CLI. +- [Using automatic JSX injection](https://generaltranslation.com/docs/cli/guides/using-auto-jsx): How to wrap translatable JSX text in General Translation components at build time with automatic JSX injection. +- [Configuration](https://generaltranslation.com/docs/cli/reference/config): Configure the General Translation CLI with the gt.config.json file. API reference for gt.config.json. +- [Keyed metadata](https://generaltranslation.com/docs/cli/reference/keyed-metadata): Attach per-key translation instructions to General Translation JSON and YAML files. API reference for keyed metadata. +- [gt init](https://generaltranslation.com/docs/cli/reference/commands/init): Run the General Translation setup wizard to configure a project. API reference for the gt init command. +- [gt setup](https://generaltranslation.com/docs/cli/reference/commands/setup): Upload source files and register a project for General Translation. API reference for the gt setup command. +- [gt configure](https://generaltranslation.com/docs/cli/reference/commands/configure): Create a General Translation gt.config.json file. API reference for the gt configure command. +- [gt auth](https://generaltranslation.com/docs/cli/reference/commands/auth): Generate General Translation API credentials for a project. API reference for the gt auth command. +- [gt translate](https://generaltranslation.com/docs/cli/reference/commands/translate): Translate a project through the General Translation API. API reference for the gt translate command. +- [gt stage](https://generaltranslation.com/docs/cli/reference/commands/stage): Submit a project for General Translation with human review required. API reference for the gt stage command. +- [gt enqueue](https://generaltranslation.com/docs/cli/reference/commands/enqueue): Queue uploaded files for General Translation without downloading results. API reference for the gt enqueue command. +- [gt download](https://generaltranslation.com/docs/cli/reference/commands/download): Download completed translations from General Translation. API reference for the gt download command. +- [gt upload](https://generaltranslation.com/docs/cli/reference/commands/upload): Upload source files and translations to the General Translation platform. API reference for the gt upload command. +- [gt save-local](https://generaltranslation.com/docs/cli/reference/commands/save-local): Sync local translation edits back to the General Translation platform. API reference for the gt save-local command. +- [gt generate](https://generaltranslation.com/docs/cli/reference/commands/generate): Generate a source template for a General Translation project. API reference for the gt generate command. +- [gt validate](https://generaltranslation.com/docs/cli/reference/commands/validate): Check a General Translation project for translation errors without calling the API. API reference for the gt validate command. +- [GT](https://generaltranslation.com/docs/cli/reference/formats/gt-jsx-files): Translate gt-next, gt-react, and gt-react-native projects with General Translation. API reference for the gt file format. +- [JSON](https://generaltranslation.com/docs/cli/reference/formats/json-files): Translate JSON files with the General Translation CLI. API reference for the JSON file format. +- [PO / POT](https://generaltranslation.com/docs/cli/reference/formats/po-pot-files): Translate PO and POT gettext files with the General Translation CLI. API reference for the PO and POT file format. +- [MDX and Markdown](https://generaltranslation.com/docs/cli/reference/formats/mdx-md-files): Translate MDX and Markdown files with the General Translation CLI. API reference for the MDX and Markdown file formats. +- [TypeScript and JavaScript](https://generaltranslation.com/docs/cli/reference/formats/ts-js-files): Translate TypeScript and JavaScript files with the General Translation CLI. API reference for the TypeScript and JavaScript file formats. +- [YAML](https://generaltranslation.com/docs/cli/reference/formats/yaml-files): Translate YAML files with the General Translation CLI. API reference for the YAML file format. +- [HTML](https://generaltranslation.com/docs/cli/reference/formats/html-files): Translate HTML files with the General Translation CLI. API reference for the HTML file format. +- [Plain text](https://generaltranslation.com/docs/cli/reference/formats/plain-text-files): Translate plain text files with the General Translation CLI. API reference for the plain text file format. + +## React + +- [Overview](https://generaltranslation.com/docs/react/overview): Learn about the General Translation React ecosystem, how its shared translation model works, and which quickstart to follow for your framework. +- [React Quickstart](https://generaltranslation.com/docs/react/react-quickstart): Add multiple languages to a server-rendered React app with General Translation in under 10 minutes. +- [React SPA Quickstart](https://generaltranslation.com/docs/react/react-spa-quickstart): Add multiple languages to a single-page React app with General Translation in under 10 minutes. +- [Next.js App Router Quickstart](https://generaltranslation.com/docs/react/nextjs-quickstart): Add multiple languages to a Next.js App Router app with General Translation in under 10 minutes. +- [Next.js Pages Router Quickstart](https://generaltranslation.com/docs/react/nextjs-pages-router-quickstart): Add multiple languages to a Next.js Pages Router app with General Translation in under 10 minutes. +- [TanStack Start Quickstart](https://generaltranslation.com/docs/react/tanstack-start-quickstart): Add General Translation to a TanStack Start app with gt-tanstack-start, and translate your first content. +- [React Native Quickstart](https://generaltranslation.com/docs/react/react-native-quickstart): Add General Translation to a React Native app with gt-react-native, covering both Expo and the bare React Native CLI. +- [Configuring General Translation](https://generaltranslation.com/docs/react/guides/configuring): How to set up General Translation in React: this guide covers initialization, the provider, credentials, and translation delivery across React, Next.js, TanStack Start, and React Native. +- [Developing with SPA translations](https://generaltranslation.com/docs/react/guides/developing-spa-translations): How to preview General Translation translations while developing a single-page React app. +- [Translating JSX](https://generaltranslation.com/docs/react/guides/translating-jsx): How to translate JSX in place with the General Translation component across React, Next.js, TanStack Start, and React Native. +- [Translating strings](https://generaltranslation.com/docs/react/guides/translating-strings): How to translate standalone strings such as labels and placeholders with the General Translation useGT hook across React, Next.js, TanStack Start, and React Native. +- [Formatting numbers and dates](https://generaltranslation.com/docs/react/guides/formatting-variables): How to insert locale-aware numbers, currencies, dates, and variables into General Translation content across React, Next.js, TanStack Start, and React Native. +- [Handling plurals and branches](https://generaltranslation.com/docs/react/guides/handling-plurals-and-branches): How to render count-based and conditional content with the General Translation and components across React, Next.js, TanStack Start, and React Native. +- [Managing locales](https://generaltranslation.com/docs/react/guides/managing-locales): How to let users switch languages and read the active locale with General Translation across React, Next.js, TanStack Start, and React Native. +- [Translating with dictionaries](https://generaltranslation.com/docs/react/guides/translating-with-dictionaries): How to translate strings from a central dictionary with the General Translation useTranslations hook across React, Next.js, TanStack Start, and React Native. +- [Storing translations locally](https://generaltranslation.com/docs/react/guides/storing-translations): How to bundle General Translation translations in your app instead of loading them from the CDN, across React, Next.js, TanStack Start, and React Native. +- [Linting your code](https://generaltranslation.com/docs/react/guides/linting-your-code): How to catch common internationalization mistakes with the General Translation ESLint plugin across React, Next.js, TanStack Start, and React Native. +- [Configuration](https://generaltranslation.com/docs/react/reference/config): Configure General Translation across the React ecosystem with the shared gt.config.json file and runtime initialization. API reference for gt.config.json. +- [GTProvider](https://generaltranslation.com/docs/react/reference/components/gt-provider): Provide the active locale and translations to a General Translation gt-react component tree. API reference for GTProvider. +- [T](https://generaltranslation.com/docs/react/reference/components/t): Translate JSX children in place with General Translation gt-react. API reference for T. +- [Var](https://generaltranslation.com/docs/react/reference/components/var): Render a dynamic value inside a translation without translating it, with General Translation gt-react. API reference for Var. +- [Num](https://generaltranslation.com/docs/react/reference/components/num): Format a number for the active locale with General Translation gt-react. API reference for Num. +- [Currency](https://generaltranslation.com/docs/react/reference/components/currency): Format a currency amount for the active locale with General Translation gt-react. API reference for Currency. +- [DateTime](https://generaltranslation.com/docs/react/reference/components/datetime): Format a date and time for the active locale with General Translation gt-react. API reference for DateTime. +- [RelativeTime](https://generaltranslation.com/docs/react/reference/components/relative-time): Format a localized relative time such as "2 hours ago" with General Translation gt-react. API reference for RelativeTime. +- [Plural](https://generaltranslation.com/docs/react/reference/components/plural): Render count-based content using the active locale's plural rules with General Translation gt-react. API reference for Plural. +- [Branch](https://generaltranslation.com/docs/react/reference/components/branch): Render content conditionally based on a value with General Translation gt-react. API reference for Branch. +- [Derive](https://generaltranslation.com/docs/react/reference/components/derive): Mark finite content variants for extraction inside a translation with General Translation gt-react. API reference for Derive. +- [LocaleSelector](https://generaltranslation.com/docs/react/reference/components/locale-selector): Render a dropdown for switching the active locale with General Translation gt-react. API reference for LocaleSelector. +- [RegionSelector](https://generaltranslation.com/docs/react/reference/components/region-selector): Render a dropdown for switching the active region with General Translation gt-react. API reference for RegionSelector. +- [useGT](https://generaltranslation.com/docs/react/reference/hooks/use-gt): Get a function to translate strings inline with General Translation gt-react. API reference for useGT. +- [useTranslations](https://generaltranslation.com/docs/react/reference/hooks/use-translations): Look up string translations from a dictionary by id with General Translation gt-react. API reference for useTranslations. +- [useMessages](https://generaltranslation.com/docs/react/reference/hooks/use-messages): Resolve strings registered with msg into the active locale with General Translation gt-react. API reference for useMessages. +- [useLocale](https://generaltranslation.com/docs/react/reference/hooks/use-locale): Read the active locale with General Translation gt-react. API reference for useLocale. +- [useSetLocale](https://generaltranslation.com/docs/react/reference/hooks/use-set-locale): Change the active locale with General Translation gt-react. API reference for useSetLocale. +- [useDefaultLocale](https://generaltranslation.com/docs/react/reference/hooks/use-default-locale): Read the source (default) locale with General Translation gt-react. API reference for useDefaultLocale. +- [useLocales](https://generaltranslation.com/docs/react/reference/hooks/use-locales): List the supported locales with General Translation gt-react. API reference for useLocales. +- [useLocaleProperties](https://generaltranslation.com/docs/react/reference/hooks/use-locale-properties): Read display metadata for a locale with General Translation gt-react. API reference for useLocaleProperties. +- [useLocaleDirection](https://generaltranslation.com/docs/react/reference/hooks/use-locale-direction): Read the text direction for a locale with General Translation gt-react. API reference for useLocaleDirection. +- [useLocaleSelector](https://generaltranslation.com/docs/react/reference/hooks/use-locale-selector): Build a custom locale switcher with General Translation gt-react. API reference for useLocaleSelector. +- [useRegion](https://generaltranslation.com/docs/react/reference/hooks/use-region): Read the active region with General Translation gt-react. API reference for useRegion. +- [useSetRegion](https://generaltranslation.com/docs/react/reference/hooks/use-set-region): Change the active region with General Translation gt-react. API reference for useSetRegion. +- [useRegionSelector](https://generaltranslation.com/docs/react/reference/hooks/use-region-selector): Build a custom region switcher with General Translation gt-react. API reference for useRegionSelector. +- [msg](https://generaltranslation.com/docs/react/reference/functions/msg): Register and encode a string for translation at module scope with General Translation gt-react. API reference for msg. +- [t](https://generaltranslation.com/docs/react/reference/functions/t-function): Translate strings synchronously at module scope with General Translation gt-react. API reference for t. +- [declareVar](https://generaltranslation.com/docs/react/reference/functions/declare-var): Mark a non-translatable variable inside derived content with General Translation gt-react. API reference for declareVar. +- [decodeVars](https://generaltranslation.com/docs/react/reference/functions/decode-vars): Expand variables encoded by declareVar back into their values with General Translation gt-react. API reference for decodeVars. +- [derive](https://generaltranslation.com/docs/react/reference/functions/derive): Mark finite content variants inside a string translation for extraction with General Translation gt-react. API reference for derive. +- [getTranslationsSnapshot](https://generaltranslation.com/docs/react/reference/functions/get-translations-snapshot): Load a locale's translations for the General Translation gt-react provider. API reference for getTranslationsSnapshot. +- [loadTranslations](https://generaltranslation.com/docs/react/reference/functions/load-translations): Customize how translations are loaded in production with General Translation gt-react. API reference for loadTranslations. +- [loadDictionary](https://generaltranslation.com/docs/react/reference/functions/load-dictionary): Load your own dictionary translations as a standalone i18n library with General Translation gt-react. API reference for loadDictionary. +- [InlineTranslationOptions](https://generaltranslation.com/docs/react/reference/types/inline-translation-options): Options for passing variables and metadata to inline string translations with General Translation gt-react. API reference for InlineTranslationOptions. +- [DictionaryTranslationOptions](https://generaltranslation.com/docs/react/reference/types/dictionary-translation-options): Options for passing variables to dictionary entries with General Translation gt-react. API reference for DictionaryTranslationOptions. +- [Lint rules](https://generaltranslation.com/docs/react/reference/lint-rules): Reference for the General Translation React Core linter rules that keep translatable content static and correct. API reference for the React Core linter rules. +- [Next.js](https://generaltranslation.com/docs/react/nextjs): Explore the Next.js-specific features of General Translation, including server components, server functions, the config plugin, middleware, request locale registration, and localized navigation. +- [Server components](https://generaltranslation.com/docs/react/nextjs/server-components): Translate content in React Server Components with General Translation, and understand how gt-next behaves in server versus client components. +- [Configuration](https://generaltranslation.com/docs/react/nextjs/config): Configure General Translation in a Next.js app with the withGTConfig plugin from gt-next/config, its options, and local versus CDN translations. API reference for withGTConfig. +- [App Router middleware](https://generaltranslation.com/docs/react/nextjs/app-router-middleware): How to configure General Translation locale routing for the Next.js App Router. +- [Registering request locales](https://generaltranslation.com/docs/react/nextjs/registering-request-locales): How to register a locale for Next.js App Router route handlers and generated metadata images with General Translation. +- [Pages Router middleware](https://generaltranslation.com/docs/react/nextjs/pages-router-middleware): How to configure General Translation locale routing for the Next.js Pages Router. +- [App Router static site generation](https://generaltranslation.com/docs/react/nextjs/app-router-static-site-generation): How to pre-render localized Next.js App Router pages with General Translation. +- [Pages Router static site generation](https://generaltranslation.com/docs/react/nextjs/pages-router-static-site-generation): How to pre-render localized Next.js Pages Router pages with General Translation. +- [Localized navigation](https://generaltranslation.com/docs/react/nextjs/link): Navigate directly to localized routes in Next.js with General Translation's locale-aware Link component. API reference for Link. +- [getGT](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-gt): Translate standalone strings in asynchronous Next.js App Router components with General Translation. API reference for getGT. +- [getTranslations](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-translations): Read dictionary translations in asynchronous Next.js App Router components with General Translation. API reference for getTranslations. +- [getMessages](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-messages): Resolve encoded messages in asynchronous Next.js App Router components with General Translation. API reference for getMessages. +- [getLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-locale): Read the current Next.js App Router request locale with General Translation. API reference for getLocale. +- [getLocaleDirection](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-locale-direction): Read the text direction for a Next.js App Router locale with General Translation. API reference for getLocaleDirection. +- [getRegion](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-region): Read the current Next.js App Router request region with General Translation. API reference for getRegion. +- [registerLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/register-locale): Register a locale for Next.js App Router server code with General Translation. API reference for registerLocale. +- [resolveCanonicalLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/resolve-canonical-locale): Resolve a configured locale alias in Next.js App Router server code with General Translation. API reference for resolveCanonicalLocale. +- [tx](https://generaltranslation.com/docs/react/nextjs/reference/functions/tx): Translate request-time strings in Next.js App Router server code with General Translation. API reference for tx. +- [createNextMiddleware](https://generaltranslation.com/docs/react/nextjs/reference/functions/create-next-middleware): Add locale routing and detection to a Next.js app with General Translation. API reference for createNextMiddleware. +- [Tx](https://generaltranslation.com/docs/react/nextjs/reference/components/tx): Translate request-time JSX in Next.js App Router server components with General Translation. API reference for Tx. +- [React Native](https://generaltranslation.com/docs/react/react-native): Explore the React Native-specific setup for General Translation, including module-level initialization, the provider, and the polyfill plugin. +- [Set up React Native](https://generaltranslation.com/docs/react/react-native/setup): Initialize General Translation in a React Native app, add the provider, and load translations, for both Expo and the bare React Native CLI. +- [Plugin](https://generaltranslation.com/docs/react/react-native/plugin): Reference for the General Translation gt-react-native Babel plugin, which injects the Intl polyfills React Native needs. API reference for the gt-react-native plugin. +- [TanStack Start](https://generaltranslation.com/docs/react/tanstack-start): Explore the TanStack Start-specific setup for General Translation, including root-route initialization, locale resolution, and provider hydration. +- [Set up TanStack Start](https://generaltranslation.com/docs/react/tanstack-start/setup): Initialize General Translation in a TanStack Start app, resolve the locale, and hydrate the provider from the root route. + +## Node + +- [Quickstart](https://generaltranslation.com/docs/node/quickstart): Install the General Translation gt-node library and translate your first Node.js service. +- [Configuring gt-node](https://generaltranslation.com/docs/node/guides/configuring): How to initialize General Translation gt-node: this guide covers locales, credentials, and translation delivery. +- [Translating strings](https://generaltranslation.com/docs/node/guides/translating-strings): How to translate handler strings, registered messages, and dynamic content with General Translation in gt-node. +- [Detecting the request locale](https://generaltranslation.com/docs/node/guides/detecting-locale): How to resolve and bind a locale for each request with General Translation in gt-node. +- [Storing translations locally](https://generaltranslation.com/docs/node/guides/storing-translations): How to load General Translation translations from local files instead of the CDN in gt-node. +- [Configuration](https://generaltranslation.com/docs/node/reference/config): Configure the General Translation gt-node library with initializeGT. API reference for gt-node configuration. +- [initializeGT](https://generaltranslation.com/docs/node/reference/functions/initialize-gt): Configure the General Translation gt-node library once at server startup. API reference for initializeGT. +- [withGT](https://generaltranslation.com/docs/node/reference/functions/with-gt): Bind a locale for the duration of a request so General Translation functions resolve against it. API reference for withGT. +- [getRequestLocale](https://generaltranslation.com/docs/node/reference/functions/get-request-locale): Detect the best supported locale from a request's Accept-Language header with General Translation. API reference for getRequestLocale. +- [getGT](https://generaltranslation.com/docs/node/reference/functions/get-gt): Get a General Translation function for the current request locale to translate inline strings. API reference for getGT. +- [getMessages](https://generaltranslation.com/docs/node/reference/functions/get-messages): Get a General Translation resolver for messages registered with msg for the current request locale. API reference for getMessages. +- [getTranslations](https://generaltranslation.com/docs/node/reference/functions/get-translations): Get a General Translation dictionary resolver for the current request locale. API reference for getTranslations. +- [tx](https://generaltranslation.com/docs/node/reference/functions/tx): Translate a string on demand at runtime with General Translation. API reference for tx. +- [msg](https://generaltranslation.com/docs/node/reference/functions/msg): Mark and encode a string at module scope for translation with General Translation. API reference for msg. +- [derive](https://generaltranslation.com/docs/node/reference/functions/derive): Mark computed content as derivable for General Translation extraction. API reference for derive. +- [declareVar](https://generaltranslation.com/docs/node/reference/functions/declare-var): Mark a value as non-derivable within a General Translation derive call. API reference for declareVar. +- [decodeMsg](https://generaltranslation.com/docs/node/reference/functions/decode-msg): Recover the original message string from a General Translation encoded message. API reference for decodeMsg. +- [decodeOptions](https://generaltranslation.com/docs/node/reference/functions/decode-options): Recover the encoded options from a General Translation encoded message. API reference for decodeOptions. +- [decodeVars](https://generaltranslation.com/docs/node/reference/functions/decode-vars): Interpolate General Translation declareVar variables back into a string. API reference for decodeVars. +- [getLocale](https://generaltranslation.com/docs/node/reference/functions/get-locale): Read the active locale for the current request in General Translation gt-node. API reference for getLocale. +- [getDefaultLocale](https://generaltranslation.com/docs/node/reference/functions/get-default-locale): Read the configured source locale in General Translation gt-node. API reference for getDefaultLocale. +- [getLocales](https://generaltranslation.com/docs/node/reference/functions/get-locales): List the supported locales configured in General Translation gt-node. API reference for getLocales. +- [getLocaleProperties](https://generaltranslation.com/docs/node/reference/functions/get-locale-properties): Read display metadata for a locale in General Translation gt-node. API reference for getLocaleProperties. +- [getVersionId](https://generaltranslation.com/docs/node/reference/functions/get-version-id): Read the configured translation version ID in General Translation gt-node. API reference for getVersionId. + +## Python + +- [Quickstart](https://generaltranslation.com/docs/python/quickstart): Install the General Translation Python SDK and translate your first Flask or FastAPI app. +- [Configuring General Translation](https://generaltranslation.com/docs/python/guides/configuring): How to initialize General Translation in Python: this guide covers your app, locales, and translation delivery in Flask, FastAPI, or the core library. +- [Translating strings](https://generaltranslation.com/docs/python/guides/translating-strings): How to translate strings with variables, context, and options using the General Translation t and msg functions in Python. +- [Detecting the request locale](https://generaltranslation.com/docs/python/guides/detecting-locale): How to resolve each request's locale automatically or with your own logic in General Translation for Python. +- [Storing translations locally](https://generaltranslation.com/docs/python/guides/storing-translations): How to load General Translation translations from local files instead of the CDN in Python. +- [Declaring variables and variants](https://generaltranslation.com/docs/python/guides/declaring-variables): How to preserve dynamic values and generate finite variants with General Translation declare_var, derive, and decode_vars in Python. +- [Configuration](https://generaltranslation.com/docs/python/reference/config): Configure the General Translation Python SDK through the gt.config.json file. API reference for gt.config.json. +- [initialize_gt](https://generaltranslation.com/docs/python/reference/functions/initialize-gt): Configure the General Translation Python SDK once for a Flask or FastAPI app. API reference for initialize_gt. +- [t](https://generaltranslation.com/docs/python/reference/functions/t): Translate and interpolate an ICU MessageFormat string with General Translation in Python. API reference for t. +- [t_fallback](https://generaltranslation.com/docs/python/reference/functions/t-fallback): Interpolate a string without a translation lookup in General Translation Python. API reference for t_fallback. +- [msg](https://generaltranslation.com/docs/python/reference/functions/msg): Register a message with its translation options as an encoded string in General Translation Python. API reference for msg. +- [m_fallback](https://generaltranslation.com/docs/python/reference/functions/m-fallback): Resolve an encoded message from msg, or interpolate a plain string, in General Translation Python. API reference for m_fallback. +- [interpolate_message](https://generaltranslation.com/docs/python/reference/functions/interpolate-message): Interpolate variables into an ICU MessageFormat string in General Translation Python. API reference for interpolate_message. +- [hash_message](https://generaltranslation.com/docs/python/reference/functions/hash-message): Hash an ICU MessageFormat string for translation lookup in General Translation Python. API reference for hash_message. +- [extract_variables](https://generaltranslation.com/docs/python/reference/functions/extract-variables): Filter reserved GT keys from an options dict to get user variables in General Translation Python. API reference for extract_variables. +- [decode_msg](https://generaltranslation.com/docs/python/reference/functions/decode-msg): Extract the human-readable message from an encoded msg result in General Translation Python. API reference for decode_msg. +- [decode_options](https://generaltranslation.com/docs/python/reference/functions/decode-options): Extract the options dict from an encoded msg result in General Translation Python. API reference for decode_options. +- [declare_var](https://generaltranslation.com/docs/python/reference/functions/declare-var): Mark a dynamic value as a non-translatable variable in General Translation Python. API reference for declare_var. +- [derive](https://generaltranslation.com/docs/python/reference/functions/derive): Mark content with a finite set of variants for build-time extraction in General Translation Python. API reference for derive. +- [declare_static](https://generaltranslation.com/docs/python/reference/functions/declare-static): Deprecated alias for derive that marks content for build-time extraction in General Translation Python. API reference for declare_static. +- [decode_vars](https://generaltranslation.com/docs/python/reference/functions/decode-vars): Replace General Translation variable markers in a string with their values in Python. API reference for decode_vars. +- [get_locale](https://generaltranslation.com/docs/python/reference/functions/get-locale): Read the active locale for the current request in General Translation Python. API reference for get_locale. +- [get_locales](https://generaltranslation.com/docs/python/reference/functions/get-locales): List the supported locales configured in General Translation Python. API reference for get_locales. +- [get_default_locale](https://generaltranslation.com/docs/python/reference/functions/get-default-locale): Read the configured source locale in General Translation Python. API reference for get_default_locale. +- [get_version_id](https://generaltranslation.com/docs/python/reference/functions/get-version-id): Read the pinned translation version id in General Translation Python. API reference for get_version_id. +- [get_i18n_manager](https://generaltranslation.com/docs/python/reference/functions/get-i18n-manager): Access the active I18nManager in General Translation Python. API reference for get_i18n_manager. +- [set_i18n_manager](https://generaltranslation.com/docs/python/reference/functions/set-i18n-manager): Register the active I18nManager in General Translation Python. API reference for set_i18n_manager. +- [I18nManager](https://generaltranslation.com/docs/python/reference/classes/i18n-manager): The central orchestrator for locales, translation loading, and caching in General Translation Python. API reference for I18nManager. +- [StorageAdapter](https://generaltranslation.com/docs/python/reference/classes/storage-adapter): Abstract base class for per-request locale storage in General Translation Python. API reference for StorageAdapter. +- [ContextVarStorageAdapter](https://generaltranslation.com/docs/python/reference/classes/context-var-storage-adapter): Default context-variable storage adapter for the request locale in General Translation Python. API reference for ContextVarStorageAdapter. +- [TranslationsLoader](https://generaltranslation.com/docs/python/reference/classes/translations-loader): The callable type for custom translation loaders in General Translation Python. API reference for TranslationsLoader. + +## Integrations + +- [Integrations](https://generaltranslation.com/docs/integrations): Use General Translation with third-party content platforms and plugins. +- [Quickstart](https://generaltranslation.com/docs/integrations/mintlify/quickstart): Quickstart to translate a Mintlify documentation site with General Translation. +- [Configuring Mintlify](https://generaltranslation.com/docs/integrations/mintlify/guides/configuring-mintlify): How to connect a Mintlify documentation repository to General Translation: this guide covers choosing languages and setting how translations run. +- [Translating content](https://generaltranslation.com/docs/integrations/mintlify/guides/translating-content): How to translate your Mintlify documentation with General Translation: this guide covers what Locadex translates and preserves. +- [Using translated content](https://generaltranslation.com/docs/integrations/mintlify/guides/using-translated-content): How does General Translation set up multi-language navigation, routing, and redirects in your Mintlify docs? +- [Managing translations](https://generaltranslation.com/docs/integrations/mintlify/guides/managing-translations): How to add or remove languages, keep Mintlify translations current, and edit generated translations with General Translation. +- [Configuration](https://generaltranslation.com/docs/integrations/mintlify/reference/config): Reference for the gt.config.json General Translation generates for a Mintlify project. Reference for the Mintlify integration configuration. +- [Locales](https://generaltranslation.com/docs/integrations/mintlify/reference/locales): Reference for the language codes Mintlify supports and how General Translation locales map onto them. Reference for Mintlify locale handling. +- [Supported content](https://generaltranslation.com/docs/integrations/mintlify/reference/supported-content): Reference for the files and content General Translation translates in a Mintlify project. Reference for Mintlify supported content. +- [Quickstart](https://generaltranslation.com/docs/integrations/sanity/quickstart): Install gt-sanity, add the General Translation plugin to Sanity Studio, and translate your first document. +- [Configuring Sanity](https://generaltranslation.com/docs/integrations/sanity/guides/configuring-sanity): How to configure the General Translation gt-sanity plugin: this guide covers locales, document filters, field-level localization, credentials, language fields, and singletons. +- [Translating content](https://generaltranslation.com/docs/integrations/sanity/guides/translating-content): How to translate Sanity documents with General Translation from the document action, the tab view, or the Translations page. +- [Managing translations](https://generaltranslation.com/docs/integrations/sanity/guides/managing-translations): How to manage General Translation Sanity translations: this guide covers imports, reference patching, bulk publishing, and field behavior. +- [Querying translations](https://generaltranslation.com/docs/integrations/sanity/guides/querying-translations): How to query translated Sanity documents with GROQ using the General Translation document-level localization model. +- [Sanity plugin configuration](https://generaltranslation.com/docs/integrations/sanity/reference/plugin-configuration): Configure the General Translation gt-sanity plugin for Sanity Studio. API reference for gtPlugin. +- [Quickstart](https://generaltranslation.com/docs/integrations/storyblok/quickstart): Quickstart to connect a Storyblok space to General Translation and translate your first story from the Dashboard. +- [Configuring Storyblok](https://generaltranslation.com/docs/integrations/storyblok/guides/configuring-storyblok): How to connect a Storyblok space to General Translation: this guide covers adding credentials and enabling translatable fields. +- [Translating content](https://generaltranslation.com/docs/integrations/storyblok/guides/translating-content): How to translate Storyblok stories from the General Translation Dashboard and review the results summary. +- [Managing translations](https://generaltranslation.com/docs/integrations/storyblok/guides/managing-translations): How to re-sync Storyblok stories with General Translation: this guide covers reusing existing translations and reviewing draft-only writes. +- [Using translated content](https://generaltranslation.com/docs/integrations/storyblok/guides/using-translated-content): How does General Translation store Storyblok translations per language, and how do you fetch them from the delivery API? +- [Connection settings](https://generaltranslation.com/docs/integrations/storyblok/reference/connection): Reference for the settings used to connect a Storyblok space to General Translation. API reference for the Storyblok connection settings. +- [Supported content](https://generaltranslation.com/docs/integrations/storyblok/reference/supported-content): Reference for the Storyblok field types General Translation translates and how content is serialized. API reference for Storyblok supported content. +- [Locales](https://generaltranslation.com/docs/integrations/storyblok/reference/locales): Reference for how Storyblok space languages map to General Translation locales. API reference for Storyblok locale handling. diff --git a/sitemap.md b/sitemap.md new file mode 100644 index 000000000..a3678fcd0 --- /dev/null +++ b/sitemap.md @@ -0,0 +1,392 @@ +# General Translation docs + +> General Translation is a full-stack localization platform: open-source i18n libraries, a CLI, and a translation API, Dashboard, and AI agent for translating apps and content into any language. + +## Overview + +- [Introduction](https://generaltranslation.com/docs/overview/get-started) +- [Key concepts](https://generaltranslation.com/docs/overview/key-concepts) +- [Using coding agents](https://generaltranslation.com/docs/overview/for-coding-agents) + +## [Platform](https://generaltranslation.com/docs/platform) + +- **Dashboard** + - [Get started with the Dashboard](https://generaltranslation.com/docs/platform/dashboard/get-started) + - **Guides** + - [Adding translation context](https://generaltranslation.com/docs/platform/dashboard/guides/adding-translation-context) + - [Reviewing and editing translations](https://generaltranslation.com/docs/platform/dashboard/guides/reviewing-translations) + - [Adding annotations](https://generaltranslation.com/docs/platform/dashboard/guides/adding-annotations) + - [Managing billing](https://generaltranslation.com/docs/platform/dashboard/guides/managing-billing) + - **Reference** + - [API keys](https://generaltranslation.com/docs/platform/dashboard/reference/api-keys) + - [API reference](https://generaltranslation.com/docs/platform/dashboard/reference/api-reference) + - [Webhooks](https://generaltranslation.com/docs/platform/dashboard/reference/webhooks) + - [Organization settings](https://generaltranslation.com/docs/platform/dashboard/reference/organization-settings) + - [Roles and permissions](https://generaltranslation.com/docs/platform/dashboard/reference/roles-and-permissions) + - [Project settings](https://generaltranslation.com/docs/platform/dashboard/reference/project-settings) + - [Supported locales](https://generaltranslation.com/docs/platform/dashboard/reference/supported-locales) +- **Locadex** + - [Quickstart](https://generaltranslation.com/docs/platform/locadex/quickstart) + - **Guides** + - [Configuring Locadex workflows](https://generaltranslation.com/docs/platform/locadex/guides/configuring-workflows) + - [Using Locadex in a monorepo](https://generaltranslation.com/docs/platform/locadex/guides/using-in-monorepos) + - [Auto-merging Locadex PRs](https://generaltranslation.com/docs/platform/locadex/guides/auto-merging-prs) + - [Managing languages](https://generaltranslation.com/docs/platform/locadex/guides/managing-languages) + - [Adding environment variables](https://generaltranslation.com/docs/platform/locadex/guides/adding-environment-variables) + - [Viewing workflow history](https://generaltranslation.com/docs/platform/locadex/guides/viewing-workflow-history) + - **Reference** + - [Agent page](https://generaltranslation.com/docs/platform/locadex/reference/agent) + - [Configuration](https://generaltranslation.com/docs/platform/locadex/reference/config) + - [VM image](https://generaltranslation.com/docs/platform/locadex/reference/vm-image) +- **Core** + - [Quickstart](https://generaltranslation.com/docs/platform/core/quickstart) + - **Guides** + - [Understanding locale codes](https://generaltranslation.com/docs/platform/core/guides/locale-codes) + - [Translating strings](https://generaltranslation.com/docs/platform/core/guides/translating-strings) + - [Translating files](https://generaltranslation.com/docs/platform/core/guides/translating-files) + - **Reference** + - **GT Class** + - [Constructor](https://generaltranslation.com/docs/platform/core/reference/gt-class/constructor) + - [setConfig](https://generaltranslation.com/docs/platform/core/reference/gt-class/set-config) + - **GT Class Methods** + - **Translation** + - [translate](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/translate) + - [translateMany](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/translate-many) + - [uploadSourceFiles](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/upload-source-files) + - [uploadTranslations](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/upload-translations) + - [enqueueFiles](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/enqueue-files) + - [awaitJobs](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/await-jobs) + - [checkJobStatus](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/check-job-status) + - [queryFileData](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/query-file-data) + - [querySourceFile](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/query-source-file) + - [downloadFile](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/download-file) + - [downloadFileBatch](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/download-file-batch) + - [setupProject](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/setup-project) + - [getProjectData](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/get-project-data) + - [createTag](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/translation/create-tag) + - **Project** + - [Project and file management](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/project/project-management) + - **Formatting** + - [formatNum](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-num) + - [formatCurrency](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-currency) + - [formatDateTime](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-date-time) + - [formatRelativeTime](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time) + - [formatRelativeTimeFromDate](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-relative-time-from-date) + - [formatMessage](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-message) + - [formatList](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-list) + - [formatListToParts](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-list-to-parts) + - [formatCutoff](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/formatting/format-cutoff) + - **Locales** + - [determineLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/determine-locale) + - [getLocaleDirection](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-direction) + - [getLocaleEmoji](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-emoji) + - [getLocaleName](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-name) + - [getLocaleProperties](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-locale-properties) + - [getRegionProperties](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/get-region-properties) + - [isValidLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-valid-locale) + - [isSameLanguage](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-same-language) + - [isSameDialect](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-same-dialect) + - [isSupersetLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/is-superset-locale) + - [requiresTranslation](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/requires-translation) + - [standardizeLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/standardize-locale) + - [resolveAliasLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/resolve-alias-locale) + - [resolveCanonicalLocale](https://generaltranslation.com/docs/platform/core/reference/gt-class-methods/locales/resolve-canonical-locale) + - **Utility functions** + - **Formatting** + - [formatNum](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-num) + - [formatCurrency](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-currency) + - [formatDateTime](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-date-time) + - [formatRelativeTime](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-relative-time) + - [formatRelativeTimeFromDate](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-relative-time-from-date) + - [formatMessage](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-message) + - [formatList](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-list) + - [formatListToParts](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-list-to-parts) + - [formatCutoff](https://generaltranslation.com/docs/platform/core/reference/utility-functions/formatting/format-cutoff) + - **Locales** + - [determineLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/determine-locale) + - [getLocaleDirection](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-direction) + - [getLocaleEmoji](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-emoji) + - [getLocaleName](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-name) + - [getLocaleProperties](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-locale-properties) + - [getRegionProperties](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/get-region-properties) + - [isValidLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-valid-locale) + - [isSameLanguage](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-same-language) + - [isSameDialect](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-same-dialect) + - [isSupersetLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/is-superset-locale) + - [requiresTranslation](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/requires-translation) + - [standardizeLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/standardize-locale) + - [resolveAliasLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/resolve-alias-locale) + - [resolveCanonicalLocale](https://generaltranslation.com/docs/platform/core/reference/utility-functions/locales/resolve-canonical-locale) + - **Types** + - [Content](https://generaltranslation.com/docs/platform/core/reference/types/content) + - [CustomMapping](https://generaltranslation.com/docs/platform/core/reference/types/custom-mapping) + - [DataFormat](https://generaltranslation.com/docs/platform/core/reference/types/data-format) + - [EnqueueFilesOptions](https://generaltranslation.com/docs/platform/core/reference/types/enqueue-files-options) + - [EntryMetadata](https://generaltranslation.com/docs/platform/core/reference/types/entry-metadata) + - [TranslateManyEntry](https://generaltranslation.com/docs/platform/core/reference/types/translate-many-entry) + - [FileToTranslate](https://generaltranslation.com/docs/platform/core/reference/types/file-to-translate) + - [GTConstructorParams](https://generaltranslation.com/docs/platform/core/reference/types/gt-constructor-params) + - [JsxChildren](https://generaltranslation.com/docs/platform/core/reference/types/jsx-children) + - [JsxElement](https://generaltranslation.com/docs/platform/core/reference/types/jsx-element) + - [LocaleProperties](https://generaltranslation.com/docs/platform/core/reference/types/locale-properties) + - [TranslateManyResult](https://generaltranslation.com/docs/platform/core/reference/types/translate-many-result) + - [TranslationResult](https://generaltranslation.com/docs/platform/core/reference/types/translation-result) + - [Variable](https://generaltranslation.com/docs/platform/core/reference/types/variable) +- **OpenAPI** + - [Overview](https://generaltranslation.com/docs/platform/openapi/overview) + - **Reference** + - **Files** + - [Upload source files](https://generaltranslation.com/docs/platform/openapi/reference/files/upload-source) + - [Upload translations](https://generaltranslation.com/docs/platform/openapi/reference/files/upload-translations) + - [Submit file diffs](https://generaltranslation.com/docs/platform/openapi/reference/files/submit-diffs) + - [Download files](https://generaltranslation.com/docs/platform/openapi/reference/files/download-many) + - [Download file](https://generaltranslation.com/docs/platform/openapi/reference/files/download) + - [Publish files](https://generaltranslation.com/docs/platform/openapi/reference/files/publish-files) + - [Get file information](https://generaltranslation.com/docs/platform/openapi/reference/files/file-info) + - [Get translation status](https://generaltranslation.com/docs/platform/openapi/reference/files/translation-status) + - [Move files](https://generaltranslation.com/docs/platform/openapi/reference/files/move-files) + - [Get orphaned files](https://generaltranslation.com/docs/platform/openapi/reference/files/orphaned-files) + - **Context** + - [Generate context](https://generaltranslation.com/docs/platform/openapi/reference/context/generate-context) + - [Check context freshness](https://generaltranslation.com/docs/platform/openapi/reference/context/check-freshness) + - [Get context generation status](https://generaltranslation.com/docs/platform/openapi/reference/context/context-status) + - **Translation** + - [Translate at runtime](https://generaltranslation.com/docs/platform/openapi/reference/translation/translate-runtime) + - [Queue translations](https://generaltranslation.com/docs/platform/openapi/reference/translation/queue) + - [Get translation job status](https://generaltranslation.com/docs/platform/openapi/reference/translation/job-status) + - **Project** + - [Get Project info](https://generaltranslation.com/docs/platform/openapi/reference/project/project-info) + - [Update Project info](https://generaltranslation.com/docs/platform/openapi/reference/project/update-project) + - [Get branch info](https://generaltranslation.com/docs/platform/openapi/reference/project/branch-info) + - [Create a branch](https://generaltranslation.com/docs/platform/openapi/reference/project/create-branch) + - [Create or update tag](https://generaltranslation.com/docs/platform/openapi/reference/project/upsert-tag) + +## CLI + +- [Quickstart](https://generaltranslation.com/docs/cli/quickstart) +- **Guides** + - [Configuring the CLI](https://generaltranslation.com/docs/cli/guides/configuring) + - [Generating translations](https://generaltranslation.com/docs/cli/guides/generating-translations) + - [Managing translations](https://generaltranslation.com/docs/cli/guides/managing-translations) + - [Tracking translations by branch](https://generaltranslation.com/docs/cli/guides/branching) + - [Using auto-derived translations](https://generaltranslation.com/docs/cli/guides/using-autoderive) + - [Using automatic JSX injection](https://generaltranslation.com/docs/cli/guides/using-auto-jsx) +- **Reference** + - [Configuration](https://generaltranslation.com/docs/cli/reference/config) + - [Keyed metadata](https://generaltranslation.com/docs/cli/reference/keyed-metadata) + - **Commands** + - [gt init](https://generaltranslation.com/docs/cli/reference/commands/init) + - [gt setup](https://generaltranslation.com/docs/cli/reference/commands/setup) + - [gt configure](https://generaltranslation.com/docs/cli/reference/commands/configure) + - [gt auth](https://generaltranslation.com/docs/cli/reference/commands/auth) + - [gt translate](https://generaltranslation.com/docs/cli/reference/commands/translate) + - [gt stage](https://generaltranslation.com/docs/cli/reference/commands/stage) + - [gt enqueue](https://generaltranslation.com/docs/cli/reference/commands/enqueue) + - [gt download](https://generaltranslation.com/docs/cli/reference/commands/download) + - [gt upload](https://generaltranslation.com/docs/cli/reference/commands/upload) + - [gt save-local](https://generaltranslation.com/docs/cli/reference/commands/save-local) + - [gt generate](https://generaltranslation.com/docs/cli/reference/commands/generate) + - [gt validate](https://generaltranslation.com/docs/cli/reference/commands/validate) + - **File formats** + - [GT](https://generaltranslation.com/docs/cli/reference/formats/gt-jsx-files) + - [JSON](https://generaltranslation.com/docs/cli/reference/formats/json-files) + - [PO / POT](https://generaltranslation.com/docs/cli/reference/formats/po-pot-files) + - [MDX and Markdown](https://generaltranslation.com/docs/cli/reference/formats/mdx-md-files) + - [TypeScript and JavaScript](https://generaltranslation.com/docs/cli/reference/formats/ts-js-files) + - [YAML](https://generaltranslation.com/docs/cli/reference/formats/yaml-files) + - [HTML](https://generaltranslation.com/docs/cli/reference/formats/html-files) + - [Plain text](https://generaltranslation.com/docs/cli/reference/formats/plain-text-files) + +## React + +- [Overview](https://generaltranslation.com/docs/react/overview) +- [React Quickstart](https://generaltranslation.com/docs/react/react-quickstart) +- [React SPA Quickstart](https://generaltranslation.com/docs/react/react-spa-quickstart) +- [Next.js App Router Quickstart](https://generaltranslation.com/docs/react/nextjs-quickstart) +- [Next.js Pages Router Quickstart](https://generaltranslation.com/docs/react/nextjs-pages-router-quickstart) +- [TanStack Start Quickstart](https://generaltranslation.com/docs/react/tanstack-start-quickstart) +- [React Native Quickstart](https://generaltranslation.com/docs/react/react-native-quickstart) +- **Guides** + - [Configuring General Translation](https://generaltranslation.com/docs/react/guides/configuring) + - [Developing with SPA translations](https://generaltranslation.com/docs/react/guides/developing-spa-translations) + - [Translating JSX](https://generaltranslation.com/docs/react/guides/translating-jsx) + - [Translating strings](https://generaltranslation.com/docs/react/guides/translating-strings) + - [Formatting numbers and dates](https://generaltranslation.com/docs/react/guides/formatting-variables) + - [Handling plurals and branches](https://generaltranslation.com/docs/react/guides/handling-plurals-and-branches) + - [Managing locales](https://generaltranslation.com/docs/react/guides/managing-locales) + - [Translating with dictionaries](https://generaltranslation.com/docs/react/guides/translating-with-dictionaries) + - [Storing translations locally](https://generaltranslation.com/docs/react/guides/storing-translations) + - [Linting your code](https://generaltranslation.com/docs/react/guides/linting-your-code) +- **Reference** + - [Configuration](https://generaltranslation.com/docs/react/reference/config) + - **Components** + - [GTProvider](https://generaltranslation.com/docs/react/reference/components/gt-provider) + - [T](https://generaltranslation.com/docs/react/reference/components/t) + - [Var](https://generaltranslation.com/docs/react/reference/components/var) + - [Num](https://generaltranslation.com/docs/react/reference/components/num) + - [Currency](https://generaltranslation.com/docs/react/reference/components/currency) + - [DateTime](https://generaltranslation.com/docs/react/reference/components/datetime) + - [RelativeTime](https://generaltranslation.com/docs/react/reference/components/relative-time) + - [Plural](https://generaltranslation.com/docs/react/reference/components/plural) + - [Branch](https://generaltranslation.com/docs/react/reference/components/branch) + - [Derive](https://generaltranslation.com/docs/react/reference/components/derive) + - [LocaleSelector](https://generaltranslation.com/docs/react/reference/components/locale-selector) + - [RegionSelector](https://generaltranslation.com/docs/react/reference/components/region-selector) + - **Hooks** + - [useGT](https://generaltranslation.com/docs/react/reference/hooks/use-gt) + - [useTranslations](https://generaltranslation.com/docs/react/reference/hooks/use-translations) + - [useMessages](https://generaltranslation.com/docs/react/reference/hooks/use-messages) + - [useLocale](https://generaltranslation.com/docs/react/reference/hooks/use-locale) + - [useSetLocale](https://generaltranslation.com/docs/react/reference/hooks/use-set-locale) + - [useDefaultLocale](https://generaltranslation.com/docs/react/reference/hooks/use-default-locale) + - [useLocales](https://generaltranslation.com/docs/react/reference/hooks/use-locales) + - [useLocaleProperties](https://generaltranslation.com/docs/react/reference/hooks/use-locale-properties) + - [useLocaleDirection](https://generaltranslation.com/docs/react/reference/hooks/use-locale-direction) + - [useLocaleSelector](https://generaltranslation.com/docs/react/reference/hooks/use-locale-selector) + - [useRegion](https://generaltranslation.com/docs/react/reference/hooks/use-region) + - [useSetRegion](https://generaltranslation.com/docs/react/reference/hooks/use-set-region) + - [useRegionSelector](https://generaltranslation.com/docs/react/reference/hooks/use-region-selector) + - **Functions** + - [msg](https://generaltranslation.com/docs/react/reference/functions/msg) + - [t](https://generaltranslation.com/docs/react/reference/functions/t-function) + - [declareVar](https://generaltranslation.com/docs/react/reference/functions/declare-var) + - [decodeVars](https://generaltranslation.com/docs/react/reference/functions/decode-vars) + - [derive](https://generaltranslation.com/docs/react/reference/functions/derive) + - [getTranslationsSnapshot](https://generaltranslation.com/docs/react/reference/functions/get-translations-snapshot) + - [loadTranslations](https://generaltranslation.com/docs/react/reference/functions/load-translations) + - [loadDictionary](https://generaltranslation.com/docs/react/reference/functions/load-dictionary) + - **Types** + - [InlineTranslationOptions](https://generaltranslation.com/docs/react/reference/types/inline-translation-options) + - [DictionaryTranslationOptions](https://generaltranslation.com/docs/react/reference/types/dictionary-translation-options) + - [Lint rules](https://generaltranslation.com/docs/react/reference/lint-rules) +- **Frameworks** + - [Next.js](https://generaltranslation.com/docs/react/nextjs) + - [Server components](https://generaltranslation.com/docs/react/nextjs/server-components) + - [Configuration](https://generaltranslation.com/docs/react/nextjs/config) + - [App Router middleware](https://generaltranslation.com/docs/react/nextjs/app-router-middleware) + - [Registering request locales](https://generaltranslation.com/docs/react/nextjs/registering-request-locales) + - [Pages Router middleware](https://generaltranslation.com/docs/react/nextjs/pages-router-middleware) + - [App Router static site generation](https://generaltranslation.com/docs/react/nextjs/app-router-static-site-generation) + - [Pages Router static site generation](https://generaltranslation.com/docs/react/nextjs/pages-router-static-site-generation) + - [Localized navigation](https://generaltranslation.com/docs/react/nextjs/link) + - **reference** + - **functions** + - [getGT](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-gt) + - [getTranslations](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-translations) + - [getMessages](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-messages) + - [getLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-locale) + - [getLocaleDirection](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-locale-direction) + - [getRegion](https://generaltranslation.com/docs/react/nextjs/reference/functions/get-region) + - [registerLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/register-locale) + - [resolveCanonicalLocale](https://generaltranslation.com/docs/react/nextjs/reference/functions/resolve-canonical-locale) + - [tx](https://generaltranslation.com/docs/react/nextjs/reference/functions/tx) + - [createNextMiddleware](https://generaltranslation.com/docs/react/nextjs/reference/functions/create-next-middleware) + - **components** + - [Tx](https://generaltranslation.com/docs/react/nextjs/reference/components/tx) + - [React Native](https://generaltranslation.com/docs/react/react-native) + - [Set up React Native](https://generaltranslation.com/docs/react/react-native/setup) + - [Plugin](https://generaltranslation.com/docs/react/react-native/plugin) + - [TanStack Start](https://generaltranslation.com/docs/react/tanstack-start) + - [Set up TanStack Start](https://generaltranslation.com/docs/react/tanstack-start/setup) + +## Node + +- [Quickstart](https://generaltranslation.com/docs/node/quickstart) +- **Guides** + - [Configuring gt-node](https://generaltranslation.com/docs/node/guides/configuring) + - [Translating strings](https://generaltranslation.com/docs/node/guides/translating-strings) + - [Detecting the request locale](https://generaltranslation.com/docs/node/guides/detecting-locale) + - [Storing translations locally](https://generaltranslation.com/docs/node/guides/storing-translations) +- **Reference** + - [Configuration](https://generaltranslation.com/docs/node/reference/config) + - **Functions** + - [initializeGT](https://generaltranslation.com/docs/node/reference/functions/initialize-gt) + - [withGT](https://generaltranslation.com/docs/node/reference/functions/with-gt) + - [getRequestLocale](https://generaltranslation.com/docs/node/reference/functions/get-request-locale) + - [getGT](https://generaltranslation.com/docs/node/reference/functions/get-gt) + - [getMessages](https://generaltranslation.com/docs/node/reference/functions/get-messages) + - [getTranslations](https://generaltranslation.com/docs/node/reference/functions/get-translations) + - [tx](https://generaltranslation.com/docs/node/reference/functions/tx) + - [msg](https://generaltranslation.com/docs/node/reference/functions/msg) + - [derive](https://generaltranslation.com/docs/node/reference/functions/derive) + - [declareVar](https://generaltranslation.com/docs/node/reference/functions/declare-var) + - [decodeMsg](https://generaltranslation.com/docs/node/reference/functions/decode-msg) + - [decodeOptions](https://generaltranslation.com/docs/node/reference/functions/decode-options) + - [decodeVars](https://generaltranslation.com/docs/node/reference/functions/decode-vars) + - [getLocale](https://generaltranslation.com/docs/node/reference/functions/get-locale) + - [getDefaultLocale](https://generaltranslation.com/docs/node/reference/functions/get-default-locale) + - [getLocales](https://generaltranslation.com/docs/node/reference/functions/get-locales) + - [getLocaleProperties](https://generaltranslation.com/docs/node/reference/functions/get-locale-properties) + - [getVersionId](https://generaltranslation.com/docs/node/reference/functions/get-version-id) + +## Python + +- [Quickstart](https://generaltranslation.com/docs/python/quickstart) +- **Guides** + - [Configuring General Translation](https://generaltranslation.com/docs/python/guides/configuring) + - [Translating strings](https://generaltranslation.com/docs/python/guides/translating-strings) + - [Detecting the request locale](https://generaltranslation.com/docs/python/guides/detecting-locale) + - [Storing translations locally](https://generaltranslation.com/docs/python/guides/storing-translations) + - [Declaring variables and variants](https://generaltranslation.com/docs/python/guides/declaring-variables) +- **Reference** + - [Configuration](https://generaltranslation.com/docs/python/reference/config) + - **Functions** + - [initialize_gt](https://generaltranslation.com/docs/python/reference/functions/initialize-gt) + - [t](https://generaltranslation.com/docs/python/reference/functions/t) + - [t_fallback](https://generaltranslation.com/docs/python/reference/functions/t-fallback) + - [msg](https://generaltranslation.com/docs/python/reference/functions/msg) + - [m_fallback](https://generaltranslation.com/docs/python/reference/functions/m-fallback) + - [interpolate_message](https://generaltranslation.com/docs/python/reference/functions/interpolate-message) + - [hash_message](https://generaltranslation.com/docs/python/reference/functions/hash-message) + - [extract_variables](https://generaltranslation.com/docs/python/reference/functions/extract-variables) + - [decode_msg](https://generaltranslation.com/docs/python/reference/functions/decode-msg) + - [decode_options](https://generaltranslation.com/docs/python/reference/functions/decode-options) + - [declare_var](https://generaltranslation.com/docs/python/reference/functions/declare-var) + - [derive](https://generaltranslation.com/docs/python/reference/functions/derive) + - [declare_static](https://generaltranslation.com/docs/python/reference/functions/declare-static) + - [decode_vars](https://generaltranslation.com/docs/python/reference/functions/decode-vars) + - [get_locale](https://generaltranslation.com/docs/python/reference/functions/get-locale) + - [get_locales](https://generaltranslation.com/docs/python/reference/functions/get-locales) + - [get_default_locale](https://generaltranslation.com/docs/python/reference/functions/get-default-locale) + - [get_version_id](https://generaltranslation.com/docs/python/reference/functions/get-version-id) + - [get_i18n_manager](https://generaltranslation.com/docs/python/reference/functions/get-i18n-manager) + - [set_i18n_manager](https://generaltranslation.com/docs/python/reference/functions/set-i18n-manager) + - **Classes** + - [I18nManager](https://generaltranslation.com/docs/python/reference/classes/i18n-manager) + - [StorageAdapter](https://generaltranslation.com/docs/python/reference/classes/storage-adapter) + - [ContextVarStorageAdapter](https://generaltranslation.com/docs/python/reference/classes/context-var-storage-adapter) + - [TranslationsLoader](https://generaltranslation.com/docs/python/reference/classes/translations-loader) + +## [Integrations](https://generaltranslation.com/docs/integrations) + +- **Mintlify** + - [Quickstart](https://generaltranslation.com/docs/integrations/mintlify/quickstart) + - **Guides** + - [Configuring Mintlify](https://generaltranslation.com/docs/integrations/mintlify/guides/configuring-mintlify) + - [Translating content](https://generaltranslation.com/docs/integrations/mintlify/guides/translating-content) + - [Using translated content](https://generaltranslation.com/docs/integrations/mintlify/guides/using-translated-content) + - [Managing translations](https://generaltranslation.com/docs/integrations/mintlify/guides/managing-translations) + - **Reference** + - [Configuration](https://generaltranslation.com/docs/integrations/mintlify/reference/config) + - [Locales](https://generaltranslation.com/docs/integrations/mintlify/reference/locales) + - [Supported content](https://generaltranslation.com/docs/integrations/mintlify/reference/supported-content) +- **Sanity** + - [Quickstart](https://generaltranslation.com/docs/integrations/sanity/quickstart) + - **Guides** + - [Configuring Sanity](https://generaltranslation.com/docs/integrations/sanity/guides/configuring-sanity) + - [Translating content](https://generaltranslation.com/docs/integrations/sanity/guides/translating-content) + - [Managing translations](https://generaltranslation.com/docs/integrations/sanity/guides/managing-translations) + - [Querying translations](https://generaltranslation.com/docs/integrations/sanity/guides/querying-translations) + - **Reference** + - [Sanity plugin configuration](https://generaltranslation.com/docs/integrations/sanity/reference/plugin-configuration) +- **Storyblok** + - [Quickstart](https://generaltranslation.com/docs/integrations/storyblok/quickstart) + - **Guides** + - [Configuring Storyblok](https://generaltranslation.com/docs/integrations/storyblok/guides/configuring-storyblok) + - [Translating content](https://generaltranslation.com/docs/integrations/storyblok/guides/translating-content) + - [Managing translations](https://generaltranslation.com/docs/integrations/storyblok/guides/managing-translations) + - [Using translated content](https://generaltranslation.com/docs/integrations/storyblok/guides/using-translated-content) + - **Reference** + - [Connection settings](https://generaltranslation.com/docs/integrations/storyblok/reference/connection) + - [Supported content](https://generaltranslation.com/docs/integrations/storyblok/reference/supported-content) + - [Locales](https://generaltranslation.com/docs/integrations/storyblok/reference/locales)