docs: update i18n docs

This commit is contained in:
Sam Potts
2026-07-13 08:22:39 +10:00
parent 5df77790bd
commit 4734c389f6
17 changed files with 135 additions and 89 deletions
+36 -21
View File
@@ -17,6 +17,11 @@ export const sidebar: Sidebar = [
},
],
},
{
sidebarLabel: 'Contributing',
devOnly: true,
contents: [{ slug: 'how-to/i18n-add-built-in-locale', sidebarLabel: 'Add a built-in locale' }],
},
{
sidebarLabel: 'Getting started',
// May change when we revisit this section's boundary with Concepts (#1105)
@@ -53,11 +58,15 @@ export const sidebar: Sidebar = [
{ slug: 'how-to/customize-skins' },
{ slug: 'how-to/build-your-own-component' },
{ slug: 'how-to/self-host-the-player', frameworks: ['html'] },
{ slug: 'how-to/i18n-register-locale', sidebarLabel: 'Register a locale' },
{ slug: 'how-to/i18n-override-translations', sidebarLabel: 'Override translations' },
{ slug: 'how-to/i18n-switch-locale', sidebarLabel: 'Switch locale' },
{ slug: 'how-to/i18n-ssr', sidebarLabel: 'SSR with locale' },
{ slug: 'how-to/i18n-add-built-in-locale', sidebarLabel: 'Add a built-in locale' },
{
sidebarLabel: 'Internationalization',
contents: [
{ slug: 'how-to/i18n-register-locale', sidebarLabel: 'Register a locale' },
{ slug: 'how-to/i18n-override-translations', sidebarLabel: 'Override translations' },
{ slug: 'how-to/i18n-switch-locale', sidebarLabel: 'Switch locale' },
{ slug: 'how-to/i18n-ssr', sidebarLabel: 'SSR with locale' },
],
},
],
},
{
@@ -161,22 +170,6 @@ export const sidebar: Sidebar = [
llmsDescription: 'API reference for feature modules that provide player capabilities and state.',
contents: [
{ slug: 'reference/create-selector' },
{ slug: 'reference/register-i18n', sidebarLabel: 'registerI18n' },
{ slug: 'reference/get-i18n-translations', sidebarLabel: 'getI18nTranslations' },
{ slug: 'reference/has-registered-i18n', sidebarLabel: 'hasRegisteredI18n' },
{ slug: 'reference/on-i18n-registry-change', sidebarLabel: 'onI18nRegistryChange' },
{ slug: 'reference/create-translator', sidebarLabel: 'createTranslator' },
{
sidebarLabel: 'Types',
defaultOpen: false,
contents: [
{ slug: 'reference/built-in-locale', sidebarLabel: 'BuiltInLocale' },
{ slug: 'reference/locale', sidebarLabel: 'Locale' },
{ slug: 'reference/translation-params', sidebarLabel: 'TranslationParams' },
{ slug: 'reference/translations', sidebarLabel: 'Translations' },
{ slug: 'reference/translator', sidebarLabel: 'Translator' },
],
},
{ slug: 'reference/feature-buffer' },
{ slug: 'reference/feature-controls' },
{ slug: 'reference/feature-error' },
@@ -196,4 +189,26 @@ export const sidebar: Sidebar = [
{ slug: 'reference/feature-volume' },
],
},
{
sidebarLabel: 'Internationalization',
llmsDescription: 'API reference for locale registration, translation helpers, and i18n types.',
contents: [
{ slug: 'reference/register-i18n', sidebarLabel: 'registerI18n' },
{ slug: 'reference/get-i18n-translations', sidebarLabel: 'getI18nTranslations' },
{ slug: 'reference/has-registered-i18n', sidebarLabel: 'hasRegisteredI18n' },
{ slug: 'reference/on-i18n-registry-change', sidebarLabel: 'onI18nRegistryChange' },
{ slug: 'reference/create-translator', sidebarLabel: 'createTranslator' },
{
sidebarLabel: 'Types',
defaultOpen: false,
contents: [
{ slug: 'reference/built-in-locale', sidebarLabel: 'BuiltInLocale' },
{ slug: 'reference/locale', sidebarLabel: 'Locale' },
{ slug: 'reference/translation-params', sidebarLabel: 'TranslationParams' },
{ slug: 'reference/translations', sidebarLabel: 'Translations' },
{ slug: 'reference/translator', sidebarLabel: 'Translator' },
],
},
],
},
];