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.

Sign up for GitHub

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: Generates the manifest dynamically to include the data module docs in the handbook #7411

Merged
merged 4 commits into from
Jun 28, 2018
Merged

Documentation: Generates the manifest dynamically to include the data module docs in the handbook #7411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1614fae
Documentation: Generates the manifest dynamically to include the data…
youknowriad Jun 20, 2018
62d45c6
Using tabs instead of spaces in the generated manifest
youknowriad Jun 28, 2018
df83be5
Destructure lodash
youknowriad Jun 28, 2018
ebb50d4
Data Docs: rename index.md => README.md
youknowriad Jun 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data/index.md → docs/data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
- [**core/editor**: The Editor's Data](./core-editor.md)
- [**core/edit-post**: The Editor's UI Data](./core-edit-post.md)
- [**core/viewport**: The viewport module Data](./core-viewport.md)
- [**core/nux**: The NUX module Data](./core-nux.md)
- [**core/nux**: The NUX (New User Experience) module Data](./core-nux.md)
2 changes: 1 addition & 1 deletion docs/data/core-edit-post.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Returns an action object used to request meta box update.

### metaBoxUpdatesSuccess

Returns an action object used signal a successfull meta box update.
Returns an action object used signal a successful meta box update.

### setMetaBoxSavedData

Expand Down
20 changes: 18 additions & 2 deletions docs/data/core-nux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **core/nux**: The NUX module Data
# **core/nux**: The NUX (New User Experience) module Data

## Selectors

Expand All @@ -13,6 +13,18 @@ guide that they have been added to.
* state: Global application state.
* id: The tip to query.

### areTipsEnabled

Returns whether or not tips are globally enabled.

*Parameters*

* state: Global application state.

*Returns*

Whether tips are globally enabled.

## Actions

### triggerGuide
Expand All @@ -36,4 +48,8 @@ dismissed tip will not show again.
### disableTips

Returns an action object that, when dispatched, prevents all tips from
showing again.
showing again.

### enableTips

Returns an action object that, when dispatched, makes all tips show again.
2 changes: 1 addition & 1 deletion docs/data/core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Record.

### getThemeSupports

Return theme suports data in the index.
Return theme supports data in the index.

*Parameters*

Expand Down
9 changes: 0 additions & 9 deletions docs/data/tool/index.js
View file
Open in desktop

This file was deleted.

114 changes: 78 additions & 36 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,211 +2,253 @@
{
"title": "Introduction",
"slug": "handbook",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/readme.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/readme.md",
"parent": null
},
{
"title": "The Language of Gutenberg",
"slug": "language",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/language.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/language.md",
"parent": null
},
{
"title": "Block API",
"slug": "block-api",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/block-api.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/block-api.md",
"parent": null
},
{
"title": "Attributes",
"slug": "attributes",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/block-api\/attributes.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/block-api/attributes.md",
"parent": "block-api"
},
{
"title": "Edit and Save",
"slug": "block-edit-save",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/block-api\/block-edit-save.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/block-api/block-edit-save.md",
"parent": "block-api"
},
{
"title": "RichText API",
"slug": "rich-text-api",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/editor\/components\/rich-text\/README.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/editor/components/rich-text/README.md",
"parent": "block-api"
},
{
"title": "Deprecated Blocks",
"slug": "deprecated-blocks",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/block-api\/deprecated-blocks.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/block-api/deprecated-blocks.md",
"parent": "block-api"
},
{
"title": "Templates",
"slug": "templates",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/templates.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/templates.md",
"parent": null
},
{
"title": "Extensibility",
"slug": "extensibility",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/extensibility.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/extensibility.md",
"parent": null
},
{
"title": "Extending Blocks",
"slug": "extending-blocks",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/extensibility/extending-blocks.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/extensibility/extending-blocks.md",
"parent": "extensibility"
},
{
"title": "Meta Boxes",
"slug": "meta-box",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/extensibility/meta-box.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/extensibility/meta-box.md",
"parent": "extensibility"
},
{
"title": "Theme Support",
"slug": "theme-support",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/extensibility/theme-support.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/extensibility/theme-support.md",
"parent": "extensibility"
},
{
"title": "Autocomplete",
"slug": "autocomplete",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/extensibility/autocomplete.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/extensibility/autocomplete.md",
"parent": "extensibility"
},
{
"title": "Creating Block Types",
"slug": "blocks",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks.md",
"parent": null
},
{
"title": "Writing Your First Block Type",
"slug": "writing-your-first-block-type",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/writing-your-first-block-type.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/writing-your-first-block-type.md",
"parent": "blocks"
},
{
"title": "Applying Styles With Stylesheets",
"slug": "applying-styles-with-stylesheets",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/applying-styles-with-stylesheets.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/applying-styles-with-stylesheets.md",
"parent": "blocks"
},
{
"title": "Introducing Attributes and Editable Fields",
"slug": "introducing-attributes-and-editable-fields",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/introducing-attributes-and-editable-fields.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/introducing-attributes-and-editable-fields.md",
"parent": "blocks"
},
{
"title": "Block Controls: Toolbars and Inspector",
"slug": "block-controls-toolbars-and-inspector",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/block-controls-toolbars-and-inspector.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/block-controls-toolbars-and-inspector.md",
"parent": "blocks"
},
{
"title": "Creating dynamic blocks",
"slug": "creating-dynamic-blocks",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/creating-dynamic-blocks.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/creating-dynamic-blocks.md",
"parent": "blocks"
},
{
"title": "Generate Blocks with WP-CLI",
"slug": "generate-blocks-with-wp-cli",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/blocks\/generate-blocks-with-wp-cli.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/blocks/generate-blocks-with-wp-cli.md",
"parent": "blocks"
},
{
"title": "Reference",
"slug": "reference",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference.md",
"parent": null
},
{
"title": "Glossary",
"slug": "glossary",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/glossary.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/glossary.md",
"parent": "reference"
},
{
"title": "Design Principles",
"slug": "design-principles",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/design-principles.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/design-principles.md",
"parent": "reference"
},
{
"title": "History",
"slug": "history",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/history.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/history.md",
"parent": "reference"
},
{
"title": "Coding Guidelines",
"slug": "coding-guidelines",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/coding-guidelines.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/coding-guidelines.md",
"parent": "reference"
},
{
"title": "Testing Overview",
"slug": "testing-overview",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/testing-overview.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/testing-overview.md",
"parent": "reference"
},
{
"title": "Frequently Asked Questions",
"slug": "faq",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/faq.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/faq.md",
"parent": "reference"
},
{
"title": "Release Process",
"slug": "release",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/release.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/release.md",
"parent": "reference"
},
{
"title": "Deprecated Features",
"slug": "deprecated",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/deprecated.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/deprecated.md",
"parent": "reference"
},
{
"title": "Repository Management",
"slug": "repository-management",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/reference\/repository-management.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/reference/repository-management.md",
"parent": "reference"
},
{
"title": "Outreach",
"slug": "outreach",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/outreach.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/outreach.md",
"parent": null
},
{
"title": "Articles",
"slug": "articles",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/outreach\/docs\/articles.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/outreach/docs/articles.md",
"parent": "outreach"
},
{
"title": "Meetups",
"slug": "meetups",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/outreach\/meetups.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/outreach/meetups.md",
"parent": "outreach"
},
{
"title": "Talks",
"slug": "talks",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/outreach\/talks.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/outreach/talks.md",
"parent": "outreach"
},
{
"title": "Resources",
"slug": "resources",
"markdown_source": "https:\/\/raw.githubusercontent.com\/WordPress\/gutenberg\/master\/docs\/outreach\/resources.md",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/outreach/resources.md",
"parent": "outreach"
},
{
"title": "Data Package Reference",
"slug": "packages-data",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/README.md",
"parent": "reference"
},
{
"title": "WordPress Core Data",
"slug": "packages-data-core",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core.md",
"parent": "packages-data"
},
{
"title": "Block Types Data",
"slug": "packages-data-core-blocks",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core-blocks.md",
"parent": "packages-data"
},
{
"title": "The Editor's Data",
"slug": "packages-data-core-editor",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core-editor.md",
"parent": "packages-data"
},
{
"title": "The Editor's UI Data",
"slug": "packages-data-core-edit-post",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core-edit-post.md",
"parent": "packages-data"
},
{
"title": "The viewport module Data",
"slug": "packages-data-core-viewport",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core-viewport.md",
"parent": "packages-data"
},
{
"title": "The NUX (New User Experience) module Data",
"slug": "packages-data-core-nux",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/data/core-nux.md",
"parent": "packages-data"
}
]
]
Loading