docs: acknowledge peer dependency requirements #1131
Merged
Conversation
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
| This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit eae8b66:
|
Codecov Report
@@ Coverage Diff @@ ## main #1131 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 4 4 Lines 181 181 Branches 36 36 ========================================= Hits 181 181
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| @all-contributors add @stephensauceda for docs |
| I've put up a pull request to add @stephensauceda! 🎉 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
What:
Updating the docs to include React peer dependency requirements.
Why:
Trying to install newer versions of the library with older versions of React causes an installation error
How:
Added instructions on how to install the older version of the library when older versions of React are needed.
Checklist:
docs site
ref #1111