Improve README for better readability and structure - #86
Open
Dippp10-ally wants to merge 1 commit into
Open
Conversation
Enhance README with formatting notes and suggested structure.
|
@Dippp10-ally is attempting to deploy a commit to the Tejas Sharma's projects Team on Vercel. A member of the Team first needs to authorize it. |
Author
|
@TejasSharma356 ji , do assign labels called as gssoc:approved , level:intermediate, type:docs , quality:exceptional to above pull request number 86 also......do merge above pull request number 86 also..... |
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.
Description
Enhanced the project README by adding formatting recommendations and a suggested documentation structure. The proposed improvements focus on making the README more organized, readable, and contributor-friendly. Suggestions include a clearer project overview, consistent section hierarchy, improved installation and usage instructions, contribution guidelines, project structure, and general Markdown formatting best practices to improve the onboarding experience.
Related Issue(s)
Fixes #85
Type of Change
Architecture Impact
Checklist:
Screenshots (if applicable)
N/A – This PR contains documentation improvements only and does not introduce UI changes.