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.

Sign up for GitHub

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
Jump to bottom

Documentation: Add EditorSnackbars component docs #61110

Merged
merged 2 commits into from
Apr 26, 2024
Merged

Documentation: Add EditorSnackbars component docs #61110

merged 2 commits into from
Apr 26, 2024

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 JSDocs formatted doc blocks to existing EditorSnackBars component.

Testing Instructions

Add a JSDoc comment to the EditorSnackBars 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 Apr 25, 2024
@colorful-tones colorful-tones self-assigned this Apr 25, 2024
@github-actions GitHub Actions
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 .

@colorful-tones
Copy link
Member Author

@ntsekouras I'm attempting another one 😄

@colorful-tones colorful-tones mentioned this pull request Apr 25, 2024
Closed
82 tasks
ntsekouras
ntsekouras approved these changes Apr 26, 2024
View reviewed changes
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 .

Awesome, thank you!

@ntsekouras ntsekouras merged commit e8878c1 into WordPress : trunk Apr 26, 2024
63 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.3 milestone Apr 26, 2024
huubl pushed a commit to huubl/gutenberg that referenced this pull request Apr 26, 2024
@colorful-tones @huubl
Documentation: Add EditorSnackbars component docs ( WordPress#61110 )
54603cb 
 * Add doc block for EditorSnackbars * Generate EditorSnackbars doc npm run docs:build
@colorful-tones colorful-tones deleted the add/editorsnackbars-docs branch April 26, 2024 15:06
Sign up for free to join this conversation on GitHub . Already have an account? Sign in to comment
Reviewers

@ntsekouras ntsekouras ntsekouras approved these changes

Assignees

@colorful-tones colorful-tones

Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 18.3
Development

Successfully merging this pull request may close these issues.
2 participants
@colorful-tones @ntsekouras