Revamp the docs to make them easier to find #3151
Merged
+636
−393
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
Our README currently displays all the generators in collapsible lists, organized by their namespaces. This makes it harder to find which generators to use based on what I need. This commit: - shortens the README with links to appropriate docs, and highlights the features we provide - categorizes generators by use cases, for example: Finance, Person, Number, Location, Date, etc. I used faker-js as a reference. - creates a new generators doc listing all the generators by categories and namespaces
For locales updates, we review them to avoid merging harmful/offensive words. But for older locales, it's possible there might be some lingering.
stefannibrasil
force-pushed
the
sb-3150-revamp-docs
branch
from
0c3b95c to
2db50b4
Compare
stympy
approved these changes
Dec 2, 2025
Contributor
stympy
left a comment
stympy
left a comment
There was a problem hiding this comment.
This looks good to me. I made some suggestions for normalizing capitalization, and one typo fix.
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Co-authored-by: Benjamin Curtis <[email protected]>
Contributor
Author
|
thank you @stympy for the review 🎉 |
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.
Closes #3150
Our README currently displays all the generators in collapsible lists, organized by their namespaces.
This makes it harder to find which generators to use based on what one needs.
How
1 - categorize generators by use cases, for example: Finance, Person, Number, Location, Date, etc. I used faker-js as a reference.
2 - create a new generators doc listing all the generators by categories created in #1 and namespaces (as they currently are in https://github.com/faker-ruby/faker?tab=readme-ov-file#generators).
3 - re-organize the README by highlighting the categories and include a link to the doc from #2 to make our README shorter and more accessible.
The README was shortened and re-organized to keep important information easily accessible, with links to documents for more details.
From this work, I found out some generators that belong in a different namespace. But listing them by most popular categories might help mitigate that.
I also included some badges and kept the first lines focused on promoting the available generators: