Skip to content

Commit 4ee1d21

Browse files
authored
Improve docs formatting and fix filename conflicts (#1666)
* Rename summary.md to intro.md to avoid filenames clash * Fix duplicate headers and add section header links
1 parent 229246b commit 4ee1d21

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

docs/src/SUMMARY.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Summary
22

3-
[Intro](summary.md)
3+
[Intro](intro.md)
44

5-
# Reference
5+
## Reference
66

77
- [Build strategies](ref/build-strategies.md)
88
- [FactoryBot.find_definitions](ref/find_definitions.md)
@@ -21,19 +21,19 @@
2121
- [FactoryBot.lint](ref/lint.md)
2222
- [FactoryBot.register_strategy](ref/register_strategy.md)
2323

24-
# Guide
24+
## Guide
2525

2626
- [Setup](setup/summary.md)
2727
- [Using Without Bundler](using-without-bundler/summary.md)
2828
- [Rails Preloaders and RSpec](rails-preloaders-and-rspec/summary.md)
29-
- [Defining factories]()
29+
- [Defining factories](defining/summary.md)
3030
- [Factory name and attributes](defining/name-attributes.md)
3131
- [Specifying the class explicitly](defining/explicit-class.md)
3232
- [Definition file paths](defining/file-paths.md)
3333
- [Hash attributes](defining/hash-attributes.md)
3434
- [Best practices](defining/best-practices.md)
3535
- [Static Attributes (deprecated)](defining/static-attributes.md)
36-
- [Using factories]()
36+
- [Using factories](using-factories/summary.md)
3737
- [Build strategies](using-factories/build-strategies.md)
3838
- [Building or Creating Multiple Records](building-or-creating-multiple-records/summary.md)
3939
- [Attribute overrides](using-factories/attribute-overrides.md)
@@ -45,19 +45,19 @@
4545
- [With callbacks](transient-attributes/with-callbacks.md)
4646
- [With associations](transient-attributes/with-associations.md)
4747
- [Method Name / Reserved Word Attributes](method-name-reserved-word-attributes/summary.md)
48-
- [Inheritance]()
48+
- [Inheritance](inheritance/summary.md)
4949
- [Nested factories](inheritance/nested-factories.md)
5050
- [Assigning parent explicitly](inheritance/assigning-parent-explicitly.md)
5151
- [Best practices](inheritance/best-practices.md)
52-
- [Associations]()
52+
- [Associations](associations/summary.md)
5353
- [Implicit definition](associations/implicit-definition.md)
5454
- [Explicit definition](associations/explicit-definition.md)
5555
- [Inline definition](associations/inline-definition.md)
5656
- [Specifying the factory](associations/specifying-the-factory.md)
5757
- [Overriding attributes](associations/overriding-attributes.md)
5858
- [Association overrides](associations/association-overrides.md)
5959
- [Build strategies](associations/build-strategies.md)
60-
- [Sequences]()
60+
- [Sequences](sequences/summary.md)
6161
- [Global sequences](sequences/global-sequences.md)
6262
- [With dynamic attributes](sequences/with-dynamic-attributes.md)
6363
- [As implicit attributes](sequences/as-implicit-attributes.md)
@@ -89,7 +89,7 @@
8989
- [Custom Methods to Persist Objects](custom-methods-to-persist-objects/summary.md)
9090
- [ActiveSupport Instrumentation](activesupport-instrumentation/summary.md)
9191

92-
# Cookbook
92+
## Cookbook
9393

9494
- [`has_many` associations](cookbook/has_many-associations.md)
9595
- [`has_and_belongs_to_many` associations](cookbook/has_and_belongs_to_many-associations.md)

docs/src/summary.md docs/src/intro.md

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ software, and may be redistributed under the terms specified in the
2020

2121
[LICENSE]: https://github.com/thoughtbot/factory_bot/blob/main/LICENSE
2222

23-
2423
## About thoughtbot
2524

2625
factory_bot is maintained and funded by thoughtbot, inc.

0 commit comments

Comments
 (0)