Refactor README to rely on official documentation more #93
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
oleiade
requested review from
mstoykov and
codebien
and removed request for
a team
dgzlopes
reviewed
Mar 18, 2024
mstoykov
approved these changes
Mar 18, 2024
Co-authored-by: Daniel González Lopes <[email protected]>
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.
Based on feedback from @dgzlopes, this PR refactors our README which so far had the tendency to exhibit outdated/malformed examples.
This PR drops examples, and adds more direct links to official documentation instead, so we only have to maintain documentation in a single place instead. Please let me know if you can think of further improvements 👍🏻