Conversation
This adds some more details about the design and reasoning behind the library, along with some cleanup of contribution guidelines. Due to the nature of embedding images within the repo, the embedded images will only show up when the pull request is merged, but will appear broken in the pull request.
Contributor
|
A lot of good info here. I would restructure to highlight:
The current structure loses me pretty quickly because of the wall of text. I would refactor it by adding a bunch of headings that make it flow a bit better. A few great examples:
|
Contributor
|
Btw, feel free to merge this and iterate. Maybe it looks a bit cleaner with images loaded. |
This file contains hidden or 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.
This adds some more details about the design and reasoning behind the library, along with some cleanup of contribution guidelines.
Due to the nature of embedding images within the repo, the embedded images will only show up when the pull request is merged, but will appear broken in the pull request.