Skip to content

Commit

Permalink
Resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
mlejva committed Oct 14, 2024
2 parents 7159c01 + 81c598c commit 33eea6a
Show file tree
Hide file tree
Showing 2 changed files with 16,310 additions and 8,886 deletions.
9 changes: 9 additions & 0 deletions apps/web/README.md
Original file line number Diff line number Diff line change
@@ -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`.
Loading

0 comments on commit 33eea6a

Please sign in to comment.