docs: update doc name with i18next

aymericzip · Jul 10, 2024 · 44d96ce · 44d96ce
1 parent 6f0509f
commit 44d96ce
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 28 deletions.
diff --git a/apps/website/src/Routes.ts b/apps/website/src/Routes.ts
@@ -7,7 +7,7 @@ export enum PagesRoutes {
   Doc_Configuration = '/doc/concept/configuration',
   Doc_Interest = '/doc/concept/interest_of_intlayer',
   Doc_IntlayerEditor = '/doc/concept/intlayer_editor',
-  Doc_IntlayerWithI18n = '/doc/concept/intlayer_with_i18n',
+  Doc_IntlayerWithI18next = '/doc/concept/intlayer_with_i18next',
   Doc_ContentDeclaration_DeclareYourContent = '/doc/concept/content_declaration/declare_your_content',
   Doc_ContentDeclaration_Translation = '/doc/concept/content_declaration/translation',
   Doc_ContentDeclaration_Enumeration = '/doc/concept/content_declaration/enumeration',

diff --git a/...oc/concept/intlayer_with_i18n/metadata.ts → ...concept/intlayer_with_i18next/metadata.ts b/...oc/concept/intlayer_with_i18n/metadata.ts → ...concept/intlayer_with_i18next/metadata.ts
diff --git a/...]/doc/concept/intlayer_with_i18n/page.tsx → ...oc/concept/intlayer_with_i18next/page.tsx b/...]/doc/concept/intlayer_with_i18n/page.tsx → ...oc/concept/intlayer_with_i18next/page.tsx
@@ -19,8 +19,8 @@ const DynamicDocumentationRender = dynamic(
 
 const Page: NextPageIntlayer = ({ params: { locale } }) => (
   <PageLayout locale={locale} editorEnabled={false}>
-    <DocPageLayout activeSections={['concept', 'intlayer_with_i18n']}>
-      <DynamicDocumentationRender docName="intlayer_with_i18n" />
+    <DocPageLayout activeSections={['concept', 'intlayer_with_i18next']}>
+      <DynamicDocumentationRender docName="intlayer_with_i18next" />
     </DocPageLayout>
   </PageLayout>
 );

diff --git a/apps/website/src/app/[locale]/sitemap.ts b/apps/website/src/app/[locale]/sitemap.ts
@@ -196,14 +196,14 @@ const sitemap = (): MetadataRoute.Sitemap => [
     },
   },
   {
-    url: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18n}`,
+    url: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18next}`,
     lastModified: new Date(),
     changeFrequency: 'monthly',
     priority: 0.8,
     alternates: {
       languages: {
-        es: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18n}/es`,
-        fr: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18n}/fr`,
+        es: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18next}/es`,
+        fr: `${process.env.NEXT_PUBLIC_URL}${PagesRoutes.Doc_IntlayerWithI18next}/fr`,
       },
     },
   },

diff --git a/apps/website/src/components/DocPage/doc-page.content.ts b/apps/website/src/components/DocPage/doc-page.content.ts
@@ -128,13 +128,13 @@ export const navbarContent: DeclarationContent<NavbarContent> = {
           ],
         },
         {
-          key: 'intlayer_with_i18n',
+          key: 'intlayer_with_i18next',
           title: t({
-            fr: 'Intlayer avec i18n',
-            en: 'Intlayer with i18n',
-            es: 'Intlayer con i18n',
+            fr: 'Intlayer avec i18next',
+            en: 'Intlayer with i18next',
+            es: 'Intlayer con i18next',
           }),
-          url: PagesRoutes.Doc_IntlayerWithI18n,
+          url: PagesRoutes.Doc_IntlayerWithI18next,
         },
       ],
     },

diff --git a/docs/docs/intlayer_with_i18n_en.md → docs/docs/intlayer_with_i18next_en.md b/docs/docs/intlayer_with_i18n_en.md → docs/docs/intlayer_with_i18next_en.md
@@ -33,6 +33,9 @@ Intlayer facilitates the sharing of content declaration files across multiple ap
 
 ### Configuring Intlayer to Export i18next Dictionaries
 
+> Important Notes
+> The exportation of i18next dictionaries is currently in beta and does not ensure a 1: 1 compatibility with other frameworks. It is recommended to stick to a configuration based on Intlayer to minimize issues.
+
 To export i18next dictionaries, you need to configure Intlayer appropriately. Below is an example of how to set up Intlayer to export both Intlayer and i18next dictionaries.
 
 ```typescript
