Move documentation into mdBook #1570
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Some example renderings:
|
|
The deployment script comes from https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions#github-pages-deploy . |
|
Next steps after this PR is merged:
|
The `GETTING_STARTED.md` file has becoming increasingly hard to navigate, so split it into a book format. This uses the popular mdBook program to generate nice HTML from Markdown files. It also adds a GitHub Action to deploy an updated book when merging a branch into main. Barely any editing has been done to the documentation itself; the goal was to port it over and then improve it separately. (But I did remove "just" and "please" in some places.)
|
Confirmed that the GH Action works: https://thoughtbot.github.io/factory_bot/ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
GETTING_STARTED.mdfile has becoming increasingly hard to navigate, so split it into a book format. This uses the popular mdBook program to generate nice HTML from Markdown files.It also adds a GitHub Action to deploy an updated book when merging a branch into main.
Barely any editing has been done to the documentation itself; the goal was to port it over and then improve it separately. (But I did remove "just" and "please" in some places.)