Documentation: Generate Docs for the data module

docs/data/core-blocks.md

@@ -0,0 +1,82 @@
+# **core/blocks**: Block Types Data
+
+## Selectors 
+
+### getBlockType
+
+Returns a block type by name.
+
+*Parameters*
+
+ * state: Data state.
+ * name: Block type name.
+
+### getCategories
+
+Returns all the available categories.
+
+*Parameters*
+
+ * state: Data state.
+
+*Returns*
+
+Categories list.
+
+### getDefaultBlockName
+
+Returns the name of the default block name.
+
+*Parameters*
+
+ * state: Data state.
+
+*Returns*
+
+Default block name.
+
+### getFallbackBlockName
+
+Returns the name of the fallback block name.
+
+*Parameters*
+
+ * state: Data state.
+
+*Returns*
+
+Fallback block name.
+
+## Actions
+
+### addBlockTypes
+
+Returns an action object used in signalling that block types have been added.
+
+*Parameters*
+
+ * blockTypes: Block types received.
+
+### removeBlockTypes
+
+Returns an action object used to remove a registered block type.
+
+*Parameters*
+
+ * names: Block name.
+
+### setDefaultBlockName
+
+Returns an action object used to set the default block name.
+
+*Parameters*
+
+ * name: Block name.
+
+### setFallbackBlockName
+
+Returns an action object used to set the fallback block name.
+
+*Parameters*
+
+ * name: Block name.

docs/data/core-edit-post.md

@@ -0,0 +1,245 @@
+# **core/edit-post**: The Editor's UI Data
+
+## Selectors 
+
+### getEditorMode
+
+Returns the current editing mode.
+
+*Parameters*
+
+ * state: Global application state.
+
+### isEditorSidebarOpened
+
+Returns true if the editor sidebar is opened.
+
+*Parameters*
+
+ * state: Global application state
+
+*Returns*
+
+Whether the editor sidebar is opened.
+
+### isPluginSidebarOpened
+
+Returns true if the plugin sidebar is opened.
+
+*Parameters*
+
+ * state: Global application state
+
+*Returns*
+
+Whether the plugin sidebar is opened.
+
+### getActiveGeneralSidebarName
+
+Returns the current active general sidebar name.
+
+*Parameters*
+
+ * state: Global application state.
+
+*Returns*
+
+Active general sidebar name.
+
+### getPreferences
+
+Returns the preferences (these preferences are persisted locally).
+
+*Parameters*
+
+ * state: Global application state.
+
+*Returns*
+
+Preferences Object.
+
+### getPreference
+
+*Parameters*
+
+ * state: Global application state.
+ * preferenceKey: Preference Key.
+ * defaultValue: Default Value.
+
+*Returns*
+
+Preference Value.
+
+### isPublishSidebarOpened
+
+Returns true if the publish sidebar is opened.
+
+*Parameters*
+
+ * state: Global application state
+
+*Returns*
+
+Whether the publish sidebar is open.
+
+### isEditorSidebarPanelOpened
+
+Returns true if the editor sidebar panel is open, or false otherwise.
+
+*Parameters*
+
+ * state: Global application state.
+ * panel: Sidebar panel name.
+
+*Returns*
+
+Whether the sidebar panel is open.
+
+### isFeatureActive
+
+Returns whether the given feature is enabled or not.
+
+*Parameters*
+
+ * state: Global application state.
+ * feature: Feature slug.
+
+*Returns*
+
+Is active.
+
+### isPluginItemPinned
+
+Returns true if the the plugin item is pinned to the header.
+When the value is not set it defaults to true.
+
+*Parameters*
+
+ * state: Global application state.
+ * pluginName: Plugin item name.
+
+*Returns*
+
+Whether the plugin item is pinned.
+
+### getMetaBoxes
+
+Returns the state of legacy meta boxes.
+
+*Parameters*
+
+ * state: Global application state.
+
+*Returns*
+
+State of meta boxes.
+
+### getMetaBox
+
+Returns the state of legacy meta boxes.
+
+*Parameters*
+
+ * state: Global application state.
+ * location: Location of the meta box.
+
+*Returns*
+
+State of meta box at specified location.
+
+### isSavingMetaBoxes
+
+Returns true if the the Meta Boxes are being saved.
+
+*Parameters*
+
+ * state: Global application state.
+
+*Returns*
+
+Whether the metaboxes are being saved.
+
+## Actions
+
+### openGeneralSidebar
+
+Returns an action object used in signalling that the user opened an editor sidebar.
+
+*Parameters*
+
+ * name: Sidebar name to be opened.
+
+### closeGeneralSidebar
+
+Returns an action object signalling that the user closed the sidebar.
+
+### openPublishSidebar
+
+Returns an action object used in signalling that the user opened the publish
+sidebar.
+
+### closePublishSidebar
+
+Returns an action object used in signalling that the user closed the
+publish sidebar.
+
+### togglePublishSidebar
+
+Returns an action object used in signalling that the user toggles the publish sidebar.
+
+### toggleGeneralSidebarEditorPanel
+
+Returns an action object used in signalling that use toggled a panel in the editor.
+
+*Parameters*
+
+ * panel: The panel to toggle.
+
+### toggleFeature
+
+Returns an action object used to toggle a feature flag.
+
+*Parameters*
+
+ * feature: Feature name.
+
+### togglePinnedPluginItem
+
+Returns an action object used to toggle a plugin name flag.
+
+*Parameters*
+
+ * pluginName: Plugin name.
+
+### initializeMetaBoxState
+
+Returns an action object used to check the state of meta boxes at a location.
+
+This should only be fired once to initialize meta box state. If a meta box
+area is empty, this will set the store state to indicate that React should
+not render the meta box area.
+
+Example: metaBoxes = { side: true, normal: false }.
+
+This indicates that the sidebar has a meta box but the normal area does not.
+
+*Parameters*
+
+ * metaBoxes: Whether meta box locations are active.
+
+### requestMetaBoxUpdates
+
+Returns an action object used to request meta box update.
+
+### metaBoxUpdatesSuccess
+
+Returns an action object used signal a successfull meta box update.
+
+### setMetaBoxSavedData
+
+Returns an action object used to set the saved meta boxes data.
+This is used to check if the meta boxes have been touched when leaving the editor.
+
+*Parameters*
+
+ * dataPerLocation: Meta Boxes Data per location.