Jakub Novák
7c38aa1096
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/e2b-dev/E2B/network/alerts). </details>
E2B Web App
This repository contains E2D Dashboard, documentation, and SDK references.
SDK References
The SDK references are generated from the source code in the 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 checks for diffs in the 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 step is run beforehand to generate the SDK reference TOCs and routes in the 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 sdk-reference directory, this is fine and the files can be ignored.