chore: hopefully final touches to README #304
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
Tweaks the ordering of the README sections a bit to make the examples more prominent and highlight the pattern matching earlier. Also adds an initial doc for advanced configuration. The README template generator will need to be tweaked to accommodate these changes but this feels like a better structure based on the feedback we got in the bug bash.
cprice404
requested review from
malandis,
pgautier404,
eaddingtonwhite and
poppoerika
poppoerika
previously approved these changes
Oct 12, 2022
cprice404
dismissed stale reviews from eaddingtonwhite, poppoerika, and pgautier404
via
0fc80ef
malandis
requested changes
Oct 13, 2022
Co-authored-by: Michael Landis <[email protected]>
malandis
approved these changes
Oct 13, 2022
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.
Tweaks the ordering of the README sections a bit to make the
examples more prominent and highlight the pattern matching
earlier.
Also adds an initial doc for advanced configuration.
The README template generator will need to be tweaked to
accommodate these changes but this feels like a better
structure based on the feedback we got in the bug bash.