Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs-util: added AI generator #6770

Merged
merged 25 commits into from
Mar 28, 2024
Merged

docs-util: added AI generator #6770

merged 25 commits into from
Mar 28, 2024

Conversation

shahednasser
Copy link
Member

What

Adds an AI generator to the docblock tool that uses OpenAI.

The generator at the moment only generates examples for functions when the --generate-examples option is provided.

Note

I've included the generated examples of the IOrderModuleService as a reference of the type of result provided by the AI generator, with minor tweeks I've made. I haven't made any changes to descriptions in that file.

Copy link

changeset-bot bot commented Mar 21, 2024

⚠️ No Changeset found

Latest commit: 6669312

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

Copy link

vercel bot commented Mar 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 28, 2024 11:18am
3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Mar 28, 2024 11:18am
docs-ui ⬜️ Ignored (Inspect) Visit Preview Mar 28, 2024 11:18am
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Mar 28, 2024 11:18am

Copy link
Contributor

@olivermrbl olivermrbl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@kodiakhq kodiakhq bot merged commit 21156f9 into develop Mar 28, 2024
24 checks passed
@kodiakhq kodiakhq bot deleted the docs-util/example-generator branch March 28, 2024 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants