Skip to content

Commit

Permalink
Fix/docs links (WordPress#10189)
Browse files Browse the repository at this point in the history
* docs: Fix plugins link in edit-post readme

* docs: Fix edit-post link in plugins readme

* docs: Update data-core-editor docs (auto-generate)
  • Loading branch information
SofiaSousa authored and mkaz committed Sep 26, 2018
1 parent 478b15c commit 3c32749
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
23 changes: 22 additions & 1 deletion docs/data/data-core-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -1253,6 +1253,19 @@ Returns whether or not the user has the unfiltered_html capability.

Whether the user can or can't post unfiltered HTML.

### isPublishSidebarEnabled

Returns whether the pre-publish panel should be shown
or skipped when the user clicks the "publish" button.

*Parameters*

* state: Global application state.

*Returns*

Whether the pre-publish panel should be shown or not.

## Actions

### setupEditor
Expand Down Expand Up @@ -1633,4 +1646,12 @@ Returns an action object used in signalling that the editor settings have been u

*Parameters*

* settings: Updated settings
* settings: Updated settings

### enablePublishSidebar

Returns an action object used in signalling that the user has enabled the publish sidebar.

### disablePublishSidebar

Returns an action object used in signalling that the user has disabled the publish sidebar.
6 changes: 3 additions & 3 deletions edit-post/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Extending the editor UI can be accomplished with the `registerPlugin` API, allowing you to define all your plugin's UI elements in one place.

Refer to [the plugins module documentation](../plugins/) for more information.
Refer to [the plugins module documentation](../packages/plugins/) for more information.

## Plugin Components

Expand Down Expand Up @@ -49,7 +49,7 @@ const doOnClick = ( ) => {
};

const MyPluginBlockSettingsMenuItem = () => (
<PluginBlockSettingsMenuItem
<PluginBlockSettingsMenuItem
allowedBlockNames=[ 'core/paragraph' ]
icon='dashicon-name'
label=__( 'Menu item text' )
Expand Down Expand Up @@ -424,7 +424,7 @@ Title displayed at the top of the panel.

##### initialOpen

Whether to have the panel initially opened. When no title is provided it is always opened.
Whether to have the panel initially opened. When no title is provided it is always opened.

- Type: `Boolean`
- Required: No
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This method takes two arguments:
or an element (or function returning an element) if you choose to render your own SVG.
- `render`: A component containing the UI elements to be rendered.

See [the edit-post module documentation](../edit-post/) for available components.
See [the edit-post module documentation](../../edit-post/) for available components.

_Example:_
{% codetabs %}
Expand Down

0 comments on commit 3c32749

Please sign in to comment.