-
Notifications
You must be signed in to change notification settings - Fork 84
docs: update usage docs #7732
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: update usage docs #7732
+30
−6
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
a7a4159 to
bbbd7a6
Compare
edleeks87
reviewed
Jan 23, 2026
Contributor
edleeks87
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for raising this @tomdavies73 definitely fills a gap in our docs
Contributor
DipperTheDan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing more to add from me. Just address all the points made by @edleeks87.
bbbd7a6 to
f0b8012
Compare
edleeks87
reviewed
Jan 27, 2026
f0b8012 to
83923e4
Compare
edleeks87
approved these changes
Jan 27, 2026
DipperTheDan
approved these changes
Jan 27, 2026
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.
Proposed behaviour
Updates the usage docs to remove any mentions of prop types and offer direct guidance regarding component imports.
Current behaviour
N/A
Checklist
d.tsfile added or updated if requiredQA
Additional context
Testing instructions