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.

Sign up for GitHub

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

Improve docs formatting and fix filename conflicts #1666

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Improve docs formatting and fix filename conflicts #1666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c44fcb
Rename summary.md to intro.md to avoid filenames clash
sarahraqueld Jun 21, 2024
c1dfcb1
Fix duplicate headers and add section header links
sarahraqueld Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Summary

[Intro](summary.md)
[Intro](intro.md)

# Reference
## Reference

- [Build strategies](ref/build-strategies.md)
- [FactoryBot.find_definitions](ref/find_definitions.md)
Expand All @@ -21,19 +21,19 @@
- [FactoryBot.lint](ref/lint.md)
- [FactoryBot.register_strategy](ref/register_strategy.md)

# Guide
## Guide

- [Setup](setup/summary.md)
- [Using Without Bundler](using-without-bundler/summary.md)
- [Rails Preloaders and RSpec](rails-preloaders-and-rspec/summary.md)
- [Defining factories]()
- [Defining factories](defining/summary.md)
- [Factory name and attributes](defining/name-attributes.md)
- [Specifying the class explicitly](defining/explicit-class.md)
- [Definition file paths](defining/file-paths.md)
- [Hash attributes](defining/hash-attributes.md)
- [Best practices](defining/best-practices.md)
- [Static Attributes (deprecated)](defining/static-attributes.md)
- [Using factories]()
- [Using factories](using-factories/summary.md)
- [Build strategies](using-factories/build-strategies.md)
- [Building or Creating Multiple Records](building-or-creating-multiple-records/summary.md)
- [Attribute overrides](using-factories/attribute-overrides.md)
Expand All @@ -45,19 +45,19 @@
- [With callbacks](transient-attributes/with-callbacks.md)
- [With associations](transient-attributes/with-associations.md)
- [Method Name / Reserved Word Attributes](method-name-reserved-word-attributes/summary.md)
- [Inheritance]()
- [Inheritance](inheritance/summary.md)
- [Nested factories](inheritance/nested-factories.md)
- [Assigning parent explicitly](inheritance/assigning-parent-explicitly.md)
- [Best practices](inheritance/best-practices.md)
- [Associations]()
- [Associations](associations/summary.md)
- [Implicit definition](associations/implicit-definition.md)
- [Explicit definition](associations/explicit-definition.md)
- [Inline definition](associations/inline-definition.md)
- [Specifying the factory](associations/specifying-the-factory.md)
- [Overriding attributes](associations/overriding-attributes.md)
- [Association overrides](associations/association-overrides.md)
- [Build strategies](associations/build-strategies.md)
- [Sequences]()
- [Sequences](sequences/summary.md)
- [Global sequences](sequences/global-sequences.md)
- [With dynamic attributes](sequences/with-dynamic-attributes.md)
- [As implicit attributes](sequences/as-implicit-attributes.md)
Expand Down Expand Up @@ -89,7 +89,7 @@
- [Custom Methods to Persist Objects](custom-methods-to-persist-objects/summary.md)
- [ActiveSupport Instrumentation](activesupport-instrumentation/summary.md)

# Cookbook
## Cookbook

- [`has_many` associations](cookbook/has_many-associations.md)
- [`has_and_belongs_to_many` associations](cookbook/has_and_belongs_to_many-associations.md)
Expand Down
1 change: 0 additions & 1 deletion docs/src/summary.md → docs/src/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ software, and may be redistributed under the terms specified in the

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


## About thoughtbot

factory_bot is maintained and funded by thoughtbot, inc.
Expand Down
Loading