add naming map to allow customization of sdk ref names

e2b-dev · Nov 27, 2024 · 99bba4c · 99bba4c
1 parent e24e530
commit 99bba4c
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 13 deletions.
diff --git a/apps/web/src/app/(docs)/docs/page.mdx b/apps/web/src/app/(docs)/docs/page.mdx
@@ -10,7 +10,7 @@ import { CodeInterpreting } from '@/components/CodeInterpreting'
 <HeroPattern />
 
 # E2B Documentation
-Here you'll find all the guides, concepts, and SDK reference for developing with E2B.
+Here you'll find all the guides, concepts, and SDK references for developing with E2B.
 
 <CodeGroup isTerminalCommand>
 ```bash {{ language: 'js' }}

diff --git a/apps/web/src/components/Navigation/routes.tsx b/apps/web/src/components/Navigation/routes.tsx
@@ -449,17 +449,34 @@ export const docRoutes: NavGroup[] = [
   // },
 ]
 
+const sdkRefNameMap = {
+  'JS-SDK': 'JavaScript SDK',
+  'PYTHON-SDK': 'Python SDK',
+  'DESKTOP-JS-SDK': 'Desktop JavaScript SDK',
+  'DESKTOP-PYTHON-SDK': 'Desktop Python SDK',
+  'CODE-INTERPRETER-JS-SDK': 'Code Interpreter JavaScript SDK',
+  'CODE-INTERPRETER-PYTHON-SDK': 'Code Interpreter Python SDK',
+}
+
 export const sdkRefRoutes: VersionedNavGroup[] = (
   sdkRefRoutesJson as VersionedNavGroup[]
-).sort((a, b) => {
-  const order = {
-    CLI: 1,
-    'JS-SDK': 2,
-    'PYTHON-SDK': 3,
-    'DESKTOP-JS-SDK': 4,
-    'DESKTOP-PYTHON-SDK': 5,
-  }
-  const aOrder = order[a.title || ''] || 999
-  const bOrder = order[b.title || ''] || 999
-  return aOrder - bOrder
-})
+)
+  .sort((a, b) => {
+    const order = {
+      CLI: 1,
+      'JS-SDK': 2,
+      'PYTHON-SDK': 3,
+      'DESKTOP-JS-SDK': 4,
+      'DESKTOP-PYTHON-SDK': 5,
+    }
+    const aOrder = order[a.title || ''] || 999
+    const bOrder = order[b.title || ''] || 999
+    return aOrder - bOrder
+  })
+  .map((group) => ({
+    ...group,
+    title:
+      group?.title && sdkRefNameMap[group.title]
+        ? sdkRefNameMap[group.title]
+        : group.title,
+  }))