e2b-dev / E2B

Secure open source cloud runtime for AI apps & AI agents

https://e2b.dev/docs

Apache License 2.0

6.71k stars 428 forks source link

Generate API references workflow #449

Open 0div opened 1 week ago

0div commented 1 week ago

Description

For now, any diff in packages/ makes the workflow run each package's ./scripts/generate_api_ref.sh
Each of these scripts now also copies and creates the proper file structure, including versions, in apps/web/src/app/(docs)/docs/api-reference/
Boyscouting & Testing: Include Pty api ref to python sdk workflow & test if it triggers the workflow
Once the workflow generates the files, it auto-commits before the deploy
Created and integrated a prebuild step for the nextjs app it:
- generates routes for routes.tsx
- and generates TOC markowns for api-ref navigation component

Test

[x] Going to test it via this PR
[x] Deploy e2b-web

Considerations

Could make this on a per package basis.

changeset-bot[bot] commented 1 week ago

⚠️ No Changeset found

Latest commit: c7e79a579ecb5cc384525a5e09bc4c4cb9e0ab17

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR