Revamp the docs to make them easier to find #3150
Description
Why
This work is part of the larger ongoing work of improving faker’s performance and usability. We’re currently experimenting with using autoloading and Zeitwerk, and allowing the community to create their own Faker generators as external extensions.
Faker also has lots of generators and some are not easy to find. By reviewing the existing generators, we are discovering how to better organize them and decide which ones to load by default, versus optionally be loaded as extensions.
What
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.
How
1 - categorize generators by use cases, for example: Finance, Person, Number, Location, Date, etc. See 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