Revamped get started guide to be more similar to typical libraries #953
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
chrisraygill
requested review from
kevinthecheung,
pavelgj,
tonybaroneee and
i2amsam
tonybaroneee
approved these changes
Sep 24, 2024
| // Make sure to include these imports: | ||
| // import { generate } from '@genkit-ai/ai'; | ||
| // import { configureGenkit } from '@genkit-ai/core'; | ||
| // import { googleAI, gemini15Flash } from '@genkit-ai/googleai'; |
There was a problem hiding this comment.
nit: I'd probably just leave these uncommented, it's easier for the dev to simply not copy them if they already have them, vs. copying then having to uncomment each one.
mjchristy
reviewed
Sep 25, 2024
Co-authored-by: Sam Phillips <samphillips@google.com>
kevinthecheung
approved these changes
Sep 25, 2024
pavelgj
reviewed
Sep 26, 2024
pavelgj
reviewed
Sep 26, 2024
|
|
||
| 1. Create a new Node project: | ||
| ```posix-terminal | ||
| npm install genkit @genkit-ai/ai @genkit-ai/core @genkit-ai/googleai |
There was a problem hiding this comment.
installing npm install genkit for CLI will need to make sure to say npx genkit ... for cli commands.
pavelgj
approved these changes
Sep 26, 2024
Co-authored-by: Pavel Jbanov <pavelj@google.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, our Get started guide uses
genkit initto set up a new Genkit project from scratch, but I think this is too magical. We should show that it's extremely simple to add Genkit to your project. This version of the Get started guide is much more similar to that of the Gemini API, and more similar to typical library / API quickstart guides.