e2b-dev / E2B

Secure open source cloud runtime for AI apps & AI agents

https://e2b.dev/docs

Apache License 2.0

7.02k stars 458 forks source link

Auto-generate API reference markdown files for the CLI #448

Closed 0div closed 1 month ago

0div commented 1 month ago

Description

upgraded the -cmd2json root option to -cmd2md
it calls a commands2md utils custom function that converts command objects to Markdown documentation
this function writes all root command documentation files into the api_ref/
boyscouting: added root .prettierrc

Test

cd packages/cli
./scripts/generate_api_ref.sh 
ls ./api_ref

Considerations

This could eventually be used directly as .mdx in the docs nextjs app, it would look like this with current styling and TOC:

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: b70975fee1b2eb0cd1da49b98fe706d36d6661d9

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