Skip to content

[TRI-1430] : Improve the OpenAI integration documentation - #673

Merged
D-K-P merged 1 commit into
triggerdotdev:mainfrom
Rutam21:TRI-1430
Oct 23, 2023
Merged

[TRI-1430] : Improve the OpenAI integration documentation#673
D-K-P merged 1 commit into
triggerdotdev:mainfrom
Rutam21:TRI-1430

Conversation

@Rutam21

@Rutam21 Rutam21 commented Oct 20, 2023

Copy link
Copy Markdown
Contributor

Closes #664

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the docs site and it works properly.

Testing

I locally deployed the Docs Website using Netlify and verified all the changes.

Video Snapshot

OpenAI.mp4

Changelog

The OpenAI Documentation has been updated such that it follows the same format as the GitHub Integration.

OpenAI Documentation is now divided into two sections.

  • OpenAI Overview and Authentication
  • OpenAI tasks
  • Code snippets have been added for all available OpenAI tasks that were previously not there.

Screenshots

Overview and Authentication Page

overview

Tasks Page

tasks1

tasks2

@changeset-bot

changeset-bot Bot commented Oct 20, 2023

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8718b28

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

@Rutam21

Rutam21 commented Oct 20, 2023

Copy link
Copy Markdown
Contributor Author

This PR exactly follows the GitHub Integration format.

  • An overview section has been added based on the official Resend Site.
  • Both the Overview and Tasks pages have been separated properly.
  • Comments have been added to all the code blocks for better understanding.
  • Code snippets for all tasks have been added that were previously not there.

Please review and suggest changes, if any. Thanks.

cc: @D-K-P

@D-K-P

D-K-P commented Oct 23, 2023

Copy link
Copy Markdown
Member

This is close enough so will merge. I will make some changes and then show you what I did. Thanks!

@D-K-P
D-K-P merged commit 1343003 into triggerdotdev:main Oct 23, 2023
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.

[TRI-1430] Improve the OpenAI integration documentation

2 participants