docs: better formatting for README #108
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
chadoh
force-pushed
the
docs/readme-formatting
branch
from
b7e57a6 to
afac49f
Compare
This improves the Markdown formatting in multiple ways. Most notably, it nests things correctly under numbered lists, and makes the whole thing more readable _as markdown_, rather than needing to be rendered to HTML to be easily-readable (that's the point of Markdown, after all). It also makes it more clear that there are two options for running the backend, and double-highlights that you need to run `make build-docker`, because I missed that for way too long personally 🙃 This also increases most heading sizes and uses the underline syntax for h1 & h2, again improving readability as both markdown & html versions.
chadoh
force-pushed
the
docs/readme-formatting
branch
from
afac49f to
145b74e
Compare
|
Thanks @chadoh! |
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.
This improves the Markdown formatting in multiple ways. Most notably, it nests things correctly under numbered lists, and makes the whole thing more readable as markdown, rather than needing to be rendered to HTML to be easily-readable (that's the point of Markdown, after all).
It also makes it more clear that there are two options for running the backend, and double-highlights that you need to run
make build-docker, because I missed that for way too long personally 🙃