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: add description of plugin support in the edit-site package #43049

Closed
t-hamano opened this issue Aug 7, 2022 · 1 comment
Closed
Assignees
Labels
[Package] Edit Site /packages/edit-site [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers

Comments

@t-hamano
Copy link
Contributor

t-hamano commented Aug 7, 2022

What problem does this address?

With #34460, the following basic plugin support has been added to the Site Editor:

  • PluginSidebar
  • PluginSidebarMoreMenuItem
  • PluginMoreMenuItem
  • openGeneralSidebar / closeGeneralSidebar store actions

If we use these with plugins, we need to use them differently depending on whether the post editor or the site editor, as follows:

// In the post editor
import { PluginSidebar, PluginSidebarMoreMenuItem } from '@wordpress/edit-post';
// In the site editor
import { PluginSidebar, PluginSidebarMoreMenuItem } from '@wordpress/edit-site';

However, it is not explicitly mentioned in the tutorial in the Block Editor Handbook, which may confuse developers, as seen in #38547.

What is your proposed solution?

I suggest the following documentation updates:

Add API description

Specify that the source package is different in the site editor

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers [Package] Edit Site /packages/edit-site labels Aug 7, 2022
@t-hamano t-hamano self-assigned this Aug 9, 2022
@github-actions github-actions bot added the [Status] In Progress Tracking issues with work in progress label Aug 10, 2022
@t-hamano
Copy link
Contributor Author

Closed for reasons stated in this comment.

@t-hamano t-hamano closed this as not planned Won't fix, can't repro, duplicate, stale Apr 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Edit Site /packages/edit-site [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant