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: PageTemplate + PostTemplatePanel editor components #61961

Merged

Conversation

colorful-tones
Copy link
Member

What? & Why?

Addresses two items 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 PageTemplate and PostTemplatePanel components and run npm run docs:build to populate the README with the newly added documents.

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.

@ntsekouras ntsekouras merged commit a062fdf into WordPress:trunk May 28, 2024
66 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.5 milestone May 28, 2024
carstingaxion pushed a commit to carstingaxion/gutenberg that referenced this pull request Jun 4, 2024
…rdPress#61961)

* Add PostTemplatePanel editor JSDocs

* Add ClassicThemeControl editor component JSDocs

* Auto-generate editor docs for ClassicThemeControl + PostTemplatePanel
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
…rdPress#61961)

* Add PostTemplatePanel editor JSDocs

* Add ClassicThemeControl editor component JSDocs

* Auto-generate editor docs for ClassicThemeControl + PostTemplatePanel
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.

None yet

2 participants