docs: translation module (#14271)

* docs: translation module

* fix link in JS SDK

* add translations user guides [WIP]

* updates

* fix broken link

* remove mentions of default locale

* change header

* updates

* updated user guides

* handle todos

* fix build error

* fix lint errors
This commit is contained in:
Shahed Nasser
2025-12-17 13:07:43 +02:00
committed by GitHub
parent 1743ed7f04
commit c1a5390fc6
133 changed files with 21304 additions and 1661 deletions
@@ -6419,6 +6419,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/user-guide/orders/edit",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Export Orders",
"path": "https://docs.medusajs.com/user-guide/orders/export",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -15970,6 +15978,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"type": "category",
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/store/locales",
"title": "Locales",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -16295,6 +16311,15 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "StoreCurrency",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/store/models/StoreLocale",
"title": "StoreLocale",
"description": "",
"children": []
}
]
}
@@ -17158,6 +17183,357 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "translation",
"title": "Translation Module",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation",
"title": "Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Concepts",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation/concepts",
"title": "Concepts",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation/storefront",
"title": "Translation in Storefront",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation/links-to-other-modules",
"title": "Link to Modules",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Storefront Guides",
"autogenerate_tags": "storefront+translation,-jsSdk",
"autogenerate_as_ref": true,
"sort_sidebar": "alphabetize",
"description": "Learn how to integrate the Translation Module's features into your storefront.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Storefront Localization",
"path": "https://docs.medusajs.com/resources/storefront-development/localization",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Admin User Guides",
"autogenerate_tags": "userGuide+translation",
"autogenerate_as_ref": true,
"sort_sidebar": "alphabetize",
"description": "Learn how to utilize and manage Translation features in the Medusa Admin dashboard.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Manage Store",
"path": "https://docs.medusajs.com/user-guide/settings/store",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Manage Translations",
"path": "https://docs.medusajs.com/user-guide/settings/translations",
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "References",
"description": "Find references for tools and resources related to the Translation Module, such as data models, methods, and more. These are useful for your customizations.",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation/workflows",
"title": "Workflows",
"hideChildren": true,
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/translation/js-sdk",
"title": "JS SDK",
"hideChildren": true,
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "translation-service-reference",
"title": "Main Service Reference",
"childSidebarTitle": "Translation Module's Main Service Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation",
"title": "Reference Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Methods",
"hasTitleStyling": true,
"autogenerate_path": "/references/translation/ITranslationModuleService/methods",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/createLocales",
"title": "createLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/createTranslations",
"title": "createTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/deleteLocales",
"title": "deleteLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/deleteTranslations",
"title": "deleteTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/listAndCountLocales",
"title": "listAndCountLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/listAndCountTranslations",
"title": "listAndCountTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/listLocales",
"title": "listLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/listTranslations",
"title": "listTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/restoreLocales",
"title": "restoreLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/restoreTranslations",
"title": "restoreTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/retrieveLocale",
"title": "retrieveLocale",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/retrieveTranslation",
"title": "retrieveTranslation",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/softDeleteLocales",
"title": "softDeleteLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/softDeleteTranslations",
"title": "softDeleteTranslations",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/updateLocales",
"title": "updateLocales",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/updateTranslations",
"title": "updateTranslations",
"description": "",
"children": []
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sidebar",
"sidebar_id": "translation-models-reference",
"title": "Data Models Reference",
"childSidebarTitle": "Translation Module Data Models Reference",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/models",
"title": "Reference Overview",
"children": []
},
{
"type": "separator"
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/translation_models/variables",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/models/Locale",
"title": "Locale",
"description": "",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/translation/models/Translation",
"title": "Translation",
"description": "",
"children": []
}
]
}
]
}
]
}
]
},
{
"loaded": true,
"isPathHref": true,