docs: Improve README files #9
Open
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
- Add License and Project Structure sections to the main README.md - Clarify setup instructions in the main README.md - Add introduction and environment variables explanation to few-shot/README.md - Add introduction and prerequisites to general-knowledge/README.md
- Add file-level docstring to self-edit.py and eval-self-edits.py - Add comments to get_test_time_train_data function in self-edit.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add License and Project Structure sections to the main README.md
Clarify setup instructions in the main README.md
Add introduction and environment variables explanation to few-shot/README.md
Add introduction and prerequisites to general-knowledge/README.md