Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

rebrand to SDK reference

0divd599ddac3290
diff --git a/.gitattributes b/.gitattributes
index f8fff554b..c5804d178 100644
--- a/.gitattributes
+++ b/.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
diff --git a/.github/scripts/is_new_api_ref.sh b/.github/scripts/is_new_sdk_ref.sh
similarity index 73%
rename from .github/scripts/is_new_api_ref.sh
rename to .github/scripts/is_new_sdk_ref.sh
index 9e2400285..379ecace6 100755
--- a/.github/scripts/is_new_api_ref.sh
+++ b/.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
diff --git a/.github/workflows/generate_api_ref.yml b/.github/workflows/generate_sdk_ref.yml
similarity index 66%
rename from .github/workflows/generate_api_ref.yml
rename to .github/workflows/generate_sdk_ref.yml
index 04faaee29..e69862ec6 100644
--- a/.github/workflows/generate_api_ref.yml
+++ b/.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
\ No newline at end of file
diff --git a/.github/workflows/publish_packages.yml b/.github/workflows/publish_packages.yml
index cac3a3790..caad48b28 100644
--- a/.github/workflows/publish_packages.yml
+++ b/.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:
diff --git a/.gitignore b/.gitignore
index f90190b55..74d83b006 100644
--- a/.gitignore
+++ b/.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
diff --git a/CODEOWNERS b/CODEOWNERS
index 90984aa88..be22d65d3 100644
--- a/CODEOWNERS
+++ b/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
diff --git a/apps/web/.gitignore b/apps/web/.gitignore
index b05aeeec8..9f7fdf7cb 100644
--- a/apps/web/.gitignore
+++ b/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
diff --git a/apps/web/README.md b/apps/web/README.md
index 66155abc8..0c3076d4b 100644
--- a/apps/web/README.md
+++ b/apps/web/README.md
@@ -1,14 +1,14 @@
# E2B Web App
-This repository contains E2D Dashboard, documentation, and API reference.
+This repository contains E2D Dashboard, documentation, and SDK references.
-## SDK API References
+## SDK References
-The SDK API references are generated from the source code in the [packages](../../packages) folder.
-Each package has its own API reference generator found in `{package-dir}/scripts/generate_api_ref.sh`, it generates markdown files with the following schema: `./src/app/(docs)/docs/api-reference/{package-name}/{version}/{module-name}/page.mdx`.
+The SDK references are generated from the source code in the [packages](../../packages) folder.
+Each package has its own SDK reference generator found in `{package-dir}/scripts/generate_sdk_ref.sh`, it generates markdown files with the following schema: `./src/app/(docs)/docs/sdk-reference/{package-name}/{version}/{module-name}/page.mdx`.
-When pushed to `main`, a [github workflow](../../.github/workflows/generate_api_ref.yml) checks for diffs in the [packages](../../packages) folder, and if any are found, the API reference generator is run and the result is auto-commited the incoming branch.
+When pushed to `main`, a [github workflow](../../.github/workflows/generate_sdk_ref.yml) checks for diffs in the [packages](../../packages) folder, and if any are found, the SDK reference generator is run and the result is auto-commited the incoming branch.
-Finally, when building or running the dev server, a [prebuild](./prebuild.js) step is run beforehand to generate the API reference TOCs and routes in the [api-reference](./src/app/(docs)/docs/api-reference) directory. This can also be run manually using `npm run prebuild`.
+Finally, when building or running the dev server, a [prebuild](./prebuild.js) step is run beforehand to generate the SDK reference TOCs and routes in the [sdk-reference](./src/app/(docs)/docs/sdk-reference) directory. This can also be run manually using `npm run prebuild`.
-note: sometimes you may see uncommited changes or untracked files in the [api-reference](./src/app/(docs)/docs/api-reference) directory, this is fine and the files can be ignored.
+note: sometimes you may see uncommited changes or untracked files in the [sdk-reference](./src/app/(docs)/docs/sdk-reference) directory, this is fine and the files can be ignored.
diff --git a/apps/web/prebuild.js b/apps/web/prebuild.js
index 7fe1c7bc2..0830fde0b 100644
--- a/apps/web/prebuild.js
+++ b/apps/web/prebuild.js
@@ -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,9 +66,11 @@ 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,
@@ -72,7 +78,11 @@ function getSubModules(pkg, href, dirPath) {
})
}
}
- } 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')
diff --git a/apps/web/src/app/(docs)/docs/page.mdx b/apps/web/src/app/(docs)/docs/page.mdx
index 01b83b031..dd18edf83 100644
--- 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 API reference for developing with E2B.
+Here you'll find all the guides, concepts, and SDK reference for developing with E2B.
<CodeGroup isTerminalCommand>
```bash {{ language: 'js' }}
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.0/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.0/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.1/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.1/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.2/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.2/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.3/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.3/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.4/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.4/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/auth/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/auth/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/auth/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/auth/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/template/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/template/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/cli/v1.0.5/template/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.5/template/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/charts/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/charts/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/consts/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/consts/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/index/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/index/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/messaging/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/messaging/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-js-sdk/v1.0.4/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/code-interpreter-python-sdk/v1.0.1/e2b_code_interpreter/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/e2b_code_interpreter/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/code-interpreter-python-sdk/v1.0.1/e2b_code_interpreter/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/e2b_code_interpreter/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.0/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.0/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.1/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.1/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.2/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.2/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.3/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.3/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.4/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.4/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/commands/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/commands/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/commands/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/commands/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/errors/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/errors/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/errors/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/errors/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/filesystem/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/filesystem/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/filesystem/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/filesystem/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/sandbox/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/sandbox/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/js-sdk/v1.0.5/sandbox/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/v1.0.5/sandbox/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/page.mdx
similarity index 81%
rename from apps/web/src/app/(docs)/docs/api-reference/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/page.mdx
index d6b231b22..57c25300e 100644
--- a/apps/web/src/app/(docs)/docs/api-reference/page.mdx
+++ b/apps/web/src/app/(docs)/docs/sdk-reference/page.mdx
@@ -1,5 +1,5 @@
-# API Reference
+# SDK Reference
-This is the API reference for the E2B CLI, JS & Python packages, which allows you to run AI-generated code in secure isolated sandboxes in the cloud.
+This is the SDK reference for the E2B CLI, JS & Python packages, which allows you to run AI-generated code in secure isolated sandboxes in the cloud.
The reference is intended to be limited to low-level descriptions of various programmatic functionality. If you’re just getting started with E2B, we would instead recommend looking at the [documentation](../docs) first or to get started quickly with an example.
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/exceptions/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/exceptions/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/exceptions/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_async/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/exceptions/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/exceptions/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/exceptions/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/sandbox_async/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.1/sandbox_sync/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/exceptions/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/exceptions/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/exceptions/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/sandbox_async/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.2/sandbox_sync/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/exceptions/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/exceptions/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/exceptions/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/exceptions/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/page.mdx
diff --git a/apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx b/apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
similarity index 100%
rename from apps/web/src/app/(docs)/docs/api-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
rename to apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/page.mdx
diff --git a/apps/web/src/components/Header.tsx b/apps/web/src/components/Header.tsx
index 8d4dfd006..be4babcd0 100644
--- a/apps/web/src/components/Header.tsx
+++ b/apps/web/src/components/Header.tsx
@@ -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}
diff --git a/apps/web/src/components/Layout.tsx b/apps/web/src/components/Layout.tsx
index c5aa692b4..694fbea60 100644
--- a/apps/web/src/components/Layout.tsx
+++ b/apps/web/src/components/Layout.tsx
@@ -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>
)}
diff --git a/apps/web/src/components/Navigation/index.tsx b/apps/web/src/components/Navigation/index.tsx
index cff0ba004..b5578d536 100644
--- a/apps/web/src/components/Navigation/index.tsx
+++ b/apps/web/src/components/Navigation/index.tsx
@@ -14,8 +14,8 @@ import {
NavLink,
NavSubgroup,
VersionedNavGroup,
- apiRefRoutes,
docRoutes,
+ sdkRefRoutes,
} from './routes'
function useInitialValue<T>(value: T, condition = true) {
@@ -92,7 +92,7 @@ function VersionedNavigationGroup({
}) {
const router = useRouter()
- // Manage the state of the current version of the API reference
+ // Manage the state of the current version of the SDK reference
const versions = Object.keys(group.versionedItems)
const [curVersion, setCurVersion] = useState(versions[0])
@@ -124,7 +124,7 @@ function VersionedNavigationGroup({
onChange={(e) => {
setCurVersion(e.target.value)
- if (pathname !== '/docs/api-reference') {
+ if (pathname !== '/docs/sdk-reference') {
const pathParts = pathname.split('/')
pathParts[pathParts.length - 2] = e.target.value
router.push(pathParts.join('/'))
@@ -181,11 +181,11 @@ export function DocsNavigation(props) {
)
}
-export function ApiRefNavigation(props) {
+export function SdkRefNavigation(props) {
return (
<nav {...props}>
<ul role="list">
- {apiRefRoutes.map((group, groupIndex) => (
+ {sdkRefRoutes.map((group, groupIndex) => (
<VersionedNavigationGroup
key={groupIndex}
group={group}
diff --git a/apps/web/src/components/Navigation/routes.tsx b/apps/web/src/components/Navigation/routes.tsx
index e9f30c0f2..711490971 100644
--- a/apps/web/src/components/Navigation/routes.tsx
+++ b/apps/web/src/components/Navigation/routes.tsx
@@ -1,5 +1,5 @@
import { Braces, CheckCircle, Home, MessagesSquare } from 'lucide-react'
-import apiRefRoutesJson from './apiRefRoutes.json'
+import sdkRefRoutesJson from './sdkRefRoutes.json'
export interface NavLink {
title: string
@@ -449,5 +449,11 @@ export const docRoutes: NavGroup[] = [
// },
]
-export const apiRefRoutes: VersionedNavGroup[] =
- apiRefRoutesJson as VersionedNavGroup[]
+export const sdkRefRoutes: VersionedNavGroup[] = (
+ sdkRefRoutesJson as VersionedNavGroup[]
+).sort((a, b) => {
+ const order = { CLI: 1, 'JS-SDK': 2, 'PYTHON-SDK': 3 }
+ const aOrder = order[a.title || ''] || 999
+ const bOrder = order[b.title || ''] || 999
+ return aOrder - bOrder
+})
diff --git a/package.json b/package.json
index 45e584bfc..57862d8b4 100644
--- a/package.json
+++ b/package.json
@@ -8,7 +8,7 @@
"dev:web": "pnpm --prefix apps/web run dev",
"rm-node-modules": "find . -name 'node_modules' -type d -prune -exec rm -rf '{}' +",
"pnpm-install-hack": "cd packages/js-sdk && sed -i '' 's/\"version\": \".*\"/\"version\": \"9.9.9\"/g' package.json && cd ../.. && pnpm i && git checkout -- packages/js-sdk/package.json",
- "generate-api-reference": "pnpm --if-present --recursive run generate-api-reference"
+ "generate-sdk-reference": "pnpm --if-present --recursive run generate-sdk-reference"
},
"packageManager": "[email protected]",
"dependencies": {
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 8a4f73993..2ec34043d 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -41,7 +41,7 @@
"test": "pnpm build && cd testground/demo-basic && ../../dist/index.js template build",
"check-deps": "knip",
"update-deps": "ncu -u && pnpm i",
- "generate-api-reference": "./scripts/generate_api_ref.sh"
+ "generate-sdk-reference": "./scripts/generate_sdk_ref.sh"
},
"devDependencies": {
"@types/command-exists": "^1.2.3",
@@ -83,4 +83,4 @@
"engines": {
"node": ">=18"
}
-}
\ No newline at end of file
+}
diff --git a/packages/cli/scripts/generate_api_ref.sh b/packages/cli/scripts/generate_sdk_ref.sh
similarity index 66%
rename from packages/cli/scripts/generate_api_ref.sh
rename to packages/cli/scripts/generate_sdk_ref.sh
index cb8eae214..4387f09a3 100755
--- a/packages/cli/scripts/generate_api_ref.sh
+++ b/packages/cli/scripts/generate_sdk_ref.sh
@@ -2,24 +2,24 @@
set -euo pipefail
-# This script generates the CLI API reference markdown files
+# This script generates the CLI SDK reference markdown files
## Run it in the `cli/` directory
-mkdir -p api_ref
+mkdir -p sdk_ref
npx tsup && NODE_ENV=development node dist/index.js -cmd2md
PKG_VERSION="v$(node -p "require('./package.json').version")"
# move to docs web app
-for file in api_ref/*.md; do
+for file in sdk_ref/*.md; do
# Extract the filename without extension
filename=$(basename "$file" .md)
# Create the directory if it doesn't exist
- mkdir -p "../../apps/web/src/app/(docs)/docs/api-reference/cli/${PKG_VERSION}/${filename}"
+ mkdir -p "../../apps/web/src/app/(docs)/docs/sdk-reference/cli/${PKG_VERSION}/${filename}"
# Move the file to the new location and rename it to page.mdx
- mv "$file" "../../apps/web/src/app/(docs)/docs/api-reference/cli/${PKG_VERSION}/${filename}/page.mdx"
+ mv "$file" "../../apps/web/src/app/(docs)/docs/sdk-reference/cli/${PKG_VERSION}/${filename}/page.mdx"
done
-rm -rf api_ref
+rm -rf sdk_ref
diff --git a/packages/js-sdk/package.json b/packages/js-sdk/package.json
index 200551306..5b46dc5f0 100644
--- a/packages/js-sdk/package.json
+++ b/packages/js-sdk/package.json
@@ -30,7 +30,7 @@
"test": "vitest run",
"generate": "openapi-typescript ../../spec/openapi.yml -x api_key --support-array-length --alphabetize --output src/api/schema.gen.ts",
"generate-envd-api": "openapi-typescript ../../spec/envd/envd.yaml -x api_key --support-array-length --alphabetize --output src/envd/schema.gen.ts",
- "generate-api-reference": "./scripts/generate_api_ref.sh",
+ "generate-sdk-reference": "./scripts/generate_sdk_ref.sh",
"check-deps": "knip",
"update-deps": "ncu -u && pnpm i",
"postPublish": "./scripts/post-publish.sh || true",
diff --git a/packages/js-sdk/scripts/CustomMarkdownTheme.js b/packages/js-sdk/scripts/CustomMarkdownTheme.js
index db55c01de..b1a8e0200 100644
--- a/packages/js-sdk/scripts/CustomMarkdownTheme.js
+++ b/packages/js-sdk/scripts/CustomMarkdownTheme.js
@@ -13,7 +13,7 @@ function load(app) {
})
}
-// this is a hacky way to make methods in the js-sdk api reference look more prominent
+// this is a hacky way to make methods in the js-sdk reference look more prominent
function convertH5toH3(text) {
return text.replace(/^##### (.*)$/gm, '### $1')
}
diff --git a/packages/js-sdk/scripts/generate_api_ref.sh b/packages/js-sdk/scripts/generate_api_ref.sh
deleted file mode 100755
index bd822ed2e..000000000
--- a/packages/js-sdk/scripts/generate_api_ref.sh
+++ /dev/null
@@ -1,36 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-
-# This script generates the JS SDK API reference markdown files
-# Run it in the `js-sdk/` directory
-
-# generate raw api reference markdown files
-npx typedoc
-
-PKG_VERSION="v$(node -p "require('./package.json').version")"
-ROUTES_DIR="../../apps/web/src/app/(docs)/docs/api-reference/js-sdk/${PKG_VERSION}"
-# move to docs web app
-mkdir -p "${ROUTES_DIR}"
-
-rm -rf api_ref/README.md
-
-# Flatten the api_ref directory by moving all nested files to the root level and remove empty subdirectories
-find api_ref -mindepth 2 -type f | while read -r file; do
- mv "$file" api_ref/
-done
-find api_ref -type d -empty -delete
-
-# Transfrom top level MD files into folders of the same name with page.mdx inside
-find api_ref -maxdepth 1 -type f -name "*.md" | while read -r file; do
- # Extract the filename without extension
- filename=$(basename "$file" .md)
- # Create the directory of the same name in api_ref
- mkdir -p "api_ref/${filename}"
- # Move the file inside the newly created directory
- mv "$file" "api_ref/${filename}/page.mdx"
-done
-
-cp -r api_ref/* "${ROUTES_DIR}"
-
-rm -rf api_ref
diff --git a/packages/js-sdk/scripts/generate_sdk_ref.sh b/packages/js-sdk/scripts/generate_sdk_ref.sh
new file mode 100755
index 000000000..f5ce64578
--- /dev/null
+++ b/packages/js-sdk/scripts/generate_sdk_ref.sh
@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# This script generates the JS SDK reference markdown files
+# Run it in the `js-sdk/` directory
+
+# generate raw SDK reference markdown files
+npx typedoc
+
+PKG_VERSION="v$(node -p "require('./package.json').version")"
+ROUTES_DIR="../../apps/web/src/app/(docs)/docs/sdk-reference/js-sdk/${PKG_VERSION}"
+# move to docs web app
+mkdir -p "${ROUTES_DIR}"
+
+rm -rf sdk_ref/README.md
+
+# Flatten the sdk_ref directory by moving all nested files to the root level and remove empty subdirectories
+find sdk_ref -mindepth 2 -type f | while read -r file; do
+ mv "$file" sdk_ref/
+done
+find sdk_ref -type d -empty -delete
+
+# Transfrom top level MD files into folders of the same name with page.mdx inside
+find sdk_ref -maxdepth 1 -type f -name "*.md" | while read -r file; do
+ # Extract the filename without extension
+ filename=$(basename "$file" .md)
+ # Create the directory of the same name in sdk_ref
+ mkdir -p "sdk_ref/${filename}"
+ # Move the file inside the newly created directory
+ mv "$file" "sdk_ref/${filename}/page.mdx"
+done
+
+cp -r sdk_ref/* "${ROUTES_DIR}"
+
+rm -rf sdk_ref
diff --git a/packages/python-sdk/package.json b/packages/python-sdk/package.json
index 81fe61ea2..3740eb0c7 100644
--- a/packages/python-sdk/package.json
+++ b/packages/python-sdk/package.json
@@ -8,6 +8,6 @@
"postVersion": "poetry version $(pnpm pkg get version --workspaces=false | tr -d \\\")",
"postPublish": "poetry build && poetry config pypi-token.pypi ${PYPI_TOKEN} && poetry publish --skip-existing",
"pretest": "poetry install",
- "generate-api-reference": "poetry install && ./scripts/generate_api_ref.sh"
+ "generate-sdk-reference": "poetry install && ./scripts/generate_sdk_ref.sh"
}
}
diff --git a/packages/python-sdk/scripts/generate_api_ref.sh b/packages/python-sdk/scripts/generate_api_ref.sh
deleted file mode 100755
index 0450528ac..000000000
--- a/packages/python-sdk/scripts/generate_api_ref.sh
+++ /dev/null
@@ -1,32 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-
-# This script generates the python sdk api reference markdown files
-# Run it in the `python-sdk/` directory
-
-PKG_VERSION="v$(node -p "require('./package.json').version")"
-
-packages=("sandbox_sync" "sandbox_async" "exceptions")
-
-mkdir -p ../../apps/web/src/app/\(docs\)/docs/api-reference/python-sdk/${PKG_VERSION}
-
-mkdir -p api_ref
-
-for package in "${packages[@]}"; do
- # generate raw api reference markdown file
- poetry run pydoc-markdown -p e2b."${package}" >api_ref/"${package}".mdx
- # remove package path display
- sed -i'' -e '/<a[^>]*>.*<\/a>/d' "api_ref/${package}.mdx"
- # remove empty hyperlinks
- sed -i'' -e '/^# /d' "api_ref/${package}.mdx"
- # remove " Objects" from lines starting with "##"
- sed -i'' -e '/^## / s/ Objects$//' "api_ref/${package}.mdx"
- # replace lines starting with "####" with "###"
- sed -i'' -e 's/^####/###/' "api_ref/${package}.mdx"
- # move to docs
- mkdir -p "../../apps/web/src/app/(docs)/docs/api-reference/python-sdk/${PKG_VERSION}/${package}"
- mv "api_ref/${package}.mdx" "../../apps/web/src/app/(docs)/docs/api-reference/python-sdk/${PKG_VERSION}/${package}/page.mdx"
-done
-
-rm -rf api_ref
diff --git a/packages/python-sdk/scripts/generate_sdk_ref.sh b/packages/python-sdk/scripts/generate_sdk_ref.sh
new file mode 100755
index 000000000..70699f472
--- /dev/null
+++ b/packages/python-sdk/scripts/generate_sdk_ref.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# This script generates the python SDK reference markdown files
+# Run it in the `python-sdk/` directory
+
+PKG_VERSION="v$(node -p "require('./package.json').version")"
+
+packages=("sandbox_sync" "sandbox_async" "exceptions")
+
+mkdir -p ../../apps/web/src/app/\(docs\)/docs/sdk-reference/python-sdk/${PKG_VERSION}
+
+mkdir -p sdk_ref
+
+for package in "${packages[@]}"; do
+ # generate raw SDK reference markdown file
+ poetry run pydoc-markdown -p e2b."${package}" >sdk_ref/"${package}".mdx
+ # remove package path display
+ sed -i'' -e '/<a[^>]*>.*<\/a>/d' "sdk_ref/${package}.mdx"
+ # remove empty hyperlinks
+ sed -i'' -e '/^# /d' "sdk_ref/${package}.mdx"
+ # remove " Objects" from lines starting with "##"
+ sed -i'' -e '/^## / s/ Objects$//' "sdk_ref/${package}.mdx"
+ # replace lines starting with "####" with "###"
+ sed -i'' -e 's/^####/###/' "sdk_ref/${package}.mdx"
+ # move to docs
+ mkdir -p "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/${package}"
+ mv "sdk_ref/${package}.mdx" "../../apps/web/src/app/(docs)/docs/sdk-reference/python-sdk/${PKG_VERSION}/${package}/page.mdx"
+done
+
+rm -rf sdk_ref