Enhance README.md: Added Table of Contents, Grammar Improvements #421
Conversation
This file contains 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
ruben-arts
requested changes
Oct 28, 2023
baszalmstra
approved these changes
Oct 28, 2023
Co-authored-by: Bas Zalmstra <zalmstra.bas@gmail.com>
|
Hey @ruben-arts , I have done some changes, is it fine now, or I need to make further changes, I request you to please provide the feedback |
|
Check @baszalmstra request. Maybe if you think something is missing in the original toc you could add to that? But please remove it from the top. |
|
@ruben-arts I have removed that TOC from top and I don't see any issue with the existing one , so you please proceed further. |
|
Thank you @adarsh-jha-dev ! |
|
Thanks a lot for merging this. |
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 pull request aims to enhance the README.md file by making it more organized, reader-friendly, and grammatically correct. The improvements include the addition of a table of contents for easier navigation and various changes to refine the content.
Here's a summary of the changes made:
These changes should contribute to a more informative and polished README, improving the overall user experience for visitors to the repository. Your feedback and suggestions are highly appreciated.