@@ -73,7 +76,3 @@ i18next
     )
   );
 ```
-
-## Important Notes
-
-The exportation of i18next dictionaries is currently in beta and does not ensure a 1:1 compatibility with other frameworks. It is recommended to stick to a configuration based on Intlayer to minimize issues.
diff --git a/docs/docs/intlayer_with_i18n_es.md → docs/docs/intlayer_with_i18next_es.md b/docs/docs/intlayer_with_i18n_es.md → docs/docs/intlayer_with_i18next_es.md
@@ -33,6 +33,9 @@ Intlayer facilita la compartición de archivos de declaración de contenido entr
 
 ### Configurar Intlayer para Exportar Diccionarios de i18next
 
+> Notas Importantes
+> La exportación de diccionarios de i18next está actualmente en beta y no garantiza una compatibilidad 1:1 con otros marcos. Se recomienda seguir una configuración basada en Intlayer para minimizar problemas.
+
 Para exportar diccionarios de i18next, necesitas configurar Intlayer adecuadamente. A continuación, se muestra un ejemplo de cómo configurar Intlayer para exportar tanto diccionarios de Intlayer como de i18next.
 
 ```typescript
@@ -73,7 +76,3 @@ i18next
     )
   );
 ```
-
-## Notas Importantes
-
-La exportación de diccionarios de i18next está actualmente en beta y no garantiza una compatibilidad 1:1 con otros marcos. Se recomienda seguir una configuración basada en Intlayer para minimizar problemas.
diff --git a/docs/docs/intlayer_with_i18n_fr.md → docs/docs/intlayer_with_i18next_fr.md b/docs/docs/intlayer_with_i18n_fr.md → docs/docs/intlayer_with_i18next_fr.md
@@ -33,6 +33,9 @@ Intlayer facilite le partage de fichiers de déclaration de contenu entre plusie
 
 ### Configuration d'Intlayer pour exporter des dictionnaires i18next
 
+> Remarques importantes
+> L'exportation des dictionnaires i18next est actuellement en version bêta et ne garantit pas une compatibilité 1:1 avec d'autres frameworks. Il est recommandé de s'en tenir à une configuration basée sur Intlayer pour minimiser les problèmes.
+
 Pour exporter des dictionnaires i18next, vous devez configurer Intlayer de manière appropriée. Voici un exemple de configuration d'Intlayer pour exporter à la fois des dictionnaires Intlayer et i18next.
 
 ```typescript
@@ -73,7 +76,3 @@ i18next
     )
   );
 ```
-
-## Remarques importantes
-
-L'exportation des dictionnaires i18next est actuellement en version bêta et ne garantit pas une compatibilité 1:1 avec d'autres frameworks. Il est recommandé de s'en tenir à une configuration basée sur Intlayer pour minimiser les problèmes.
diff --git a/docs/index.cjs b/docs/index.cjs
@@ -34,10 +34,10 @@ const docs = {
     fr: require('./docs/intlayer_with_create_react_app_fr.md'),
     es: require('./docs/intlayer_with_create_react_app_es.md'),
   },
-  intlayer_with_i18n: {
-    en: require('./docs/intlayer_with_i18n_en.md'),
-    fr: require('./docs/intlayer_with_i18n_fr.md'),
-    es: require('./docs/intlayer_with_i18n_es.md'),
+  intlayer_with_i18next: {
+    en: require('./docs/intlayer_with_i18next_en.md'),
+    fr: require('./docs/intlayer_with_i18next_fr.md'),
+    es: require('./docs/intlayer_with_i18next_es.md'),
   },
   intlayer_with_nextjs: {
     en: require('./docs/intlayer_with_nextjs_en.md'),

diff --git a/docs/index.d.ts b/docs/index.d.ts
@@ -7,7 +7,7 @@ declare module '@intlayer/docs' {
     intlayer_cli,
     intlayer_editor,
     intlayer_with_create_react_app,
-    intlayer_with_i18n,
+    intlayer_with_i18next,
     intlayer_with_nextjs,
     intlayer_with_vite_react,
     content_declaration__declaration_watching,