Skip to content

Update dotprompt doc to clarify that it is a genkit plugin #110

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.

Sign up for GitHub

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

Merged
maxl0rd merged 1 commit into from
May 10, 2024
Merged

Update dotprompt doc to clarify that it is a genkit plugin #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/dotprompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Managing prompts with Dotprompt

Firebase Genkit provides the Dotprompt library and text format to help you write
Firebase Genkit provides the Dotprompt plugin and text format to help you write
and organize your generative AI prompts.

Dotprompt is designed around the premise that _prompts are code_. You write and
Expand Down Expand Up @@ -32,11 +32,13 @@ You are the world's most welcoming AI assistant and are currently working at {{l
Greet a guest{{#if name}} named {{name}}{{/if}}{{#if style}} in the style of {{style}}{{/if}}.
```

To use this prompt, import the `prompt` function from the `@genkit-ai/dotprompt`
library:
To use this prompt, install the `dotprompt` plugin, and import the `prompt` function from
the `@genkit-ai/dotprompt` library:

```ts
import { prompt } from '@genkit-ai/dotprompt';
import { dotprompt, prompt } from '@genkit-ai/dotprompt';

configureGenkit({ plugins: [dotprompt()] });
```

Then, load the prompt using `prompt('file_name')`:
Expand Down