rebrand to SDK reference

Author: 0div

.gitattributes

@@ -1,3 +1,3 @@
 packages/python-sdk/e2b/api/client/** linguist-generated=true
 **/*.gen.ts linguist-generated=true
-apps/web/src/app/(docs)/docs/api-reference/** linguist-generated=true
+apps/web/src/app/(docs)/docs/sdk-reference/** linguist-generated=true

.github/scripts/is_new_api_ref.sh renamed to .github/scripts/is_new_sdk_ref.sh

@@ -3,7 +3,7 @@
 set -euo pipefail
 
 # This script checks for diffs in the packages directory.
-# If there are diffs, it means we need to generate a new API references.
+# If there are diffs, it means we need to generate new SDK references.
 if git diff --name-only HEAD^ | grep -q '^packages/'; then
     echo "true"
 else

.github/workflows/generate_api_ref.yml renamed to .github/workflows/generate_sdk_ref.yml

@@ -1,4 +1,4 @@
-name: Generate SDK API references
+name: Generate SDK references
 
 on:
   workflow_dispatch:
@@ -13,11 +13,11 @@ permissions:
   contents: write
 
 jobs:
-  is_new_api_ref:
-    name: Is new API reference?
+  is_new_sdk_ref:
+    name: Is new SDK reference?
     runs-on: ubuntu-latest
     outputs:
-      new_api_ref: ${{ steps.sdk-changes.outputs.new_api_ref }}
+      new_sdk_ref: ${{ steps.sdk-changes.outputs.new_sdk_ref }}
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
@@ -27,12 +27,12 @@ jobs:
       - name: Check if SDK changes
         id: sdk-changes
         run: |
-          IS_NEW_API_REF=$(./.github/scripts/is_new_api_ref.sh)
-          echo "new_api_ref=$IS_NEW_API_REF" >> "$GITHUB_OUTPUT"
+          IS_NEW_sdk_REF=$(./.github/scripts/is_new_sdk_ref.sh)
+          echo "new_sdk_ref=$IS_NEW_sdk_REF" >> "$GITHUB_OUTPUT"
 
   sdk-changes:
     name: SDK changes
-    needs: [is_new_api_ref]
+    needs: [is_new_sdk_ref]
     if: always()
     runs-on: ubuntu-latest
     steps:
@@ -81,43 +81,41 @@ jobs:
         working-directory: ./packages/python-sdk
         run: poetry install --no-interaction --no-root
 
-      - name: Generate Python SDK API reference
-        id: python-sdk-api-ref
+      - name: Generate Python SDK reference
+        id: python-sdk-ref
         working-directory: ./packages/python-sdk
         run: |
           source .venv/bin/activate
-          ./scripts/generate_api_ref.sh
+          ./scripts/generate_sdk_ref.sh
 
-      - name: Generate JS SDK API reference
-        id: js-sdk-api-ref
+      - name: Generate JS SDK reference
+        id: js-sdk-ref
         working-directory: packages/js-sdk
-        run: ./scripts/generate_api_ref.sh
+        run: ./scripts/generate_sdk_ref.sh
 
-      - name: Generate CLI API reference
-        id: cli-api-ref
+      - name: Generate CLI reference
+        id: cli-sdk-ref
         working-directory: packages/cli
-        run: ./scripts/generate_api_ref.sh
+        run: ./scripts/generate_sdk_ref.sh
 
-      - name: Clone code-interpreter API reference
+      - name: Clone code-interpreter reference
         run: |
           git clone --depth 1 --filter=blob:none --sparse https://github.com/e2b-dev/code-interpreter -b generate-api-reference-for-code-interpreter-sdk-e2b-1235
           cd code-interpreter
-          git sparse-checkout set api-reference
-          cp -r api-reference/* ../apps/web/src/app/\(docs\)/docs/api-reference/
+          git sparse-checkout set sdk-reference
+          cp -r sdk-reference/* ../apps/web/src/app/\(docs\)/docs/sdk-reference/
           cd ..
           rm -rf code-interpreter
 
       - name: Show docs file structure
-        run: tree apps/web/src/app/\(docs\)/docs/api-reference
+        run: tree apps/web/src/app/\(docs\)/docs/sdk-reference
 
-      - name: Commit new SDK API reference versions
+      - name: Commit new SDK reference versions
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |  
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
-          tree apps/web/src/app/\(docs\)/docs/api-reference
-          git status
-          git add apps/web/src/app/\(docs\)/docs/api-reference
-          git commit -m "[skip ci] Release new SDK API reference doc versions" || exit 0
+          git add apps/web/src/app/\(docs\)/docs/sdk-reference
+          git commit -m "[skip ci] Release new SDK reference doc versions" || exit 0
           git push

.github/workflows/publish_packages.yml

@@ -67,8 +67,8 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
 
-      - name: Generate API Ref
-        run: pnpm run generate-api-reference
+      - name: Generate SDK reference
+        run: pnpm run generate-sdk-reference
 
       - name: Update lock file
         run: pnpm i --no-link --no-frozen-lockfile
@@ -77,7 +77,7 @@ jobs:
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add apps/web/src/app/\(docs\)/docs/api-reference 
+          git add apps/web/src/app/\(docs\)/docs/sdk-reference 
           git commit -am "[skip ci] Release new versions" || exit 0
           git push
         env:

.gitignore

@@ -289,6 +289,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-# API reference artifacts
-api_ref/
-apiRefRoutes.json
+# SDK reference artifacts
+sdk_ref/
+sdkRefRoutes.json

CODEOWNERS

@@ -5,7 +5,7 @@
 # Web
 apps/web @jakubno @mishushakov
 apps/web/src/app/(docs)/docs @mlejva
-apps/web/src/app/(docs)/docs/api-reference @0div
+apps/web/src/app/(docs)/docs/sdk-reference @0div
 
 # SDKs
 packages @jakubno @ValentaTomas

apps/web/.gitignore

@@ -44,6 +44,6 @@ vale-styles
 # Sentry Auth Token
 .sentryclirc
 
-# Add the generated route file for API reference docs to gitignore so we don't commit it.
+# Add the generated route file for SDK reference docs to gitignore so we don't commit it.
 # The idea is that we want to generate this file only from the automated GitHub actions.
-apiRefRoutes.json
+sdkRefRoutes.json

apps/web/README.md

@@ -1,7 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 
-const ApiRefRoutesFilePath = './src/components/Navigation/apiRefRoutes.json'
+const sdkRefRoutesFilePath = './src/components/Navigation/sdkRefRoutes.json'
 
 // Current directory hierarchy:
 //
@@ -42,6 +42,10 @@ function formatModuleTitle(title) {
 }
 
 function toAnchorLink(title) {
+  // Replace underscores with dashes
+  title = title.replace(/_/g, '-')
+  // Trim dashes from start and end
+  title = title.replace(/^-+|-+$/g, '')
   // Remove special characters except dashes and spaces
   title = title.replace(/[^a-zA-Z0-9\- ]/g, '')
   // Add dashes between words for camelCase
@@ -62,17 +66,23 @@ function getSubModules(pkg, href, dirPath) {
     const subModules = []
     for (let i = 0; i < lines.length; i++) {
       const line = lines[i]
-      if (pkg === 'js-sdk') {
+      if (pkg === 'js-sdk' || pkg === 'code-interpreter-js-sdk') {
         if (line.startsWith('### ')) {
-          const title = line.slice(3).trim()
+          let title = line.slice(3).trim()
+          // Remove backslashes from title
+          title = title.replace(/\\/g, '')
           if (title) {
             subModules.push({
               title: title,
               href: href + toAnchorLink(title),
             })
           }
         }
-      } else if (pkg === 'python-sdk' || pkg === 'cli') {
+      } else if (
+        pkg === 'python-sdk' ||
+        pkg === 'cli' ||
+        pkg === 'code-interpreter-python-sdk'
+      ) {
         if (line.startsWith('## ')) {
           const title = line.slice(2).trim()
           if (title) {
@@ -119,13 +129,13 @@ function buildRoutes(dirName, dir, basePath = '', depth = 1) {
               versionedItems[version] = modules.map((module) => {
                 return {
                   title: formatModuleTitle(module),
-                  href: `/docs/api-reference/${entryName}/${version}/${module}`,
+                  href: `/docs/sdk-reference/${entryName}/${version}/${module}`,
                   links: getSubModules(
                     entryName,
-                    `/docs/api-reference/${entryName}/${version}/${module}`,
+                    `/docs/sdk-reference/${entryName}/${version}/${module}`,
                     path.join(
                       __dirname,
-                      `./src/app/(docs)/docs/api-reference/${entryName}/${version}/${module}`
+                      `./src/app/(docs)/docs/sdk-reference/${entryName}/${version}/${module}`
                     )
                   ),
                 }
@@ -162,7 +172,7 @@ function buildRoutes(dirName, dir, basePath = '', depth = 1) {
           //        .slice(1)
           //        .map(
           //          (version) =>
-          //            `<a href="/docs/api-reference/${dirName}/${version}" className="version-link">${version}</a>`
+          //            `<a href="/docs/sdk-reference/${dirName}/${version}" className="version-link">${version}</a>`
           //        )
           //        .join('\n  ')}
           //      </div>
@@ -204,25 +214,25 @@ function buildRoutes(dirName, dir, basePath = '', depth = 1) {
     .filter(Boolean)
 }
 
-function generateApiRefRoutes() {
-  const apiRefPath = path.join(__dirname, './src/app/(docs)/docs/api-reference')
+function generatesdkRefRoutes() {
+  const sdkRefPath = path.join(__dirname, './src/app/(docs)/docs/sdk-reference')
 
-  if (!fs.existsSync(apiRefPath)) {
+  if (!fs.existsSync(sdkRefPath)) {
     return []
   }
 
-  hierarchy = buildDirectoryHierarchy(apiRefPath)
+  hierarchy = buildDirectoryHierarchy(sdkRefPath)
 
-  const routes = buildRoutes('api-reference', apiRefPath)
+  const routes = buildRoutes('sdk-reference', sdkRefPath)
   return routes
 }
 
-const apiRefRoutes = generateApiRefRoutes()
+const sdkRefRoutes = generatesdkRefRoutes()
 
 fs.writeFileSync(
-  path.join(__dirname, ApiRefRoutesFilePath),
-  JSON.stringify(apiRefRoutes, null, 2)
+  path.join(__dirname, sdkRefRoutesFilePath),
+  JSON.stringify(sdkRefRoutes, null, 2)
 )
 
-console.log('\n\nAPI reference routes generated successfully:\n\n')
-console.log('routes', JSON.stringify(apiRefRoutes, null, 2), '\n\n')
+console.log('\n\nSDK reference routes generated successfully:\n\n')
+console.log('routes', JSON.stringify(sdkRefRoutes, null, 2), '\n\n')

apps/web/prebuild.js

@@ -34,8 +34,8 @@ function DocumentationTypeLink({
       className={clsx(
         'hover:text-white hover:cursor-pointer text-sm font-medium px-2 py-1 rounded-md',
         pathname.startsWith(href) &&
-          // XXX: this is a hack to avoid the /docs and /docs/api-reference links being highlighted at the same time
-          !(href === '/docs' && pathname.startsWith('/docs/api-reference'))
+          // XXX: this is a hack to avoid the /docs and /docs/sdk-reference links being highlighted at the same time
+          !(href === '/docs' && pathname.startsWith('/docs/sdk-reference'))
           ? 'text-white bg-zinc-800'
           : 'text-neutral-400'
       )}
@@ -110,8 +110,8 @@ export const Header = forwardRef(function Header({ className }, ref) {
           />
           <DocumentationTypeLink
             pathname={pathname}
-            href="/docs/api-reference"
-            title="API Reference"
+            href="/docs/sdk-reference"
+            title="SDK Reference"
           />
           <DocumentationTypeLink
             pathname={pathname}
@@ -136,8 +136,8 @@ export const Header = forwardRef(function Header({ className }, ref) {
           />
           <DocumentationTypeLink
             pathname={pathname}
-            href="/docs/api-reference"
-            title="API Reference"
+            href="/docs/sdk-reference"
+            title="SDK Reference"
           />
           <DocumentationTypeLink
             pathname={pathname}

apps/web/src/app/(docs)/docs/page.mdx

@@ -5,7 +5,7 @@ import { motion } from 'framer-motion'
 import { usePathname } from 'next/navigation'
 
 import { Footer } from '@/components/Footer'
-import { ApiRefNavigation, DocsNavigation } from '@/components/Navigation'
+import { DocsNavigation, SdkRefNavigation } from '@/components/Navigation'
 import { Section, SectionProvider } from '@/components/SectionProvider'
 
 export function Layout({
@@ -18,7 +18,7 @@ export function Layout({
   const pathname = usePathname()
   const relativePathname = pathname?.replace(new RegExp('^/docs'), '')
   const isDocs = pathname?.startsWith('/docs')
-  const isApiRef = pathname?.startsWith('/docs/api-reference')
+  const isApiRef = pathname?.startsWith('/docs/sdk-reference')
   const isDashboard = pathname?.startsWith('/dashboard')
 
   return (
@@ -53,7 +53,7 @@ export function Layout({
               "
               >
                 <div className="hidden lg:block lg:mt-4">
-                  {isApiRef ? <ApiRefNavigation /> : <DocsNavigation />}
+                  {isApiRef ? <SdkRefNavigation /> : <DocsNavigation />}
                 </div>
               </div>
             )}