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

Documentation: PostComments editor component #61964

Merged

Conversation

colorful-tones
Copy link
Member

What? & Why?

Addresses one item in #60358

Adding documentation to existing editor components can help with any of the following:

  • encourages knowledge sharing and quicker onboarding for future devs
  • supports maintenance and troubleshooting
  • mitigates risk

How?

Add a JSDoc comment to the PostComments component and run npm run docs:build to populate the README with the newly added documents.

@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label May 24, 2024
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: colorful-tones <colorful-tones@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

Looks good, thank you!

@ntsekouras ntsekouras enabled auto-merge (squash) May 28, 2024 09:55
@ntsekouras ntsekouras merged commit 9142bf7 into WordPress:trunk May 28, 2024
67 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.5 milestone May 28, 2024
@colorful-tones colorful-tones deleted the add/postcomments-component-docs branch May 29, 2024 14:28
carstingaxion pushed a commit to carstingaxion/gutenberg that referenced this pull request Jun 4, 2024
* Add PostComments editor component JSDocs

* Auto-generate editor docs for PostComments addition
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
* Add PostComments editor component JSDocs

* Auto-generate editor docs for PostComments addition
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants