Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
arowla opened this issue Jul 5, 2024 · 2 comments
Open

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

arowla opened this issue Jul 5, 2024 · 2 comments

Comments

@arowla
Copy link

arowla commented Jul 5, 2024

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
Copy link
Contributor

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

@filipewl
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants