Update logic to upgrade documentation quality#16
Merged
betogaona7 merged 6 commits intomainfrom Aug 9, 2023
Merged
Conversation
This file contains hidden or 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
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.
This PR splits documentation logic in two parts:
Both of them uses
gpt-4due to the limitations ofgpt-3.5to handle the extraction and generation.The PR also fixes the logic behind generating READMEs by adding appropriate templates that suits the tasks better.
The PR also introduces updates in the README, hallucination checks, use of
.envfile, and minor changes in the overall logic.Closes #1