Revamp rustler_mix documentation #270
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
This is done in order to make the move of guides/Basics.md explicit.
scrogson
reviewed
Oct 28, 2019
evnu
force-pushed
the
rustler-mix-documentation
branch
from
85bb894
to
5bba2ea
Compare
scrogson
approved these changes
Oct 28, 2019
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.
I restructured the documentation for rustler_mix in an attempt to make it more accessible on hex.pm. For this, I merged the basic guide into the
README.md, made theREADME.mdas the main file forex_doc, replaceddefwithdefpfor internal functions, and removed internal modules from the output. Let me know what you think!