docs: improve README for better usability & discoverability (#1671) #1806
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
earlduque
approved these changes
Oct 5, 2025
Contributor
earlduque
left a comment
earlduque
left a comment
There was a problem hiding this comment.
honestly all these changes are pretty good.
Contributor
|
@SinghCod3r, was this done by yourself or did you use an AI assistant? I'm genuinely curious because I wanted to know which one you used. |
Contributor
Author
|
Well, using ai agents are not prohibited, but I am doing the contribution from. Last 3 months so I don't use Ai. I use Copilot. Which directly comes with vs code . I take help from it. But most of the works are always mine. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This PR enhances the project’s README to make the repository more user-friendly and easier to navigate:
Added a “How to Use” section – step-by-step guide on locating, copying, and adapting snippets.
Table of Contents – quick links to major sections for faster navigation.
Finding Snippets – tips on searching by category, keyword, or tag.
Folder Structure & Naming Conventions – visual example of the required hierarchy for contributions.
Prominent Contribution Link – contribution guidelines linked at the top and expanded “What makes a good contribution?” checklist.These updates address issue Improve README for better usability & discoverability of snippets #1671 by improving discoverability and onboarding for new contributors and users.
Checklist