Skip to content

Latest commit

 

History

History
12 lines (7 loc) · 971 Bytes

README.md

File metadata and controls

12 lines (7 loc) · 971 Bytes
Raw

E2B Docs

The official E2B documentation.

SDK API References

The SDK API references are generated from the source code in the 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.

When pushed to main, a github workflow checks for diffs in the packages folder, and if any are found, the API reference generator is run and the result is auto-commited the incoming branch.

Finally, when building or running the dev server, a prebuild step is run beforehand to generate the API reference TOCs and routes in the api-reference directory. This can also be run manually using npm run prebuild.