thoughtbot / thoughtbot/factory_bot

Please consider bringing back the old readme-style documentation

Open
#1,671 5 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Ruby
Stars
8.2k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current documentation structure and comparing it with the former GETTING_STARTED readme-style document. Define which examples and usage guidance should be brought together, then confirm that the resulting documentation is easier to browse and navigate without losing the existing coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.