Add OpenAI Plugin Example #10
Conversation
vulus98
commented
May 12, 2024
•
vulus98
commented
- Address the latest comments on the README
|
Filled in the readme both for plugin and for examples |
examples/openai/README.md
Outdated
| ## Contributing | ||
| If you want to contribute to the OpenAI plugin, you can link to a local instance of the plugin by running `npm link` in the plugin directory and `npm link genkitx-openai-plugin` in the examples directory. |
There was a problem hiding this comment.
in order to prevent this from getting buried, I'd consider putting the usage examples in a separate doc that gets linked in the examples/openai/README.md file
This will also be useful if we move to a structure where we have examples for all plugins in one package
There was a problem hiding this comment.
I couldn't find the markdown support for it, only some external tools that allow that. If I got you right, you want the same content, but would like to separate the usage examples in the new markdown file which gets imported in our README.md?
There was a problem hiding this comment.
Or to omit the examples in the main README and just link to other .md file which will contain them?
There was a problem hiding this comment.
Why not: [Usage examples OpenAI Plugin](docs/usage_openai.md)?
I'd be in favor of the latter. so we can link to docs/usage_openai.md and other ones. lmk if this makes sense
|
Check currently fail as it checks if the genkit version is 11, but we updated it to 12 in the code. I'll leave it to you to change this test and be aware of this change before merging |
