Skip to content

armgit / E2B

Public Imported from GitHub
0

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

update webapp README to explain the auto-generated api ref sdk workflow

0div6f904804cf24
diff --git a/apps/web/README.md b/apps/web/README.md
index a08894c96..3fc5df6fc 100644
--- a/apps/web/README.md
+++ b/apps/web/README.md
@@ -1,3 +1,12 @@
# E2B Docs
The official [E2B documentation](https://e2b.dev/docs).
+
+## SDK API 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`.
+
+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.
+
+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`.