Skip to content
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

Merged
merged 7 commits into from
Jan 22, 2024

Conversation

stevenslack
Copy link
Contributor

@stevenslack stevenslack commented Jan 19, 2024

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.

  • Update the README.md for block-editor-tools to include all available components, hooks, and services.
  • Ensure there is a centralized documentation available in the root README
  • Follow the format similar to WordPress API docs in READMEs.

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:

  • I have updated the documentation accordingly.
  • My changes generate no new warnings or errors.
  • I have added tests to cover my changes. (unnecessary, documentation changes only)

Link to README in this PR:

https://github.com/alleyinteractive/alley-scripts/blob/c84cd840f1758f04c92c87729a7dc60e0723a3e7/packages/block-editor-tools/README.md

Copy link

changeset-bot bot commented Jan 19, 2024

🦋 Changeset detected

Latest commit: 774c10d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@alleyinteractive/block-editor-tools Patch

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

@stevenslack stevenslack marked this pull request as ready for review January 19, 2024 21:04
@stevenslack stevenslack requested a review from a team as a code owner January 19, 2024 21:04
Copy link
Contributor

@mogmarsh mogmarsh left a 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 👍

packages/block-editor-tools/README.md Outdated Show resolved Hide resolved
packages/block-editor-tools/README.md Outdated Show resolved Hide resolved
```

### useDebounce

Copy link
Contributor

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?

Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stevenslack and others added 2 commits January 22, 2024 12:38
Co-authored-by: Greg Marshall <mogmarsh@users.noreply.github.com>
Co-authored-by: Greg Marshall <mogmarsh@users.noreply.github.com>
@stevenslack
Copy link
Contributor Author

@mogmarsh thanks, this is a step towards getting our docs more visible while this issue #20 will address adding these tools to the storybook.

…ithub.com:alleyinteractive/alley-scripts into docs/issue-499/block-editor-tools-incomplete-docs
@stevenslack stevenslack merged commit 634548d into main Jan 22, 2024
5 checks passed
@stevenslack stevenslack deleted the docs/issue-499/block-editor-tools-incomplete-docs branch January 22, 2024 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants