Skip to content

Commit

Permalink
fix relative paths in README
Browse files Browse the repository at this point in the history
  • Loading branch information
0div committed Oct 14, 2024
1 parent 6e8edaf commit 26022c1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion apps/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ The official [E2B documentation](https://e2b.dev/docs).
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.
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`.

0 comments on commit 26022c1

Please sign in to comment.