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

feat: add documentation site #62

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

tylerslaton
Copy link
Contributor

@tylerslaton tylerslaton commented Feb 22, 2024

This PR uses docusaurus to add a documentation site for gptscript.

Deployment of this will come after this review. To look at the site running, just run cd docs && npm start.


## Overview

The `image-generation` tool leverages OpenAI's Dall-E model to convert textual descriptions into images. It offers a versatile approach to creating visual content, making it suitable for a wide range of applications, from content creation to design assistance.
Copy link
Member

Choose a reason for hiding this comment

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

Just to format the model's name more like OpenAI does:

Suggested change
The `image-generation` tool leverages OpenAI's Dall-E model to convert textual descriptions into images. It offers a versatile approach to creating visual content, making it suitable for a wide range of applications, from content creation to design assistance.
The `image-generation` tool leverages OpenAI's DALL·E model to convert textual descriptions into images. It offers a versatile approach to creating visual content, making it suitable for a wide range of applications, from content creation to design assistance.

For more information, check out the tool [here](https://github.com/gptscript-ai/image-generation)

## Usage
To use the Image Generation too, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To use the Image Generation too, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one.
To use the Image Generation tool, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one.

Signed-off-by: tylerslaton <mtslaton1@gmail.com>
Copy link
Contributor

@cloudnautique cloudnautique left a comment

Choose a reason for hiding this comment

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

It's wired up to deploy and iterate on.

@tylerslaton tylerslaton merged commit 7608a51 into gptscript-ai:main Feb 23, 2024
1 check passed
@tylerslaton tylerslaton deleted the add-docs-site branch February 23, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants