Add Missing JSDocs and Docsite Links #6666
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
🦋 Changeset detectedLatest commit: 7d25775 The changes in this PR will be included in the next version bump. This PR includes changesets to release 40 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
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 7d25775:
|
la55u
reviewed
Sep 12, 2022
Merged
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.
📝 Description
Ensures that all Components, functions, and hooks that have detailed pages on the Chakra site have corresponding JSDocs and links back to the docsite via IDE intellisense.
Includes add/fixing links to related WAI-ARIA patterns.
⛳️ Current behavior (updates)
Some components, hooks, and functions did not have JSDocs and/or links back to their corresponding pages of the Chakra docsite.
🚀 New behavior
All components, hooks, and functions with corresponding docsite pages will now have JSDocs and site links for IDE intellisense viewing.
💣 Is this a breaking change (Yes/No):
No, as this does not change any functionality of the package.
📝 Additional Information
This is to help provide more accessibility of the package within the user's IDE. Only some of the components had JSDocs with site links.