[website] Split Toolpad documentation (#41316)

mui · Mar 15, 2024 · ba9baae · ba9baae
1 parent 2e7bb84
commit ba9baae
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 14 deletions.
diff --git a/docs/src/components/header/HeaderNavBar.tsx b/docs/src/components/header/HeaderNavBar.tsx
@@ -302,7 +302,7 @@ export default function HeaderNavBar() {
                         id={PRODUCT_IDS[4]}
                         href={ROUTES.productToolpad}
                         icon={<IconImage name="product-toolpad" />}
-                        name="MUI Toolpad"
+                        name="Toolpad"
                         chip={<Chip label="Beta" size="small" color="primary" variant="outlined" />}
                         description="Low-code admin builder."
                       />

diff --git a/docs/src/components/header/HeaderNavDropdown.tsx b/docs/src/components/header/HeaderNavDropdown.tsx
@@ -76,7 +76,7 @@ const PRODUCTS = [
     href: ROUTES.productDesignKits,
   },
   {
-    name: 'MUI Toolpad',
+    name: 'Toolpad',
     description: 'Low-code admin builder.',
     href: ROUTES.productToolpad,
     chip: 'Beta',
@@ -110,9 +110,9 @@ const DOCS = [
     href: ROUTES.xIntro,
   },
   {
-    name: 'MUI Toolpad',
-    description: 'Low-code admin builder.',
-    href: ROUTES.toolpadDocs,
+    name: 'Toolpad',
+    description: 'Low-code admin builder',
+    href: ROUTES.toolpadStudioDocs,
     chip: 'Beta',
   },
 ];

diff --git a/docs/src/layouts/AppFooter.tsx b/docs/src/layouts/AppFooter.tsx
@@ -83,7 +83,7 @@ export default function AppFooter(props: AppFooterProps) {
               MUI X
             </Link>
             <Link prefetch={false} href={ROUTES.productToolpad}>
-              MUI Toolpad
+              Toolpad
             </Link>
             <Link prefetch={false} href={ROUTES.productTemplates}>
               Templates

diff --git a/docs/src/modules/components/AppSearch.js b/docs/src/modules/components/AppSearch.js
@@ -273,6 +273,8 @@ const productNameProductId = {
   x: 'MUI X',
   system: 'MUI System',
   toolpad: 'Toolpad',
+  'toolpad-studio': 'Toolpad Studio',
+  'toolpad-core': 'Toolpad Core',
 };
 
 export function convertProductIdToName(productInfo) {

diff --git a/docs/src/modules/components/MuiProductSelector.tsx b/docs/src/modules/components/MuiProductSelector.tsx
@@ -186,7 +186,7 @@ export default function MuiProductSelector() {
       </Box>
       <li role="none">
         <Link
-          href={ROUTES.toolpadDocs}
+          href={ROUTES.toolpadStudioDocs}
           sx={(theme) => ({
             p: 2,
             pr: 3,
@@ -204,7 +204,7 @@ export default function MuiProductSelector() {
           <ProductSubMenu
             role="menuitem"
             icon={<IconImage name="product-toolpad" />}
-            name="MUI Toolpad"
+            name="Toolpad"
             description="Low-code admin builder."
             chip={<Chip size="small" label="Beta" color="primary" variant="outlined" />}
           />

diff --git a/docs/src/modules/utils/getProductInfoFromUrl.test.js b/docs/src/modules/utils/getProductInfoFromUrl.test.js
@@ -90,10 +90,17 @@ describe('getProductInfoFromUrl', () => {
     });
   });
 
-  it('should handle MUI Toolpad', () => {
-    expect(getProductInfoFromUrl('/toolpad/getting-started/first-app/')).to.deep.equal({
-      productCategoryId: 'null',
-      productId: 'toolpad',
+  it('should handle Toolpad Core', () => {
+    expect(getProductInfoFromUrl('/toolpad/getting-started/')).to.deep.equal({
+      productCategoryId: 'toolpad',
+      productId: 'toolpad-core',
+    });
+  });
+
+  it('should handle Toolpad Studio', () => {
+    expect(getProductInfoFromUrl('/toolpad/studio/getting-started/first-app/')).to.deep.equal({
+      productCategoryId: 'toolpad',
+      productId: 'toolpad-studio',
     });
   });
 });
diff --git a/docs/src/modules/utils/getProductInfoFromUrl.ts b/docs/src/modules/utils/getProductInfoFromUrl.ts
@@ -51,7 +51,17 @@ export default function getProductInfoFromUrl(asPath: string): MuiProductInfo {
     }
   }
 
-  if (firstFolder === 'toolpad' || firstFolder === 'docs') {
+  if (firstFolder === 'toolpad') {
+    productCategoryId = 'toolpad';
+    const secondFolder = asPathWithoutLang.replace(/^\/+[^/]+\/([^/]+)\/.*/, '$1');
+    if (secondFolder === 'studio') {
+      productId = 'toolpad-studio';
+    } else {
+      productId = 'toolpad-core';
+    }
+  }
+
+  if (firstFolder === 'docs') {
     productId = firstFolder;
   }
 

diff --git a/docs/src/route.ts b/docs/src/route.ts
@@ -50,6 +50,7 @@ const ROUTES = {
   treeViewOverview: '/x/react-tree-view/',
   // Toolpad pages
   toolpadDocs: '/toolpad/getting-started/',
+  toolpadStudioDocs: '/toolpad/studio/getting-started',
   // External pages
   rssFeed: '/feed/blog/rss.xml',
   handbook: 'https://mui-org.notion.site/Handbook-f086d47e10794d5e839aef9dc67f324b',

diff --git a/docs/writing-rules/BrandName.yml b/docs/writing-rules/BrandName.yml
@@ -15,7 +15,7 @@ swap:
   MUI System: MUI System
   MUI Store: MUI Store
   MUI Core: MUI Core
-  MUI Toolpad: MUI Toolpad
+  Toolpad: Toolpad
   MUI Connect: MUI Connect
   Stack Overflow: Stack Overflow
   Pigment CSS: Pigment CSS