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

Improve docs formatting and fix filename conflicts #1666

Closed sarahraqueld closed 3 months ago

sarahraqueld commented 3 months ago

Problems

  1. There are a few markdown formatting errors, such as duplicate header and empty links.
  2. Cloning this repo on a case-insensitive file system (the default for macOS) results in the following message.
warning: the following paths have collided (e.g. case-sensitive paths
on a case-insensitive filesystem) and only one from the same
colliding group is in the working tree:

  'docs/src/SUMMARY.md'
  'docs/src/summary.md'

Solutions

  1. Add links and change header hierarchies
  2. Rename summary.md to intro.md

co-authored-by @smaboshe

sarahraqueld commented 3 months ago

The CI is failing with an unrelated issue, so we'll merge this and fix it in a separate PR.