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: PostExcerptPanel editor component #61967

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 PostExcerptPanel 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

github-actions bot commented May 24, 2024

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 <[email protected]>
Co-authored-by: ntsekouras <[email protected]>
Co-authored-by: Mamaduka <[email protected]>

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

@colorful-tones colorful-tones enabled auto-merge (squash) May 29, 2024 14:57
@colorful-tones colorful-tones requested a review from ntsekouras May 29, 2024 14:57
@colorful-tones colorful-tones merged commit f941f0c into WordPress:trunk May 30, 2024
60 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.5 milestone May 30, 2024
carstingaxion pushed a commit to carstingaxion/gutenberg that referenced this pull request Jun 4, 2024
* Add PostExcerptPanel editor component JSDocs

* Auto-generate editor docs for PostExcerptPanel component

* Refine PostExcerptPanel editor component JSDocs

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

* Auto-generate editor docs for PostExcerptPanel component

* Refine PostExcerptPanel editor component JSDocs

* Auto-generate editor docs for PostExcerptPanel updates
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.

3 participants