docs: ✏️ update docs

jsverse · Sep 20, 2024 · 4403694 · 4403694
1 parent 154f123
commit 4403694
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 17 deletions.
diff --git a/docs/docs/getting-started/installation.mdx b/docs/docs/getting-started/installation.mdx
@@ -8,6 +8,10 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+:::tip
+If you already have i18n implemented in your project and are considering migrating to Transloco, be sure to check out our Migration scripts.
+:::
+
 Install the library using Angular CLI:
 
 ```bash

diff --git a/docs/docs/migration/angular.mdx b/docs/docs/migration/angular.mdx
@@ -4,14 +4,18 @@ description: Angular Migration | Transloco Angular i18n
 ---
 
 :::info
-some manual changes might still be needed after the script ran.
+Some manual changes may still be required after the script has executed.
 :::
 
 The script will iterate over all your HTML files, build a translation file and will execute the replacements described below.
 
 ### Command
 
-`ng g @jsverse/transloco:migrate`
+```bash
+ng g @jsverse/transloco:migrate
+# On an nx workspace
+nx g @jsverse/transloco:migrate
+```
 
 ### The Translation file
 

diff --git a/docs/docs/migration/ngx.mdx b/docs/docs/migration/ngx.mdx
@@ -4,12 +4,16 @@ description: ngx-translate Migration | Transloco Angular i18n
 ---
 
 :::info
-some manual changes might still be needed after the script ran.
+Some manual changes may still be required after the script has executed.
 :::
 
 ### Command
 
-`ng g @jsverse/transloco:migrate`
+```bash
+ng g @jsverse/transloco:migrate
+# On an nx workspace
+nx g @jsverse/transloco:migrate
+```
 
 ## What will be done?
 

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -7,6 +7,11 @@ module.exports = {
         'getting-started/installation',
         'getting-started/angular-compatability',
         'getting-started/config-options',
+        {
+          type: 'category',
+          label: 'Migration',
+          items: ['migration/ngx', 'migration/angular'],
+        },
       ],
     },
     {
@@ -54,14 +59,6 @@ module.exports = {
       type: 'doc',
       id: 'hack',
     },
-    {
-      type: 'doc',
-      id: 'blog-posts',
-    },
-    {
-      type: 'doc',
-      id: 'faq',
-    },
     {
       type: 'category',
       label: 'Tools',
@@ -101,11 +98,6 @@ module.exports = {
         'schematics/component',
       ],
     },
-    {
-      type: 'category',
-      label: 'Migration',
-      items: ['migration/ngx', 'migration/angular'],
-    },
     {
       type: 'category',
       label: 'Recipes',
@@ -115,5 +107,13 @@ module.exports = {
         'recipes/google-translate-integration',
       ],
     },
+    {
+      type: 'doc',
+      id: 'blog-posts',
+    },
+    {
+      type: 'doc',
+      id: 'faq',
+    },
   ],
 };