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

commented Jul 16, 2019

Description

Adds documentation for the PluginDocumentSettingPanel SlotFill. Closes #16619

Types of changes

Documentation

ryanwelcher added some commits Oct 25, 2018

@ryanwelcher ryanwelcher requested review from mkaz and youknowriad as code owners Jul 16, 2019

ryanwelcher added some commits Jul 16, 2019

@chrisvanpatten

This comment has been minimized.

Copy link
Member

commented Jul 16, 2019

🚢 !

@ryanwelcher ryanwelcher self-assigned this Jul 17, 2019

title="Custom Panel"
className="custom-panel"
>
Custom Panel Contents

This comment has been minimized.

Copy link
@youknowriad

youknowriad Jul 18, 2019

Contributor

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

This comment has been minimized.

Copy link
@ryanwelcher

ryanwelcher Jul 19, 2019

Author Contributor

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

This comment has been minimized.

Copy link
@youknowriad

youknowriad Jul 20, 2019

Contributor

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 👍

This comment has been minimized.

Copy link
@chrisvanpatten

chrisvanpatten Jul 20, 2019

Member

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!)

@youknowriad youknowriad merged commit fc0b94b into WordPress:master Jul 26, 2019

1 check passed

Travis CI - Pull Request Build Passed
Details

@github-actions github-actions bot added this to the Gutenberg 6.2 milestone Jul 26, 2019

sbardian added a commit to sbardian/gutenberg that referenced this pull request Jul 29, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.