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 PostURL component docs #61737

Merged
merged 6 commits into from
May 21, 2024
Merged

Documentation: Add PostURL component docs #61737

merged 6 commits into from
May 21, 2024

Conversation

kellenmace
Copy link
Contributor

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 the existing PostURL component.

Testing Instructions

Add a JSDoc comment to the PostURL component and run npm run docs:build to populate the README.md file with the newly added documentation.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 16, 2024 •
edited
Loading

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: kellenmace < kellenmace@git.wordpress.org > 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 .

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label May 16, 2024
@github-actions GitHub Actions
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @kellenmace ! In case you missed it, we'd love to have you join us in our Slack community .

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@colorful-tones colorful-tones mentioned this pull request May 16, 2024
Closed
82 tasks
@colorful-tones colorful-tones self-assigned this May 16, 2024
@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label May 17, 2024
@colorful-tones colorful-tones merged commit 538f18d into WordPress : trunk May 21, 2024
63 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.5 milestone May 21, 2024
carstingaxion pushed a commit to carstingaxion/gutenberg that referenced this pull request Jun 4, 2024
@kellenmace @colorful-tones @carstingaxion
Documentation: Add PostURL component docs ( WordPress#61737 )
8990c20 
 * Add JSDoc dockblock for PostURL component * Refine PostURL JSDocs * Add PostURLPanel JSDocs * Add PostURLLabel JSDocs * Add PostURLCheck JSDocs * Auto-generate editor docs for PostURL updates --------- Co-authored-by: Damon Cook < damonacook@gmail.com >
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
@kellenmace @colorful-tones @patil-vipul
Documentation: Add PostURL component docs ( WordPress#61737 )
c1721e3 
 * Add JSDoc dockblock for PostURL component * Refine PostURL JSDocs * Add PostURLPanel JSDocs * Add PostURLLabel JSDocs * Add PostURLCheck JSDocs * Auto-generate editor docs for PostURL updates --------- Co-authored-by: Damon Cook < damonacook@gmail.com >
Sign up for free to join this conversation on GitHub . Already have an account? Sign in to comment
Reviewers

@colorful-tones colorful-tones colorful-tones approved these changes

Assignees

@colorful-tones colorful-tones

Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 18.5
Development

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