-
Notifications
You must be signed in to change notification settings - Fork 1
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
Issue-499: block editor tools components, hooks, and services have incomplete documentation #534
Issue-499: block editor tools components, hooks, and services have incomplete documentation #534
Conversation
🦋 Changeset detectedLatest commit: 774c10d The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
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.
👍 this helps a lot! at some point we probably need to find or create a style guide and make sure everything is consistent, but this definitely moves us forward 👍
``` | ||
|
||
### useDebounce | ||
|
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.
should we mark this as DEPRECATED right here, in case someone doesn't visit the issue?
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.
I guess we haven't actually deprecated it yet... so this should happen as part of that issue.
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.
Co-authored-by: Greg Marshall <mogmarsh@users.noreply.github.com>
Co-authored-by: Greg Marshall <mogmarsh@users.noreply.github.com>
…ithub.com:alleyinteractive/alley-scripts into docs/issue-499/block-editor-tools-incomplete-docs
Related Issue
Related to Issue #499
Description of the Change
This PR adds all available components, hooks, and services READMEs to the root README so it can be accessible in the published NPM package.
block-editor-tools
to include all available components, hooks, and services.Additional Information
Please refer to the example of WordPress package API docs here: https://github.com/WordPress/gutenberg/tree/trunk/packages/block-editor#api
Checklist:
Link to README in this PR:
https://github.com/alleyinteractive/alley-scripts/blob/c84cd840f1758f04c92c87729a7dc60e0723a3e7/packages/block-editor-tools/README.md