improve README onboarding and project documentation - #230
Open
Draxsis wants to merge 1 commit into
Open
Conversation
|
@Draxsis is attempting to deploy a commit to the openai Team on Vercel. A member of the Team first needs to authorize it. |
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
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.
Summary
Improves the README to make AGENTS.md easier to understand and adopt for first-time visitors.
Changes
Motivation
The existing README explains the basic concept well, but new users have to infer how to get started and what kinds of instructions belong in an AGENTS.md file.
This update aims to make the project easier to understand within the first few moments of visiting the repository while keeping the documentation concise and approachable.
No functional changes are included.