Repository navigation
Reorder README: lead with Use Cases, demote 1.x migration - #23
Merged
Merged
Conversation
- Move Use Cases up to right after the pitch, before Installation - it's the section that answers "why would I want this," not reference material to reach after several other sections - Move Migrating from 1.x down, after Error Handling - relevant to a shrinking minority of readers, was previously the 3rd section - Fold the top-of-file "Heads up" breaking-change banner into the Migrating from 1.x section itself; replace it with a one-line pointer for readers coming from 1.x - Reorder the Table of Contents and Supported Operations/ Restricting Available Functions to match
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
1 participant
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.
Pure reorder, no content lost - headings unchanged so all anchor links remain valid.