revise docs per request #13
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
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.
@g4brielvs this PR revises the documentation to match the .docx file we were sent as closely as possible (e.g., hex colors for the text match those in the .docx file).
This simplifies the documentation to a single page, but at least in the rendered jupyter book the right sidebar allows for easy navigation to the different sections.
The rendering of the markdown in GitHub's readme section is 90% of the way there, but doesn't display the color text formatting which does appear in the rendered jupyter book.
Please have a look and review at your earliest convenience, thanks.