search

thoughtbot / factory_bot

A library for setting up Ruby objects as test data.
https://thoughtbot.com
MIT License
7.91k stars 2.6k forks source link

Please consider bringing back the old readme-style documentation #1671

Open arowla opened 3 months ago

arowla commented 3 months ago

Please consider bringing back the old GETTING_STARTED readme-style doc. It was far easier to navigate and find examples and needed info. The new docs are split up so granularly that it's really hard to find what one is looking for, even for a longtime user of the gem. It used to be so easy and fun to scroll the doc and browse the examples for usage ideas. Sometimes I didn't even know which feature I needed, but by scrolling the examples, I could recognize something that would be helpful. Clicking through every page of the book is cumbersome and doesn't even come close to the old experience.

The old doc was one of the best in the business. Truly a joy to read and use. Please consider bringing it back.

sarahraqueld commented 2 months ago

Thanks for your feedback. We'll take that into consideration. I'm keen to hear opinions from others as well.

filipewl commented 1 month ago

I'd like to vouch for this as well. I've been a long time FactoryBot user that have been away for a few years and just now I needed to take a look at the documentation and the new cookbook felt visually limiting. I think @arowla was able to perfectly convey what I felt.

I found out https://github.com/thoughtbot/factory_bot/blob/9af6c6a5ba097e424663847f9478e314d464abd8/GETTING_STARTED.md is still available. Although it's marked as deprecated, I guess it's something I can use to start my exploration.