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

Use OpenAI API to improve bot-discord docs #4657

Merged
merged 7 commits into from
Apr 4, 2023
Merged

Conversation

DidierRLopes
Copy link
Collaborator

@DidierRLopes DidierRLopes commented Apr 2, 2023

Description

  • Attempts to improve bot documentation utilizing OpenAI API and using the following prompt:
Context: You are a developer writing a detailed documentation for a function that allows the user to retrieve {desc} utilizing the command {example} how would you explain what this command does in a single paragraph

where {desc} and {example} corresponds to the current description and example that each of our commands have, respectively.

The motivation was to improve our documentation, and having more quality data for training our own bot LLM.

Screenshot 2023-04-01 at 10 41 25 PM

How has this been tested?

Just scrolled through discord documentation to make sure it looked ok. @andrewkenreich can you review and update accordingly?

Once you are happy with these, I will port them to telegram commands as well.

@reviewpad reviewpad bot added the feat XL Extra Large feature label Apr 2, 2023
Copy link
Contributor

@andrewkenreich andrewkenreich left a comment

Choose a reason for hiding this comment

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

please review my reviews

Copy link
Collaborator Author

@DidierRLopes DidierRLopes left a comment

Choose a reason for hiding this comment

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

missing spacing 😄

@reviewpad
Copy link

reviewpad bot commented Apr 4, 2023

Reviewpad Report (Reviewpad ran in dry-run mode because configuration has changed)

📜 Executed actions

$removeLabels(["feat XS", "feat S", "feat M", "feat L"])
$addLabel("feat XL")

@DidierRLopes DidierRLopes added this pull request to the merge queue Apr 4, 2023
Merged via the queue into develop with commit 245a740 Apr 4, 2023
jmaslek pushed a commit that referenced this pull request Apr 13, 2023
* Use OpenAI API to improve bot-discord docs

* almost done.....

* last edits

* final fixes with updated index

* spacing

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
@piiq piiq deleted the improve-bot-docs branch April 24, 2023 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat XL Extra Large feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants