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

Fix/plugin document setting panel docs #16620

Merged

Conversation

ryanwelcher
Copy link
Contributor

Description

Adds documentation for the PluginDocumentSettingPanel SlotFill. Closes #16619

Types of changes

Documentation

Ryan Welcher added 27 commits October 25, 2018 16:47
@chrisvanpatten
Copy link
Contributor

🚢 !

@Soean Soean added the [Type] Developer Documentation Documentation for developers label Jul 17, 2019
@ryanwelcher ryanwelcher self-assigned this Jul 17, 2019
title="Custom Panel"
className="custom-panel"
>
Custom Panel Contents
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe an example to edit a document setting (a meta field for instance) could be more valuable?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great suggestion - perhaps we should apply this feedback to the other docs for SlotFill as well.

Copy link
Contributor

@youknowriad youknowriad Jul 20, 2019

Choose a reason for hiding this comment

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

Yeah, that makes sense.

Also, I feel having a "slotfills" category/section in the docs is also a bit misleading. I'd personally prefer extensibility options organized in a more "semantic way".

Instead of SlotFills section, we could have:

  • Block extensibilty APIs
  • Publishing flow extensibiltiy APIs
  • Document extensibility APIs

we could continue these adaptations separately.

Thanks for the update on this one 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if there is an automated way to do that, via some kind of jsdoc tag to move slotfills into a more self-documented approach? (Just a musing!)

@gziolo gziolo added the [Feature] Extensibility The ability to extend blocks or the editing experience label Jul 22, 2019
@youknowriad youknowriad merged commit fc0b94b into WordPress:master Jul 26, 2019
@github-actions github-actions bot added this to the Gutenberg 6.2 milestone Jul 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Extensibility The ability to extend blocks or the editing experience [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for PluginDocumentSettingPanel SlotFill is missing
5 participants