From 66b7e4201b66fc8b56c785ee56c322d4534a2bd8 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:43:21 +0100 Subject: [PATCH 01/68] Create an appendix folder and add its files --- docs/appendix/README.md | 0 .../developers => appendix}/backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../developers => appendix}/backward-compatibility/meta-box.md | 0 docs/{designers-developers/developers => appendix}/data/README.md | 0 .../developers => appendix}/data/data-core-annotations.md | 0 .../developers => appendix}/data/data-core-block-editor.md | 0 .../developers => appendix}/data/data-core-blocks.md | 0 .../developers => appendix}/data/data-core-edit-post.md | 0 .../developers => appendix}/data/data-core-editor.md | 0 .../developers => appendix}/data/data-core-keyboard-shortcuts.md | 0 .../developers => appendix}/data/data-core-notices.md | 0 .../developers => appendix}/data/data-core-nux.md | 0 .../developers => appendix}/data/data-core-viewport.md | 0 .../developers => appendix}/data/data-core.md | 0 docs/{designers-developers => appendix}/faq.md | 0 docs/{designers-developers => appendix}/glossary.md | 0 docs/{contributors => appendix}/history.md | 0 docs/{contributors => appendix}/outreach.md | 0 docs/{designers-developers/developers => appendix}/packages.md | 0 docs/{contributors => appendix}/versions-in-wordpress.md | 0 21 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/appendix/README.md rename docs/{designers-developers/developers => appendix}/backward-compatibility/README.md (100%) rename docs/{designers-developers/developers => appendix}/backward-compatibility/deprecations.md (100%) rename docs/{designers-developers/developers => appendix}/backward-compatibility/meta-box.md (100%) rename docs/{designers-developers/developers => appendix}/data/README.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-annotations.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-block-editor.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-blocks.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-edit-post.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-editor.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-keyboard-shortcuts.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-notices.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-nux.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-viewport.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core.md (100%) rename docs/{designers-developers => appendix}/faq.md (100%) rename docs/{designers-developers => appendix}/glossary.md (100%) rename docs/{contributors => appendix}/history.md (100%) rename docs/{contributors => appendix}/outreach.md (100%) rename docs/{designers-developers/developers => appendix}/packages.md (100%) rename docs/{contributors => appendix}/versions-in-wordpress.md (100%) diff --git a/docs/appendix/README.md b/docs/appendix/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/backward-compatibility/README.md b/docs/appendix/backward-compatibility/README.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/README.md rename to docs/appendix/backward-compatibility/README.md diff --git a/docs/designers-developers/developers/backward-compatibility/deprecations.md b/docs/appendix/backward-compatibility/deprecations.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/deprecations.md rename to docs/appendix/backward-compatibility/deprecations.md diff --git a/docs/designers-developers/developers/backward-compatibility/meta-box.md b/docs/appendix/backward-compatibility/meta-box.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/meta-box.md rename to docs/appendix/backward-compatibility/meta-box.md diff --git a/docs/designers-developers/developers/data/README.md b/docs/appendix/data/README.md similarity index 100% rename from docs/designers-developers/developers/data/README.md rename to docs/appendix/data/README.md diff --git a/docs/designers-developers/developers/data/data-core-annotations.md b/docs/appendix/data/data-core-annotations.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-annotations.md rename to docs/appendix/data/data-core-annotations.md diff --git a/docs/designers-developers/developers/data/data-core-block-editor.md b/docs/appendix/data/data-core-block-editor.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-block-editor.md rename to docs/appendix/data/data-core-block-editor.md diff --git a/docs/designers-developers/developers/data/data-core-blocks.md b/docs/appendix/data/data-core-blocks.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-blocks.md rename to docs/appendix/data/data-core-blocks.md diff --git a/docs/designers-developers/developers/data/data-core-edit-post.md b/docs/appendix/data/data-core-edit-post.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-edit-post.md rename to docs/appendix/data/data-core-edit-post.md diff --git a/docs/designers-developers/developers/data/data-core-editor.md b/docs/appendix/data/data-core-editor.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-editor.md rename to docs/appendix/data/data-core-editor.md diff --git a/docs/designers-developers/developers/data/data-core-keyboard-shortcuts.md b/docs/appendix/data/data-core-keyboard-shortcuts.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-keyboard-shortcuts.md rename to docs/appendix/data/data-core-keyboard-shortcuts.md diff --git a/docs/designers-developers/developers/data/data-core-notices.md b/docs/appendix/data/data-core-notices.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-notices.md rename to docs/appendix/data/data-core-notices.md diff --git a/docs/designers-developers/developers/data/data-core-nux.md b/docs/appendix/data/data-core-nux.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-nux.md rename to docs/appendix/data/data-core-nux.md diff --git a/docs/designers-developers/developers/data/data-core-viewport.md b/docs/appendix/data/data-core-viewport.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-viewport.md rename to docs/appendix/data/data-core-viewport.md diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/appendix/data/data-core.md similarity index 100% rename from docs/designers-developers/developers/data/data-core.md rename to docs/appendix/data/data-core.md diff --git a/docs/designers-developers/faq.md b/docs/appendix/faq.md similarity index 100% rename from docs/designers-developers/faq.md rename to docs/appendix/faq.md diff --git a/docs/designers-developers/glossary.md b/docs/appendix/glossary.md similarity index 100% rename from docs/designers-developers/glossary.md rename to docs/appendix/glossary.md diff --git a/docs/contributors/history.md b/docs/appendix/history.md similarity index 100% rename from docs/contributors/history.md rename to docs/appendix/history.md diff --git a/docs/contributors/outreach.md b/docs/appendix/outreach.md similarity index 100% rename from docs/contributors/outreach.md rename to docs/appendix/outreach.md diff --git a/docs/designers-developers/developers/packages.md b/docs/appendix/packages.md similarity index 100% rename from docs/designers-developers/developers/packages.md rename to docs/appendix/packages.md diff --git a/docs/contributors/versions-in-wordpress.md b/docs/appendix/versions-in-wordpress.md similarity index 100% rename from docs/contributors/versions-in-wordpress.md rename to docs/appendix/versions-in-wordpress.md From 1d1a5f506e9e40948eac14006e52ac290199bb58 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:47:10 +0100 Subject: [PATCH 02/68] Move full site editing templates under developer chapter --- .../developers/full-site-editing-templates.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{architecture/fse-templates.md => designers-developers/developers/full-site-editing-templates.md} (100%) diff --git a/docs/architecture/fse-templates.md b/docs/designers-developers/developers/full-site-editing-templates.md similarity index 100% rename from docs/architecture/fse-templates.md rename to docs/designers-developers/developers/full-site-editing-templates.md From b783d60cbcbd777dbccfd5378b01bcd4d90b1644 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:47:34 +0100 Subject: [PATCH 03/68] Move platform folder under tutorials chapter --- .../developers/{ => tutorials}/platform/README.md | 0 .../{ => tutorials}/platform/custom-block-editor/README.md | 0 .../{ => tutorials}/platform/custom-block-editor/tutorial.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/designers-developers/developers/{ => tutorials}/platform/README.md (100%) rename docs/designers-developers/developers/{ => tutorials}/platform/custom-block-editor/README.md (100%) rename docs/designers-developers/developers/{ => tutorials}/platform/custom-block-editor/tutorial.md (100%) diff --git a/docs/designers-developers/developers/platform/README.md b/docs/designers-developers/developers/tutorials/platform/README.md similarity index 100% rename from docs/designers-developers/developers/platform/README.md rename to docs/designers-developers/developers/tutorials/platform/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/README.md b/docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/README.md rename to docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md b/docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/tutorial.md rename to docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md From e1f5f9090e9fe080cfa406847f02ef6844a1dff6 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 16:04:00 +0100 Subject: [PATCH 04/68] Update the appendix folder readme --- docs/appendix/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/appendix/README.md b/docs/appendix/README.md index e69de29bb2d1d..e52bc7073548d 100644 --- a/docs/appendix/README.md +++ b/docs/appendix/README.md @@ -0,0 +1,10 @@ +# Appendix + +- [Package Reference](/docs/appendix/packages.md) +- [Data Module Reference](/docs/appendix/data/README.md) +- [Backward Compatibility](/docs/appendix/backward-compatibility/README.md) +- [Glossary](/docs/appendix/glossary.md) +- [Frequently Asked Questions](/docs/appendix/faq.md) +- [Versions in WordPress](/docs/appendix/versions-in-wordpress.md) +- [History](/docs/appendix/history.md) +- [Outreach](/docs/appendix/outreach) \ No newline at end of file From 51a02fb84aef58d4a3e3cc837acdc5ca2b002cc8 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 08:13:58 +0100 Subject: [PATCH 05/68] Move plateform folder to developers folder --- .../developers/{tutorials => }/platform/README.md | 0 .../{tutorials => }/platform/custom-block-editor/README.md | 0 .../{tutorials => }/platform/custom-block-editor/tutorial.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/designers-developers/developers/{tutorials => }/platform/README.md (100%) rename docs/designers-developers/developers/{tutorials => }/platform/custom-block-editor/README.md (100%) rename docs/designers-developers/developers/{tutorials => }/platform/custom-block-editor/tutorial.md (100%) diff --git a/docs/designers-developers/developers/tutorials/platform/README.md b/docs/designers-developers/developers/platform/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/README.md rename to docs/designers-developers/developers/platform/README.md diff --git a/docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md b/docs/designers-developers/developers/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md rename to docs/designers-developers/developers/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md b/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md rename to docs/designers-developers/developers/platform/custom-block-editor/tutorial.md From f0f19d8f2d4d3eae1e378f2e47df154325735ac5 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 08:14:17 +0100 Subject: [PATCH 06/68] Update packages reference paths --- docs/manifest.json | 744 +++++++++++++++++++++++---------------------- docs/toc.json | 270 ++++++++-------- 2 files changed, 511 insertions(+), 503 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index b28dff5a8988b..d364eed54df1e 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -2,92 +2,50 @@ { "title": "Getting started", "slug": "handbook", - "markdown_source": "../docs/readme.md", + "markdown_source": "../docs/README.md", "parent": null }, { - "title": "Glossary", - "slug": "glossary", - "markdown_source": "../docs/designers-developers/glossary.md", - "parent": "handbook" - }, - { - "title": "Frequently Asked Questions", - "slug": "faq", - "markdown_source": "../docs/designers-developers/faq.md", - "parent": "handbook" - }, - { - "title": "Versions in WordPress", - "slug": "versions-in-wordpress", - "markdown_source": "../docs/contributors/versions-in-wordpress.md", - "parent": "handbook" - }, - { - "title": "History", - "slug": "history", - "markdown_source": "../docs/contributors/history.md", - "parent": "handbook" - }, - { - "title": "Outreach", - "slug": "outreach", - "markdown_source": "../docs/contributors/outreach.md", - "parent": "handbook" - }, - { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/architecture/readme.md", + "title": "Developer Documentation", + "slug": "developers", + "markdown_source": "../docs/designers-developers/developers/README.md", "parent": null }, { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/architecture/key-concepts.md", - "parent": "architecture" - }, - { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/architecture/data-flow.md", - "parent": "architecture" - }, - { - "title": "Folder Structure", - "slug": "folder-structure", - "markdown_source": "../docs/architecture/folder-structure.md", - "parent": "architecture" + "title": "FullSiteEditingTemplates", + "slug": "full-site-editing-templates", + "markdown_source": "../docs/designers-developers/developers/full-site-editing-templates.md", + "parent": "developers" }, { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/architecture/modularity.md", - "parent": "architecture" + "title": "Filter Reference", + "slug": "filters", + "markdown_source": "../docs/designers-developers/developers/filters/README.md", + "parent": "developers" }, { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/architecture/performance.md", - "parent": "architecture" + "title": "Block Filters", + "slug": "block-filters", + "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", + "parent": "filters" }, { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/architecture/automated-testing.md", - "parent": "architecture" + "title": "Editor Filters", + "slug": "editor-filters", + "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", + "parent": "filters" }, { - "title": "FseTemplates", - "slug": "fse-templates", - "markdown_source": "../docs/architecture/fse-templates.md", - "parent": "architecture" + "title": "Parser Filters", + "slug": "parser-filters", + "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", + "parent": "filters" }, { - "title": "Developer Documentation", - "slug": "developers", - "markdown_source": "../docs/designers-developers/developers/README.md", - "parent": null + "title": "Autocomplete", + "slug": "autocomplete-filters", + "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", + "parent": "filters" }, { "title": "Block API Reference", @@ -161,36 +119,6 @@ "markdown_source": "../docs/designers-developers/developers/block-api/versions.md", "parent": "block-api" }, - { - "title": "Filter Reference", - "slug": "filters", - "markdown_source": "../docs/designers-developers/developers/filters/README.md", - "parent": "developers" - }, - { - "title": "Block Filters", - "slug": "block-filters", - "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", - "parent": "filters" - }, - { - "title": "Editor Filters", - "slug": "editor-filters", - "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", - "parent": "filters" - }, - { - "title": "Parser Filters", - "slug": "parser-filters", - "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", - "parent": "filters" - }, - { - "title": "Autocomplete", - "slug": "autocomplete-filters", - "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", - "parent": "filters" - }, { "title": "SlotFills Reference", "slug": "slotfills", @@ -257,18 +185,6 @@ "markdown_source": "../docs/designers-developers/developers/richtext.md", "parent": "developers" }, - { - "title": "Internationalization", - "slug": "internationalization", - "markdown_source": "../docs/designers-developers/developers/internationalization.md", - "parent": "developers" - }, - { - "title": "Accessibility", - "slug": "accessibility", - "markdown_source": "../docs/designers-developers/developers/accessibility.md", - "parent": "developers" - }, { "title": "Feature Flags", "slug": "feature-flags", @@ -300,196 +216,22 @@ "parent": "themes" }, { - "title": "Backward Compatibility", - "slug": "backward-compatibility", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/README.md", + "title": "Accessibility", + "slug": "accessibility", + "markdown_source": "../docs/designers-developers/developers/accessibility.md", "parent": "developers" }, { - "title": "Deprecations", - "slug": "deprecations", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/deprecations.md", - "parent": "backward-compatibility" - }, - { - "title": "Meta Boxes", - "slug": "meta-box", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/meta-box.md", - "parent": "backward-compatibility" - }, - { - "title": "Gutenberg as a Development Platform", - "slug": "platform", - "markdown_source": "../docs/designers-developers/developers/platform/README.md", + "title": "Internationalization", + "slug": "internationalization", + "markdown_source": "../docs/designers-developers/developers/internationalization.md", "parent": "developers" }, - { - "title": "Building a custom block editor", - "slug": "custom-block-editor", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", - "parent": "platform" - }, - { - "title": "Tutorial: building a custom block editor", - "slug": "tutorial", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", - "parent": "custom-block-editor" - }, - { - "title": "Designer Documentation", - "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null - }, - { - "title": "Block Design", - "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", - "parent": "designers" - }, - { - "title": "User Interface", - "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", - "parent": "designers" - }, - { - "title": "Resources", - "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", - "parent": "designers" - }, - { - "title": "Animation", - "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", - "parent": "designers" - }, - { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", - "parent": null - }, - { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" - }, - { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" - }, - { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" - }, - { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" - }, - { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" - }, - { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" - }, - { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" - }, - { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" - }, - { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" - }, - { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" - }, - { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" - }, - { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" - }, - { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" - }, - { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" - }, - { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" - }, - { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" - }, - { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" - }, - { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" - }, - { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" - }, { "title": "Tutorials", "slug": "tutorials", "markdown_source": "../docs/designers-developers/developers/tutorials/readme.md", - "parent": null + "parent": "developers" }, { "title": "Development Environment", @@ -767,11 +509,77 @@ "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md", "parent": "block-based-themes" }, + { + "title": "Gutenberg as a Development Platform", + "slug": "platform", + "markdown_source": "../docs/designers-developers/developers/platform/README.md", + "parent": "tutorials" + }, + { + "title": "Building a custom block editor", + "slug": "custom-block-editor", + "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", + "parent": "platform" + }, + { + "title": "Tutorial: building a custom block editor", + "slug": "tutorial", + "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", + "parent": "custom-block-editor" + }, + { + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/architecture/readme.md", + "parent": null + }, + { + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/architecture/key-concepts.md", + "parent": "architecture" + }, + { + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/architecture/data-flow.md", + "parent": "architecture" + }, + { + "title": "Folder Structure", + "slug": "folder-structure", + "markdown_source": "../docs/architecture/folder-structure.md", + "parent": "architecture" + }, + { + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/architecture/modularity.md", + "parent": "architecture" + }, + { + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/architecture/performance.md", + "parent": "architecture" + }, + { + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/architecture/automated-testing.md", + "parent": "architecture" + }, + { + "title": "Appendix", + "slug": "appendix", + "markdown_source": "../docs/appendix/readme.md", + "parent": null + }, { "title": "Component Reference", "slug": "components", "markdown_source": "../packages/components/README.md", - "parent": null + "parent": "appendix" }, { "title": "AlignmentMatrixControl", @@ -1263,91 +1071,31 @@ "title": "TreeGrid", "slug": "tree-grid", "markdown_source": "../packages/components/src/tree-grid/README.md", - "parent": "components" - }, - { - "title": "TreeSelect", - "slug": "tree-select", - "markdown_source": "../packages/components/src/tree-select/README.md", - "parent": "components" - }, - { - "title": "UnitControl", - "slug": "unit-control", - "markdown_source": "../packages/components/src/unit-control/README.md", - "parent": "components" - }, - { - "title": "VisuallyHidden", - "slug": "visually-hidden", - "markdown_source": "../packages/components/src/visually-hidden/README.md", - "parent": "components" - }, - { - "title": "Data Module Reference", - "slug": "data", - "markdown_source": "../docs/designers-developers/developers/data/README.md", - "parent": null - }, - { - "title": "WordPress Core Data", - "slug": "data-core", - "markdown_source": "../docs/designers-developers/developers/data/data-core.md", - "parent": "data" - }, - { - "title": "Annotations", - "slug": "data-core-annotations", - "markdown_source": "../docs/designers-developers/developers/data/data-core-annotations.md", - "parent": "data" - }, - { - "title": "Block Types Data", - "slug": "data-core-blocks", - "markdown_source": "../docs/designers-developers/developers/data/data-core-blocks.md", - "parent": "data" - }, - { - "title": "The Block Editor’s Data", - "slug": "data-core-block-editor", - "markdown_source": "../docs/designers-developers/developers/data/data-core-block-editor.md", - "parent": "data" - }, - { - "title": "The Post Editor’s Data", - "slug": "data-core-editor", - "markdown_source": "../docs/designers-developers/developers/data/data-core-editor.md", - "parent": "data" - }, - { - "title": "The Editor’s UI Data", - "slug": "data-core-edit-post", - "markdown_source": "../docs/designers-developers/developers/data/data-core-edit-post.md", - "parent": "data" + "parent": "components" }, { - "title": "Notices Data", - "slug": "data-core-notices", - "markdown_source": "../docs/designers-developers/developers/data/data-core-notices.md", - "parent": "data" + "title": "TreeSelect", + "slug": "tree-select", + "markdown_source": "../packages/components/src/tree-select/README.md", + "parent": "components" }, { - "title": "The NUX (New User Experience) Data", - "slug": "data-core-nux", - "markdown_source": "../docs/designers-developers/developers/data/data-core-nux.md", - "parent": "data" + "title": "UnitControl", + "slug": "unit-control", + "markdown_source": "../packages/components/src/unit-control/README.md", + "parent": "components" }, { - "title": "The Viewport Data", - "slug": "data-core-viewport", - "markdown_source": "../docs/designers-developers/developers/data/data-core-viewport.md", - "parent": "data" + "title": "VisuallyHidden", + "slug": "visually-hidden", + "markdown_source": "../packages/components/src/visually-hidden/README.md", + "parent": "components" }, { "title": "Package Reference", "slug": "packages", - "markdown_source": "../docs/designers-developers/developers/packages.md", - "parent": null + "markdown_source": "../docs/appendix/packages.md", + "parent": "appendix" }, { "title": "@wordpress/a11y", @@ -1840,5 +1588,263 @@ "slug": "packages-wordcount", "markdown_source": "../packages/wordcount/README.md", "parent": "packages" + }, + { + "title": "Data Module Reference", + "slug": "data", + "markdown_source": "../docs/appendix/data/README.md", + "parent": "appendix" + }, + { + "title": "WordPress Core Data", + "slug": "data-core", + "markdown_source": "../docs/appendix/data/data-core.md", + "parent": "data" + }, + { + "title": "Annotations", + "slug": "data-core-annotations", + "markdown_source": "../docs/appendix/data/data-core-annotations.md", + "parent": "data" + }, + { + "title": "Block Types Data", + "slug": "data-core-blocks", + "markdown_source": "../docs/appendix/data/data-core-blocks.md", + "parent": "data" + }, + { + "title": "The Block Editor’s Data", + "slug": "data-core-block-editor", + "markdown_source": "../docs/appendix/data/data-core-block-editor.md", + "parent": "data" + }, + { + "title": "The Post Editor’s Data", + "slug": "data-core-editor", + "markdown_source": "../docs/appendix/data/data-core-editor.md", + "parent": "data" + }, + { + "title": "The Editor’s UI Data", + "slug": "data-core-edit-post", + "markdown_source": "../docs/appendix/data/data-core-edit-post.md", + "parent": "data" + }, + { + "title": "Notices Data", + "slug": "data-core-notices", + "markdown_source": "../docs/appendix/data/data-core-notices.md", + "parent": "data" + }, + { + "title": "The NUX (New User Experience) Data", + "slug": "data-core-nux", + "markdown_source": "../docs/appendix/data/data-core-nux.md", + "parent": "data" + }, + { + "title": "The Viewport Data", + "slug": "data-core-viewport", + "markdown_source": "../docs/appendix/data/data-core-viewport.md", + "parent": "data" + }, + { + "title": "Backward Compatibility", + "slug": "backward-compatibility", + "markdown_source": "../docs/appendix/backward-compatibility/README.md", + "parent": "appendix" + }, + { + "title": "Deprecations", + "slug": "deprecations", + "markdown_source": "../docs/appendix/backward-compatibility/deprecations.md", + "parent": "backward-compatibility" + }, + { + "title": "Meta Boxes", + "slug": "meta-box", + "markdown_source": "../docs/appendix/backward-compatibility/meta-box.md", + "parent": "backward-compatibility" + }, + { + "title": "Glossary", + "slug": "glossary", + "markdown_source": "../docs/appendix/glossary.md", + "parent": "appendix" + }, + { + "title": "Frequently Asked Questions", + "slug": "faq", + "markdown_source": "../docs/appendix/faq.md", + "parent": "appendix" + }, + { + "title": "Versions in WordPress", + "slug": "versions-in-wordpress", + "markdown_source": "../docs/appendix/versions-in-wordpress.md", + "parent": "appendix" + }, + { + "title": "History", + "slug": "history", + "markdown_source": "../docs/appendix/history.md", + "parent": "appendix" + }, + { + "title": "Outreach", + "slug": "outreach", + "markdown_source": "../docs/appendix/outreach.md", + "parent": "appendix" + }, + { + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/readme.md", + "parent": null + }, + { + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/develop.md", + "parent": "contributors" + }, + { + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/getting-started.md", + "parent": "develop" + }, + { + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/git-workflow.md", + "parent": "develop" + }, + { + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/coding-guidelines.md", + "parent": "develop" + }, + { + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, + { + "title": "Designer Documentation", + "slug": "designers", + "markdown_source": "../docs/designers-developers/designers/README.md", + "parent": null + }, + { + "title": "Block Design", + "slug": "block-design", + "markdown_source": "../docs/designers-developers/designers/block-design.md", + "parent": "designers" + }, + { + "title": "User Interface", + "slug": "user-interface", + "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "parent": "designers" + }, + { + "title": "Resources", + "slug": "design-resources", + "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "parent": "designers" + }, + { + "title": "Animation", + "slug": "animation", + "markdown_source": "../docs/designers-developers/designers/animation.md", + "parent": "designers" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 3d685561927b4..40ae9c326dce2 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,41 +1,27 @@ [ - { "docs/readme.md": [ - { "docs/designers-developers/glossary.md": [] }, - { "docs/designers-developers/faq.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/history.md": [] }, - { "docs/contributors/outreach.md": [] } - ] }, - { "docs/architecture/readme.md": [ - { "docs/architecture/key-concepts.md": [] }, - { "docs/architecture/data-flow.md": [] }, - { "docs/architecture/folder-structure.md": [] }, - { "docs/architecture/modularity.md": [] }, - { "docs/architecture/performance.md": [] }, - { "docs/architecture/automated-testing.md": [] }, - { "docs/architecture/fse-templates.md": [] } - ] }, - { "docs/designers-developers/developers/README.md": [ - { "docs/designers-developers/developers/block-api/README.md": [ - { "docs/designers-developers/developers/block-api/block-registration.md": [] }, - { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, - { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, - { "docs/designers-developers/developers/block-api/block-context.md": [] }, - { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, - { "docs/designers-developers/developers/block-api/block-supports.md": [] }, - { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, - { "docs/designers-developers/developers/block-api/block-templates.md": [] }, - { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, - { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, - { "docs/designers-developers/developers/block-api/versions.md": [] } - ] }, - { "docs/designers-developers/developers/filters/README.md": [ - { "docs/designers-developers/developers/filters/block-filters.md": [] }, - { "docs/designers-developers/developers/filters/editor-filters.md": [] }, - { "docs/designers-developers/developers/filters/parser-filters.md": [] }, - { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } - ] }, - {"docs/designers-developers/developers/slotfills/README.md": [ + { "docs/README.md": [] }, + { "docs/designers-developers/developers/README.md": [ + { "docs/designers-developers/developers/full-site-editing-templates.md": [] }, + { "docs/designers-developers/developers/filters/README.md": [ + { "docs/designers-developers/developers/filters/block-filters.md": [] }, + { "docs/designers-developers/developers/filters/editor-filters.md": [] }, + { "docs/designers-developers/developers/filters/parser-filters.md": [] }, + { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } + ] }, + { "docs/designers-developers/developers/block-api/README.md": [ + { "docs/designers-developers/developers/block-api/block-registration.md": [] }, + { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, + { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, + { "docs/designers-developers/developers/block-api/block-context.md": [] }, + { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, + { "docs/designers-developers/developers/block-api/block-supports.md": [] }, + { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, + { "docs/designers-developers/developers/block-api/block-templates.md": [] }, + { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, + { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, + { "docs/designers-developers/developers/block-api/versions.md": [] } + ] }, + {"docs/designers-developers/developers/slotfills/README.md": [ { "docs/designers-developers/developers/slotfills/main-dashboard-button.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md": [] }, @@ -45,33 +31,112 @@ { "docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-sidebar.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/designers-developers/developers/richtext.md": [] }, - { "docs/designers-developers/developers/internationalization.md": [] }, - { "docs/designers-developers/developers/accessibility.md": [] }, - { "docs/designers-developers/developers/feature-flags.md": [] }, - { "docs/designers-developers/developers/themes/README.md": [ - { "docs/designers-developers/developers/themes/theme-support.md": [] }, - { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, - { "docs/designers-developers/developers/themes/theme-json.md": [] } - ] }, - { "docs/designers-developers/developers/backward-compatibility/README.md": [ - { "docs/designers-developers/developers/backward-compatibility/deprecations.md": [] }, - { "docs/designers-developers/developers/backward-compatibility/meta-box.md": [] } - ] }, - { "docs/designers-developers/developers/platform/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } - ] } - ] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] }, - { "docs/contributors/readme.md": [ + ]}, + { "docs/designers-developers/developers/richtext.md": [] }, + { "docs/designers-developers/developers/feature-flags.md": [] }, + + { "docs/designers-developers/developers/themes/README.md": [ + { "docs/designers-developers/developers/themes/theme-support.md": [] }, + { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, + { "docs/designers-developers/developers/themes/theme-json.md": [] } + ] }, + { "docs/designers-developers/developers/accessibility.md": [] }, + { "docs/designers-developers/developers/internationalization.md": [] }, + { "docs/designers-developers/developers/tutorials/readme.md": [ + { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ + { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ + { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ + { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ + { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ + { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/format-api/README.md": [ + { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, + { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, + { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ + { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/designers-developers/developers/platform/README.md": [ + { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ + { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } + ] } + ] } + ] } + ] }, + { "docs/architecture/readme.md": [ + { "docs/architecture/key-concepts.md": [] }, + { "docs/architecture/data-flow.md": [] }, + { "docs/architecture/folder-structure.md": [] }, + { "docs/architecture/modularity.md": [] }, + { "docs/architecture/performance.md": [] }, + { "docs/architecture/automated-testing.md": [] } + ] }, + { "docs/appendix/readme.md": [ + { "packages/components/README.md": "{{components}}" }, + { "docs/appendix/packages.md": "{{packages}}" }, + { "docs/appendix/data/README.md": [ + { "docs/appendix/data/data-core.md": []}, + { "docs/appendix/data/data-core-annotations.md": [] }, + { "docs/appendix/data/data-core-blocks.md": [] }, + { "docs/appendix/data/data-core-block-editor.md": [] }, + { "docs/appendix/data/data-core-editor.md": [] }, + { "docs/appendix/data/data-core-edit-post.md": [] }, + { "docs/appendix/data/data-core-notices.md": [] }, + { "docs/appendix/data/data-core-nux.md": [] }, + { "docs/appendix/data/data-core-viewport.md": [] } + ] }, + { "docs/appendix/backward-compatibility/README.md": [ + { "docs/appendix/backward-compatibility/deprecations.md": [] }, + { "docs/appendix/backward-compatibility/meta-box.md": [] } + ] }, + { "docs/appendix/glossary.md": [] }, + { "docs/appendix/faq.md": [] }, + { "docs/appendix/versions-in-wordpress.md": [] }, + { "docs/appendix/history.md": [] }, + { "docs/appendix/outreach.md": [] } + ] }, + { "docs/contributors/readme.md": [ { "docs/contributors/develop.md": [ { "docs/contributors/getting-started.md": [] }, { "docs/contributors/git-workflow.md": [] }, @@ -94,74 +159,11 @@ { "docs/contributors/triage.md": [] }, { "docs/contributors/localizing.md": [] }, { "docs/contributors/repository-management.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ - { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ - { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ - { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ - { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/format-api/README.md": [ - { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ - { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } - ] } - ] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/designers-developers/developers/data/README.md": [ - { "docs/designers-developers/developers/data/data-core.md": []}, - { "docs/designers-developers/developers/data/data-core-annotations.md": [] }, - { "docs/designers-developers/developers/data/data-core-blocks.md": [] }, - { "docs/designers-developers/developers/data/data-core-block-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-edit-post.md": [] }, - { "docs/designers-developers/developers/data/data-core-notices.md": [] }, - { "docs/designers-developers/developers/data/data-core-nux.md": [] }, - { "docs/designers-developers/developers/data/data-core-viewport.md": [] } - ] }, - { "docs/designers-developers/developers/packages.md": "{{packages}}" } + ] }, + { "docs/designers-developers/designers/README.md": [ + { "docs/designers-developers/designers/block-design.md": [] }, + { "docs/designers-developers/designers/user-interface.md": [] }, + { "docs/designers-developers/designers/design-resources.md": [] }, + { "docs/designers-developers/designers/animation.md": [] } + ] } ] From 96b06b42deaf0ebdd4916a0d183c58c5a497f2de Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 09:35:42 +0100 Subject: [PATCH 07/68] Update toc.json --- docs/toc.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/toc.json b/docs/toc.json index 40ae9c326dce2..99b53b77e362d 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -167,3 +167,4 @@ { "docs/designers-developers/designers/animation.md": [] } ] } ] + From 9983a81e780831c2708fa7b438ff273dd81af9bf Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 09:53:45 +0100 Subject: [PATCH 08/68] Update toc.json --- docs/toc.json | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/toc.json b/docs/toc.json index 99b53b77e362d..40ae9c326dce2 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -167,4 +167,3 @@ { "docs/designers-developers/designers/animation.md": [] } ] } ] - From a78f5a168bb4e534424cbf8bcfbc2866d18b4c35 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 09:55:20 +0100 Subject: [PATCH 09/68] Update versions-in-wordpress.md with master --- docs/appendix/versions-in-wordpress.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/appendix/versions-in-wordpress.md b/docs/appendix/versions-in-wordpress.md index 90069db6af979..2e272f47fef87 100644 --- a/docs/appendix/versions-in-wordpress.md +++ b/docs/appendix/versions-in-wordpress.md @@ -6,7 +6,9 @@ If anything looks incorrect here, please bring it up in #core-editor in [WordPre | Gutenberg Versions | WordPress Version | | ------------------ | ----------------- | -| 8.6-9.2 | 5.6 | +| 9.3-9.9 | 5.7 | +| 8.6-9.2 | 5.6.1 | +| 8.6-9.2 | 5.6 | | 7.6-8.5 | 5.5.3 | | 7.6-8.5 | 5.5.2 | | 7.6-8.5 | 5.5.1 | From d8667810db916c473fc4e1bb3aefe88baea93aad Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 10:10:52 +0100 Subject: [PATCH 10/68] Update toc structure --- docs/manifest.json | 300 ++++++++++++++++++++++----------------------- docs/toc.json | 62 +++++----- 2 files changed, 181 insertions(+), 181 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index d364eed54df1e..4a0765fe42308 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -527,6 +527,156 @@ "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, + { + "title": "Designer Documentation", + "slug": "designers", + "markdown_source": "../docs/designers-developers/designers/README.md", + "parent": null + }, + { + "title": "Block Design", + "slug": "block-design", + "markdown_source": "../docs/designers-developers/designers/block-design.md", + "parent": "designers" + }, + { + "title": "User Interface", + "slug": "user-interface", + "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "parent": "designers" + }, + { + "title": "Resources", + "slug": "design-resources", + "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "parent": "designers" + }, + { + "title": "Animation", + "slug": "animation", + "markdown_source": "../docs/designers-developers/designers/animation.md", + "parent": "designers" + }, + { + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/readme.md", + "parent": null + }, + { + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/develop.md", + "parent": "contributors" + }, + { + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/getting-started.md", + "parent": "develop" + }, + { + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/git-workflow.md", + "parent": "develop" + }, + { + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/coding-guidelines.md", + "parent": "develop" + }, + { + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, { "title": "Architecture", "slug": "architecture", @@ -1696,155 +1846,5 @@ "slug": "outreach", "markdown_source": "../docs/appendix/outreach.md", "parent": "appendix" - }, - { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", - "parent": null - }, - { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" - }, - { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" - }, - { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" - }, - { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" - }, - { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" - }, - { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" - }, - { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" - }, - { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" - }, - { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" - }, - { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" - }, - { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" - }, - { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" - }, - { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" - }, - { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" - }, - { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" - }, - { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" - }, - { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" - }, - { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" - }, - { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" - }, - { - "title": "Designer Documentation", - "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null - }, - { - "title": "Block Design", - "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", - "parent": "designers" - }, - { - "title": "User Interface", - "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", - "parent": "designers" - }, - { - "title": "Resources", - "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", - "parent": "designers" - }, - { - "title": "Animation", - "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", - "parent": "designers" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 40ae9c326dce2..12217ff913c81 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -104,6 +104,36 @@ ] } ] } ] }, + { "docs/designers-developers/designers/README.md": [ + { "docs/designers-developers/designers/block-design.md": [] }, + { "docs/designers-developers/designers/user-interface.md": [] }, + { "docs/designers-developers/designers/design-resources.md": [] }, + { "docs/designers-developers/designers/animation.md": [] } + ] }, + { "docs/contributors/readme.md": [ + { "docs/contributors/develop.md": [ + { "docs/contributors/getting-started.md": [] }, + { "docs/contributors/git-workflow.md": [] }, + { "docs/contributors/coding-guidelines.md": [] }, + { "docs/contributors/testing-overview.md": [] }, + { "docs/contributors/grammar.md": [] }, + { "docs/contributors/scripts.md": [] }, + { "docs/contributors/managing-packages.md": [] }, + { "docs/contributors/release.md": [] }, + { "docs/contributors/native-mobile.md": [] }, + { "docs/contributors/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design.md": [ + { "docs/contributors/the-block.md": [] }, + { "docs/contributors/reference.md": [] } + ] }, + { "docs/contributors/document.md": [ + { "docs/contributors/copy-guide.md": [] } + ] }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/repository-management.md": [] } + ] }, { "docs/architecture/readme.md": [ { "docs/architecture/key-concepts.md": [] }, { "docs/architecture/data-flow.md": [] }, @@ -135,35 +165,5 @@ { "docs/appendix/versions-in-wordpress.md": [] }, { "docs/appendix/history.md": [] }, { "docs/appendix/outreach.md": [] } - ] }, - { "docs/contributors/readme.md": [ - { "docs/contributors/develop.md": [ - { "docs/contributors/getting-started.md": [] }, - { "docs/contributors/git-workflow.md": [] }, - { "docs/contributors/coding-guidelines.md": [] }, - { "docs/contributors/testing-overview.md": [] }, - { "docs/contributors/grammar.md": [] }, - { "docs/contributors/scripts.md": [] }, - { "docs/contributors/managing-packages.md": [] }, - { "docs/contributors/release.md": [] }, - { "docs/contributors/native-mobile.md": [] }, - { "docs/contributors/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design.md": [ - { "docs/contributors/the-block.md": [] }, - { "docs/contributors/reference.md": [] } - ] }, - { "docs/contributors/document.md": [ - { "docs/contributors/copy-guide.md": [] } - ] }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/repository-management.md": [] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] } + ] } ] From f84de0e9b7247c0dd80bd8e6216a51a07c5ee3eb Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 12:09:07 +0100 Subject: [PATCH 11/68] Update manifest.json and toc.json --- docs/manifest.json | 1014 ++++++++++++++++++++++---------------------- docs/toc.json | 377 +++++++--------- 2 files changed, 671 insertions(+), 720 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 8d1c20649dfbe..d929c5c1f0771 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,747 +1,645 @@ [ { "title": "Getting started", - "slug": "handbook", - "markdown_source": "../docs/README.md", - "parent": null - }, - { - "title": "Developer Documentation", - "slug": "developers", - "markdown_source": "../docs/designers-developers/developers/README.md", + "slug": "getting-started", + "markdown_source": "../docs/getting-started/README.md", "parent": null }, { - "title": "FullSiteEditingTemplates", - "slug": "full-site-editing-templates", - "markdown_source": "../docs/designers-developers/developers/full-site-editing-templates.md", - "parent": "developers" - }, - { - "title": "Filter Reference", - "slug": "filters", - "markdown_source": "../docs/designers-developers/developers/filters/README.md", - "parent": "developers" - }, - { - "title": "Block Filters", - "slug": "block-filters", - "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", - "parent": "filters" - }, - { - "title": "Editor Filters", - "slug": "editor-filters", - "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", - "parent": "filters" - }, - { - "title": "Parser Filters", - "slug": "parser-filters", - "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", - "parent": "filters" - }, - { - "title": "Autocomplete", - "slug": "autocomplete-filters", - "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", - "parent": "filters" - }, - { - "title": "Block API Reference", - "slug": "block-api", - "markdown_source": "../docs/designers-developers/developers/block-api/README.md", - "parent": "developers" - }, - { - "title": "Block Registration", - "slug": "block-registration", - "markdown_source": "../docs/designers-developers/developers/block-api/block-registration.md", - "parent": "block-api" - }, - { - "title": "Edit and Save", - "slug": "block-edit-save", - "markdown_source": "../docs/designers-developers/developers/block-api/block-edit-save.md", - "parent": "block-api" - }, - { - "title": "Attributes", - "slug": "block-attributes", - "markdown_source": "../docs/designers-developers/developers/block-api/block-attributes.md", - "parent": "block-api" - }, - { - "title": "Block Context", - "slug": "block-context", - "markdown_source": "../docs/designers-developers/developers/block-api/block-context.md", - "parent": "block-api" - }, - { - "title": "Deprecated Blocks", - "slug": "block-deprecation", - "markdown_source": "../docs/designers-developers/developers/block-api/block-deprecation.md", - "parent": "block-api" - }, - { - "title": "Block Supports", - "slug": "block-supports", - "markdown_source": "../docs/designers-developers/developers/block-api/block-supports.md", - "parent": "block-api" - }, - { - "title": "Block Transforms", - "slug": "block-transforms", - "markdown_source": "../docs/designers-developers/developers/block-api/block-transforms.md", - "parent": "block-api" - }, - { - "title": "Templates", - "slug": "block-templates", - "markdown_source": "../docs/designers-developers/developers/block-api/block-templates.md", - "parent": "block-api" - }, - { - "title": "Block Type Metadata", - "slug": "block-metadata", - "markdown_source": "../docs/designers-developers/developers/block-api/block-metadata.md", - "parent": "block-api" - }, - { - "title": "Block Patterns", - "slug": "block-patterns", - "markdown_source": "../docs/designers-developers/developers/block-api/block-patterns.md", - "parent": "block-api" - }, - { - "title": "Annotations", - "slug": "block-annotations", - "markdown_source": "../docs/designers-developers/developers/block-api/block-annotations.md", - "parent": "block-api" - }, - { - "title": "Block API Versions", - "slug": "versions", - "markdown_source": "../docs/designers-developers/developers/block-api/versions.md", - "parent": "block-api" - }, - { - "title": "SlotFills Reference", - "slug": "slotfills", - "markdown_source": "../docs/designers-developers/developers/slotfills/README.md", - "parent": "developers" + "title": "Tutorials", + "slug": "tutorials", + "markdown_source": "../docs/getting-started/tutorials/README.md", + "parent": "getting-started" }, { - "title": "MainDashboardButton", - "slug": "main-dashboard-button", - "markdown_source": "../docs/designers-developers/developers/slotfills/main-dashboard-button.md", - "parent": "slotfills" + "title": "Development Environment", + "slug": "devenv", + "markdown_source": "../docs/getting-started/tutorials/devenv/README.md", + "parent": "tutorials" }, { - "title": "PluginBlockSettingsMenuItem", - "slug": "plugin-block-settings-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md", - "parent": "slotfills" + "title": "How to setup local WordPress environment on Ubuntu", + "slug": "docker-ubuntu", + "markdown_source": "../docs/getting-started/tutorials/devenv/docker-ubuntu.md", + "parent": "devenv" }, { - "title": "PluginDocumentSettingPanel", - "slug": "plugin-document-setting-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md", - "parent": "slotfills" + "title": "Create a Block Tutorial", + "slug": "create-block", + "markdown_source": "../docs/getting-started/tutorials/create-block/README.md", + "parent": "tutorials" }, { - "title": "PluginMoreMenuItem", - "slug": "plugin-more-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-more-menu-item.md", - "parent": "slotfills" + "title": "WordPress Plugin", + "slug": "wp-plugin", + "markdown_source": "../docs/getting-started/tutorials/create-block/wp-plugin.md", + "parent": "create-block" }, { - "title": "PluginPostPublishPanel", - "slug": "plugin-post-publish-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md", - "parent": "slotfills" + "title": "Anatomy of a Block", + "slug": "block-anatomy", + "markdown_source": "../docs/getting-started/tutorials/create-block/block-anatomy.md", + "parent": "create-block" }, { - "title": "PluginPostStatusInfo", - "slug": "plugin-post-status-info", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-post-status-info.md", - "parent": "slotfills" + "title": "Block Attributes", + "slug": "attributes", + "markdown_source": "../docs/getting-started/tutorials/create-block/attributes.md", + "parent": "create-block" }, { - "title": "PluginPrePublishPanel", - "slug": "plugin-pre-publish-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md", - "parent": "slotfills" + "title": "Code Implementation", + "slug": "block-code", + "markdown_source": "../docs/getting-started/tutorials/create-block/block-code.md", + "parent": "create-block" }, { - "title": "PluginSidebar", - "slug": "plugin-sidebar", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-sidebar.md", - "parent": "slotfills" + "title": "Authoring Experience", + "slug": "author-experience", + "markdown_source": "../docs/getting-started/tutorials/create-block/author-experience.md", + "parent": "create-block" }, { - "title": "PluginSidebarMoreMenuItem", - "slug": "plugin-sidebar-more-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md", - "parent": "slotfills" + "title": "Finishing Touches", + "slug": "finishing", + "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", + "parent": "create-block" }, { - "title": "RichText Reference", - "slug": "richtext", - "markdown_source": "../docs/designers-developers/developers/richtext.md", - "parent": "developers" + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/getting-started/architecture/README.md", + "parent": "getting-started" }, { - "title": "Feature Flags", - "slug": "feature-flags", - "markdown_source": "../docs/designers-developers/developers/feature-flags.md", - "parent": "developers" + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/getting-started/architecture/key-concepts.md", + "parent": "architecture" }, { - "title": "Theming for the Block Editor", - "slug": "themes", - "markdown_source": "../docs/designers-developers/developers/themes/README.md", - "parent": "developers" + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/getting-started/architecture/data-flow.md", + "parent": "architecture" }, { - "title": "Theme Support", - "slug": "theme-support", - "markdown_source": "../docs/designers-developers/developers/themes/theme-support.md", - "parent": "themes" + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/getting-started/architecture/modularity.md", + "parent": "architecture" }, { - "title": "Block-based Themes (Experimental)", - "slug": "block-based-themes", - "markdown_source": "../docs/designers-developers/developers/themes/block-based-themes.md", - "parent": "themes" + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/getting-started/architecture/performance.md", + "parent": "architecture" }, { - "title": "Themes & Block Editor: experimental theme.json", - "slug": "theme-json", - "markdown_source": "../docs/designers-developers/developers/themes/theme-json.md", - "parent": "themes" + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/getting-started/architecture/automated-testing.md", + "parent": "architecture" }, { - "title": "Accessibility", - "slug": "accessibility", - "markdown_source": "../docs/designers-developers/developers/accessibility.md", - "parent": "developers" + "title": "Glossary", + "slug": "glossary", + "markdown_source": "../docs/getting-started/glossary.md", + "parent": "getting-started" }, { - "title": "Internationalization", - "slug": "internationalization", - "markdown_source": "../docs/designers-developers/developers/internationalization.md", - "parent": "developers" + "title": "Frequently Asked Questions", + "slug": "faq", + "markdown_source": "../docs/getting-started/faq.md", + "parent": "getting-started" }, { - "title": "Tutorials", - "slug": "tutorials", - "markdown_source": "../docs/designers-developers/developers/tutorials/readme.md", - "parent": "developers" + "title": "History", + "slug": "history", + "markdown_source": "../docs/getting-started/history.md", + "parent": "getting-started" }, { - "title": "Development Environment", - "slug": "devenv", - "markdown_source": "../docs/designers-developers/developers/tutorials/devenv/readme.md", - "parent": "tutorials" + "title": "Outreach", + "slug": "outreach", + "markdown_source": "../docs/getting-started/outreach.md", + "parent": "getting-started" }, { - "title": "How to setup local WordPress environment on Ubuntu", - "slug": "docker-ubuntu", - "markdown_source": "../docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md", - "parent": "devenv" + "title": "Developer Documentation", + "slug": "howto-guides", + "markdown_source": "../docs/howto-guides/README.md", + "parent": null }, { "title": "Getting Started with JavaScript", "slug": "javascript", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/readme.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/javascript/README.md", + "parent": "howto-guides" }, { "title": "Plugins Background", "slug": "plugins-background", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/plugins-background.md", + "markdown_source": "../docs/howto-guides/javascript/plugins-background.md", "parent": "javascript" }, { "title": "Loading JavaScript", "slug": "loading-javascript", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/loading-javascript.md", + "markdown_source": "../docs/howto-guides/javascript/loading-javascript.md", "parent": "javascript" }, { "title": "Extending the Block Editor", "slug": "extending-the-block-editor", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md", + "markdown_source": "../docs/howto-guides/javascript/extending-the-block-editor.md", "parent": "javascript" }, { "title": "Troubleshooting", "slug": "troubleshooting", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/troubleshooting.md", + "markdown_source": "../docs/howto-guides/javascript/troubleshooting.md", "parent": "javascript" }, { "title": "JavaScript Versions and Build Step", "slug": "versions-and-building", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/versions-and-building.md", + "markdown_source": "../docs/howto-guides/javascript/versions-and-building.md", "parent": "javascript" }, { "title": "Scope Your Code", "slug": "scope-your-code", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/scope-your-code.md", + "markdown_source": "../docs/howto-guides/javascript/scope-your-code.md", "parent": "javascript" }, { "title": "JavaScript Build Setup", "slug": "js-build-setup", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/js-build-setup.md", + "markdown_source": "../docs/howto-guides/javascript/js-build-setup.md", "parent": "javascript" }, { "title": "ESNext Syntax", "slug": "esnext-js", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/esnext-js.md", + "markdown_source": "../docs/howto-guides/javascript/esnext-js.md", "parent": "javascript" }, { - "title": "Create a Block Tutorial", - "slug": "create-block", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/readme.md", - "parent": "tutorials" + "title": "Meta Boxes", + "slug": "metabox", + "markdown_source": "../docs/howto-guides/metabox/README.md", + "parent": "howto-guides" }, { - "title": "WordPress Plugin", - "slug": "wp-plugin", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/wp-plugin.md", - "parent": "create-block" + "title": "Store Post Meta with a Block", + "slug": "meta-block-1-intro", + "markdown_source": "../docs/howto-guides/metabox/meta-block-1-intro.md", + "parent": "metabox" }, { - "title": "Anatomy of a Block", - "slug": "block-anatomy", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/block-anatomy.md", - "parent": "create-block" + "title": "Register Meta Field", + "slug": "meta-block-2-register-meta", + "markdown_source": "../docs/howto-guides/metabox/meta-block-2-register-meta.md", + "parent": "metabox" }, { - "title": "Block Attributes", - "slug": "attributes", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/attributes.md", - "parent": "create-block" + "title": "Create Meta Block", + "slug": "meta-block-3-add", + "markdown_source": "../docs/howto-guides/metabox/meta-block-3-add.md", + "parent": "metabox" }, { - "title": "Code Implementation", - "slug": "block-code", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/block-code.md", - "parent": "create-block" + "title": "Use Post Meta Data", + "slug": "meta-block-4-use-data", + "markdown_source": "../docs/howto-guides/metabox/meta-block-4-use-data.md", + "parent": "metabox" }, { - "title": "Authoring Experience", - "slug": "author-experience", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/author-experience.md", - "parent": "create-block" + "title": "Finishing Touches", + "slug": "meta-block-5-finishing", + "markdown_source": "../docs/howto-guides/metabox/meta-block-5-finishing.md", + "parent": "metabox" }, { - "title": "Finishing Touches", - "slug": "finishing", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/finishing.md", - "parent": "create-block" + "title": "Displaying Notices from Your Plugin or Theme", + "slug": "notices", + "markdown_source": "../docs/howto-guides/notices/README.md", + "parent": "howto-guides" }, { - "title": "Share your Block with the World", - "slug": "submitting-to-block-directory", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md", - "parent": "create-block" + "title": "Creating a Sidebar for Your Plugin", + "slug": "plugin-sidebar-0", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md", + "parent": "howto-guides" + }, + { + "title": "Get a Sidebar up and Running", + "slug": "plugin-sidebar-1-up-and-running", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Tweak the sidebar style and add controls", + "slug": "plugin-sidebar-2-styles-and-controls", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Register the Meta Field", + "slug": "plugin-sidebar-3-register-meta", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Initialize the Input Control", + "slug": "plugin-sidebar-4-initialize-input", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Update the Meta Field When the Input's Content Changes", + "slug": "plugin-sidebar-5-update-meta", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Finishing Touches", + "slug": "plugin-sidebar-6-finishing-touches", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", + "parent": "plugin-sidebar-0" }, { "title": "Blocks", "slug": "block-tutorial", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/readme.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/block-tutorial/README.md", + "parent": "howto-guides" }, { "title": "Writing Your First Block Type", "slug": "writing-your-first-block-type", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md", + "markdown_source": "../docs/howto-guides/block-tutorial/writing-your-first-block-type.md", "parent": "block-tutorial" }, { "title": "Applying Styles From a Stylesheet", "slug": "applying-styles-with-stylesheets", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md", + "markdown_source": "../docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md", "parent": "block-tutorial" }, { "title": "Introducing Attributes and Editable Fields", "slug": "introducing-attributes-and-editable-fields", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md", + "markdown_source": "../docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md", "parent": "block-tutorial" }, { "title": "Block Controls: Block Toolbar and Settings Sidebar", "slug": "block-controls-toolbar-and-sidebar", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md", + "markdown_source": "../docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", "parent": "block-tutorial" }, { "title": "Creating dynamic blocks", "slug": "creating-dynamic-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md", + "markdown_source": "../docs/howto-guides/block-tutorial/creating-dynamic-blocks.md", "parent": "block-tutorial" }, { "title": "Generate Blocks with WP-CLI", "slug": "generate-blocks-with-wp-cli", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md", + "markdown_source": "../docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md", "parent": "block-tutorial" }, { "title": "Nested Blocks: Using InnerBlocks", "slug": "nested-blocks-inner-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md", + "markdown_source": "../docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md", "parent": "block-tutorial" }, { - "title": "Meta Boxes", - "slug": "metabox", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/readme.md", - "parent": "tutorials" - }, - { - "title": "Store Post Meta with a Block", - "slug": "meta-block-1-intro", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md", - "parent": "metabox" - }, - { - "title": "Register Meta Field", - "slug": "meta-block-2-register-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md", - "parent": "metabox" - }, - { - "title": "Create Meta Block", - "slug": "meta-block-3-add", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md", - "parent": "metabox" - }, - { - "title": "Use Post Meta Data", - "slug": "meta-block-4-use-data", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md", - "parent": "metabox" - }, - { - "title": "Finishing Touches", - "slug": "meta-block-5-finishing", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md", - "parent": "metabox" + "title": "Feature Flags", + "slug": "feature-flags", + "markdown_source": "../docs/howto-guides/feature-flags.md", + "parent": "howto-guides" }, { - "title": "Displaying Notices from Your Plugin or Theme", - "slug": "notices", - "markdown_source": "../docs/designers-developers/developers/tutorials/notices/README.md", - "parent": "tutorials" + "title": "Theming for the Block Editor", + "slug": "themes", + "markdown_source": "../docs/howto-guides/themes/README.md", + "parent": "howto-guides" }, { - "title": "Creating a Sidebar for Your Plugin", - "slug": "plugin-sidebar-0", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md", - "parent": "tutorials" + "title": "Theme Support", + "slug": "theme-support", + "markdown_source": "../docs/howto-guides/themes/theme-support.md", + "parent": "themes" }, { - "title": "Get a Sidebar up and Running", - "slug": "plugin-sidebar-1-up-and-running", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", - "parent": "plugin-sidebar-0" + "title": "Themes & Block Editor: experimental theme.json", + "slug": "theme-json", + "markdown_source": "../docs/howto-guides/themes/theme-json.md", + "parent": "themes" }, { - "title": "Tweak the sidebar style and add controls", - "slug": "plugin-sidebar-2-styles-and-controls", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", - "parent": "plugin-sidebar-0" + "title": "Creating a block-based theme", + "slug": "block-based-themes", + "markdown_source": "../docs/howto-guides/block-based-themes/README.md", + "parent": "howto-guides" }, { - "title": "Register the Meta Field", - "slug": "plugin-sidebar-3-register-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md", - "parent": "plugin-sidebar-0" + "title": "Adding blocks to your theme", + "slug": "block-based-themes-2-adding-blocks", + "markdown_source": "../docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md", + "parent": "block-based-themes" }, { - "title": "Initialize the Input Control", - "slug": "plugin-sidebar-4-initialize-input", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", - "parent": "plugin-sidebar-0" + "title": "Backward Compatibility", + "slug": "backward-compatibility", + "markdown_source": "../docs/howto-guides/backward-compatibility/README.md", + "parent": "howto-guides" }, { - "title": "Update the Meta Field When the Input's Content Changes", - "slug": "plugin-sidebar-5-update-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md", - "parent": "plugin-sidebar-0" + "title": "Deprecations", + "slug": "deprecations", + "markdown_source": "../docs/howto-guides/backward-compatibility/deprecations.md", + "parent": "backward-compatibility" }, { - "title": "Finishing Touches", - "slug": "plugin-sidebar-6-finishing-touches", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", - "parent": "plugin-sidebar-0" + "title": "Meta Boxes", + "slug": "meta-box", + "markdown_source": "../docs/howto-guides/backward-compatibility/meta-box.md", + "parent": "backward-compatibility" }, { "title": "Introduction to the Format API", "slug": "format-api", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/README.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/format-api/README.md", + "parent": "howto-guides" }, { "title": "Register a New Format", "slug": "1-register-format", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/1-register-format.md", + "markdown_source": "../docs/howto-guides/format-api/1-register-format.md", "parent": "format-api" }, { "title": "Add a Button to the Toolbar", "slug": "2-toolbar-button", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md", + "markdown_source": "../docs/howto-guides/format-api/2-toolbar-button.md", "parent": "format-api" }, { "title": "Apply the Format When the Button Is Clicked", "slug": "3-apply-format", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/3-apply-format.md", + "markdown_source": "../docs/howto-guides/format-api/3-apply-format.md", "parent": "format-api" }, - { - "title": "Creating a block-based theme", - "slug": "block-based-themes", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-themes/README.md", - "parent": "tutorials" - }, - { - "title": "Adding blocks to your theme", - "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md", - "parent": "block-based-themes" - }, { "title": "Gutenberg as a Development Platform", "slug": "platform", - "markdown_source": "../docs/designers-developers/developers/platform/README.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/platform/README.md", + "parent": "howto-guides" }, { "title": "Building a custom block editor", "slug": "custom-block-editor", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", + "markdown_source": "../docs/howto-guides/platform/custom-block-editor/README.md", "parent": "platform" }, { "title": "Tutorial: building a custom block editor", "slug": "tutorial", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", + "markdown_source": "../docs/howto-guides/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, { "title": "Designer Documentation", "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null + "markdown_source": "../docs/howto-guides/designers/README.md", + "parent": "howto-guides" }, { "title": "Block Design", "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", + "markdown_source": "../docs/howto-guides/designers/block-design.md", "parent": "designers" }, { "title": "User Interface", "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "markdown_source": "../docs/howto-guides/designers/user-interface.md", "parent": "designers" }, { "title": "Resources", "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "markdown_source": "../docs/howto-guides/designers/design-resources.md", "parent": "designers" }, { "title": "Animation", "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", + "markdown_source": "../docs/howto-guides/designers/animation.md", "parent": "designers" }, { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", + "title": "Accessibility", + "slug": "accessibility", + "markdown_source": "../docs/howto-guides/accessibility.md", + "parent": "howto-guides" + }, + { + "title": "Internationalization", + "slug": "internationalization", + "markdown_source": "../docs/howto-guides/internationalization.md", + "parent": "howto-guides" + }, + { + "title": "ReferenceGuides", + "slug": "reference-guides", + "markdown_source": "../docs/reference-guides/README.md", "parent": null }, { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" + "title": "Block API Reference", + "slug": "block-api", + "markdown_source": "../docs/reference-guides/block-api/README.md", + "parent": "reference-guides" }, { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" + "title": "Block Registration", + "slug": "block-registration", + "markdown_source": "../docs/reference-guides/block-api/block-registration.md", + "parent": "block-api" }, { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" + "title": "Edit and Save", + "slug": "block-edit-save", + "markdown_source": "../docs/reference-guides/block-api/block-edit-save.md", + "parent": "block-api" }, { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" + "title": "Attributes", + "slug": "block-attributes", + "markdown_source": "../docs/reference-guides/block-api/block-attributes.md", + "parent": "block-api" }, { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" + "title": "Block Context", + "slug": "block-context", + "markdown_source": "../docs/reference-guides/block-api/block-context.md", + "parent": "block-api" + }, + { + "title": "Deprecated Blocks", + "slug": "block-deprecation", + "markdown_source": "../docs/reference-guides/block-api/block-deprecation.md", + "parent": "block-api" + }, + { + "title": "Block Supports", + "slug": "block-supports", + "markdown_source": "../docs/reference-guides/block-api/block-supports.md", + "parent": "block-api" }, { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" + "title": "Block Transforms", + "slug": "block-transforms", + "markdown_source": "../docs/reference-guides/block-api/block-transforms.md", + "parent": "block-api" }, { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" + "title": "Templates", + "slug": "block-templates", + "markdown_source": "../docs/reference-guides/block-api/block-templates.md", + "parent": "block-api" }, { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" + "title": "Block Type Metadata", + "slug": "block-metadata", + "markdown_source": "../docs/reference-guides/block-api/block-metadata.md", + "parent": "block-api" }, { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" + "title": "Block Patterns", + "slug": "block-patterns", + "markdown_source": "../docs/reference-guides/block-api/block-patterns.md", + "parent": "block-api" }, { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" + "title": "Annotations", + "slug": "block-annotations", + "markdown_source": "../docs/reference-guides/block-api/block-annotations.md", + "parent": "block-api" }, { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" + "title": "Block API Versions", + "slug": "versions", + "markdown_source": "../docs/reference-guides/block-api/versions.md", + "parent": "block-api" }, { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" + "title": "Filter Reference", + "slug": "filters", + "markdown_source": "../docs/reference-guides/filters/README.md", + "parent": "reference-guides" }, { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" + "title": "Block Filters", + "slug": "block-filters", + "markdown_source": "../docs/reference-guides/filters/block-filters.md", + "parent": "filters" }, { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" + "title": "Editor Filters", + "slug": "editor-filters", + "markdown_source": "../docs/reference-guides/filters/editor-filters.md", + "parent": "filters" }, { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" + "title": "Parser Filters", + "slug": "parser-filters", + "markdown_source": "../docs/reference-guides/filters/parser-filters.md", + "parent": "filters" }, { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" + "title": "Autocomplete", + "slug": "autocomplete-filters", + "markdown_source": "../docs/reference-guides/filters/autocomplete-filters.md", + "parent": "filters" }, { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" + "title": "SlotFills Reference", + "slug": "slotfills", + "markdown_source": "../docs/reference-guides/slotfills/README.md", + "parent": "reference-guides" }, { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" + "title": "MainDashboardButton", + "slug": "main-dashboard-button", + "markdown_source": "../docs/reference-guides/slotfills/main-dashboard-button.md", + "parent": "slotfills" }, { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" + "title": "PluginBlockSettingsMenuItem", + "slug": "plugin-block-settings-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-block-settings-menu-item.md", + "parent": "slotfills" }, { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/architecture/readme.md", - "parent": null + "title": "PluginDocumentSettingPanel", + "slug": "plugin-document-setting-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-document-setting-panel.md", + "parent": "slotfills" }, { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/architecture/key-concepts.md", - "parent": "architecture" + "title": "PluginMoreMenuItem", + "slug": "plugin-more-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-more-menu-item.md", + "parent": "slotfills" }, { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/architecture/data-flow.md", - "parent": "architecture" + "title": "PluginPostPublishPanel", + "slug": "plugin-post-publish-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-post-publish-panel.md", + "parent": "slotfills" }, { - "title": "Folder Structure", - "slug": "folder-structure", - "markdown_source": "../docs/architecture/folder-structure.md", - "parent": "architecture" + "title": "PluginPostStatusInfo", + "slug": "plugin-post-status-info", + "markdown_source": "../docs/reference-guides/slotfills/plugin-post-status-info.md", + "parent": "slotfills" }, { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/architecture/modularity.md", - "parent": "architecture" + "title": "PluginPrePublishPanel", + "slug": "plugin-pre-publish-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-pre-publish-panel.md", + "parent": "slotfills" }, { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/architecture/performance.md", - "parent": "architecture" + "title": "PluginSidebar", + "slug": "plugin-sidebar", + "markdown_source": "../docs/reference-guides/slotfills/plugin-sidebar.md", + "parent": "slotfills" }, { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/architecture/automated-testing.md", - "parent": "architecture" + "title": "PluginSidebarMoreMenuItem", + "slug": "plugin-sidebar-more-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md", + "parent": "slotfills" }, { - "title": "Appendix", - "slug": "appendix", - "markdown_source": "../docs/appendix/readme.md", - "parent": null + "title": "RichText Reference", + "slug": "richtext", + "markdown_source": "../docs/reference-guides/richtext.md", + "parent": "reference-guides" }, { "title": "Component Reference", "slug": "components", "markdown_source": "../packages/components/README.md", - "parent": "appendix" + "parent": "reference-guides" }, { "title": "AlignmentMatrixControl", @@ -1256,8 +1154,8 @@ { "title": "Package Reference", "slug": "packages", - "markdown_source": "../docs/appendix/packages.md", - "parent": "appendix" + "markdown_source": "../docs/reference-guides/packages.md", + "parent": "reference-guides" }, { "title": "@wordpress/a11y", @@ -1766,109 +1664,211 @@ { "title": "Data Module Reference", "slug": "data", - "markdown_source": "../docs/appendix/data/README.md", - "parent": "appendix" + "markdown_source": "../docs/reference-guides/data/README.md", + "parent": "reference-guides" }, { "title": "WordPress Core Data", "slug": "data-core", - "markdown_source": "../docs/appendix/data/data-core.md", + "markdown_source": "../docs/reference-guides/data/data-core.md", "parent": "data" }, { "title": "Annotations", "slug": "data-core-annotations", - "markdown_source": "../docs/appendix/data/data-core-annotations.md", + "markdown_source": "../docs/reference-guides/data/data-core-annotations.md", "parent": "data" }, { "title": "Block Types Data", "slug": "data-core-blocks", - "markdown_source": "../docs/appendix/data/data-core-blocks.md", + "markdown_source": "../docs/reference-guides/data/data-core-blocks.md", "parent": "data" }, { "title": "The Block Editor’s Data", "slug": "data-core-block-editor", - "markdown_source": "../docs/appendix/data/data-core-block-editor.md", + "markdown_source": "../docs/reference-guides/data/data-core-block-editor.md", "parent": "data" }, { "title": "The Post Editor’s Data", "slug": "data-core-editor", - "markdown_source": "../docs/appendix/data/data-core-editor.md", + "markdown_source": "../docs/reference-guides/data/data-core-editor.md", "parent": "data" }, { "title": "The Editor’s UI Data", "slug": "data-core-edit-post", - "markdown_source": "../docs/appendix/data/data-core-edit-post.md", + "markdown_source": "../docs/reference-guides/data/data-core-edit-post.md", "parent": "data" }, { "title": "Notices Data", "slug": "data-core-notices", - "markdown_source": "../docs/appendix/data/data-core-notices.md", + "markdown_source": "../docs/reference-guides/data/data-core-notices.md", "parent": "data" }, { "title": "The NUX (New User Experience) Data", "slug": "data-core-nux", - "markdown_source": "../docs/appendix/data/data-core-nux.md", + "markdown_source": "../docs/reference-guides/data/data-core-nux.md", "parent": "data" }, { "title": "The Viewport Data", "slug": "data-core-viewport", - "markdown_source": "../docs/appendix/data/data-core-viewport.md", + "markdown_source": "../docs/reference-guides/data/data-core-viewport.md", "parent": "data" }, { - "title": "Backward Compatibility", - "slug": "backward-compatibility", - "markdown_source": "../docs/appendix/backward-compatibility/README.md", - "parent": "appendix" + "title": "Explanations", + "slug": "explanations", + "markdown_source": "../docs/explanations/README.md", + "parent": null }, { - "title": "Deprecations", - "slug": "deprecations", - "markdown_source": "../docs/appendix/backward-compatibility/deprecations.md", - "parent": "backward-compatibility" + "title": "FullSiteEditingTemplates", + "slug": "full-site-editing-templates", + "markdown_source": "../docs/explanations/full-site-editing-templates.md", + "parent": "explanations" }, { - "title": "Meta Boxes", - "slug": "meta-box", - "markdown_source": "../docs/appendix/backward-compatibility/meta-box.md", - "parent": "backward-compatibility" + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/README.md", + "parent": null }, { - "title": "Glossary", - "slug": "glossary", - "markdown_source": "../docs/appendix/glossary.md", - "parent": "appendix" + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/code/develop.md", + "parent": "contributors" }, { - "title": "Frequently Asked Questions", - "slug": "faq", - "markdown_source": "../docs/appendix/faq.md", - "parent": "appendix" + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/code/getting-started.md", + "parent": "develop" }, { - "title": "Versions in WordPress", - "slug": "versions-in-wordpress", - "markdown_source": "../docs/appendix/versions-in-wordpress.md", - "parent": "appendix" + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/code/git-workflow.md", + "parent": "develop" }, { - "title": "History", - "slug": "history", - "markdown_source": "../docs/appendix/history.md", - "parent": "appendix" + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/code/coding-guidelines.md", + "parent": "develop" }, { - "title": "Outreach", - "slug": "outreach", - "markdown_source": "../docs/appendix/outreach.md", - "parent": "appendix" + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/code/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/code/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/code/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/code/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/code/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/code/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/code/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/design/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/design/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/documentation/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/documentation/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, + { + "title": "Folder Structure", + "slug": "folder-structure", + "markdown_source": "../docs/contributors/folder-structure.md", + "parent": "contributors" + }, + { + "title": "Versions in WordPress", + "slug": "versions-in-wordpress", + "markdown_source": "../docs/contributors/versions-in-wordpress.md", + "parent": "contributors" + }, + { + "title": "Upcoming Projects & Roadmap", + "slug": "roadmap", + "markdown_source": "../docs/contributors/roadmap.md", + "parent": "contributors" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 7da4490ede0a5..8dc2de711652a 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,222 +1,173 @@ [ - { "docs/readme.md": [ - { "docs/designers-developers/glossary.md": [] }, - { "docs/designers-developers/faq.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/history.md": [] }, - { "docs/contributors/outreach.md": [] } - ] }, - { "docs/architecture/readme.md": [ - { "docs/architecture/key-concepts.md": [] }, - { "docs/architecture/data-flow.md": [] }, - { "docs/architecture/folder-structure.md": [] }, - { "docs/architecture/modularity.md": [] }, - { "docs/architecture/performance.md": [] }, - { "docs/architecture/automated-testing.md": [] }, - { "docs/architecture/fse-templates.md": [] } + { "docs/getting-started/README.md": [ + { "docs/getting-started/tutorials/README.md": [ + { "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] } + ] }, + { "docs/getting-started/architecture/README.md": [ + { "docs/getting-started/architecture/key-concepts.md": [] }, + { "docs/getting-started/architecture/data-flow.md": [] }, + { "docs/getting-started/architecture/modularity.md": [] }, + { "docs/getting-started/architecture/performance.md": [] }, + { "docs/getting-started/architecture/automated-testing.md": [] } + ] }, + { "docs/getting-started/glossary.md": [] }, + { "docs/getting-started/faq.md": [] }, + { "docs/getting-started/history.md": [] }, + { "docs/getting-started/outreach.md": [] } ] }, - { "docs/designers-developers/developers/README.md": [ - { "docs/designers-developers/developers/block-api/README.md": [ - { "docs/designers-developers/developers/block-api/block-registration.md": [] }, - { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, - { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, - { "docs/designers-developers/developers/block-api/block-context.md": [] }, - { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, - { "docs/designers-developers/developers/block-api/block-supports.md": [] }, - { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, - { "docs/designers-developers/developers/block-api/block-templates.md": [] }, - { "docs/designers-developers/developers/block-api/block-metadata.md": [] }, - { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, - { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, - { "docs/designers-developers/developers/block-api/versions.md": [] } - ] }, - { "docs/designers-developers/developers/filters/README.md": [ - { "docs/designers-developers/developers/filters/block-filters.md": [] }, - { "docs/designers-developers/developers/filters/editor-filters.md": [] }, - { "docs/designers-developers/developers/filters/parser-filters.md": [] }, - { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } - ] }, - {"docs/designers-developers/developers/slotfills/README.md": [ - { "docs/designers-developers/developers/slotfills/main-dashboard-button.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-more-menu-item.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-post-status-info.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-sidebar.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/designers-developers/developers/richtext.md": [] }, - { "docs/designers-developers/developers/feature-flags.md": [] }, + { "docs/howto-guides/README.md": [ + { "docs/howto-guides/javascript/README.md": [ + { "docs/howto-guides/javascript/plugins-background.md": [] }, + { "docs/howto-guides/javascript/loading-javascript.md": [] }, + { "docs/howto-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/howto-guides/javascript/troubleshooting.md": [] }, + { "docs/howto-guides/javascript/versions-and-building.md": [] }, + { "docs/howto-guides/javascript/scope-your-code.md": [] }, + { "docs/howto-guides/javascript/js-build-setup.md": [] }, + { "docs/howto-guides/javascript/esnext-js.md": [] } + ] }, + { "docs/howto-guides/metabox/README.md": [ + { "docs/howto-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/howto-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/howto-guides/metabox/meta-block-3-add.md": [] }, + { "docs/howto-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/howto-guides/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/howto-guides/notices/README.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/howto-guides/block-tutorial/README.md": [ + { "docs/howto-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/howto-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/howto-guides/feature-flags.md": [] }, + { "docs/howto-guides/themes/README.md": [ + { "docs/howto-guides/themes/theme-support.md": [] }, + { "docs/howto-guides/themes/theme-json.md": [] } + ] }, + { "docs/howto-guides/block-based-themes/README.md": [ + { "docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/howto-guides/backward-compatibility/README.md": [ + { "docs/howto-guides/backward-compatibility/deprecations.md": [] }, + { "docs/howto-guides/backward-compatibility/meta-box.md": [] } + ] }, - { "docs/designers-developers/developers/themes/README.md": [ - { "docs/designers-developers/developers/themes/theme-support.md": [] }, - { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, - { "docs/designers-developers/developers/themes/theme-json.md": [] } - ] }, - { "docs/designers-developers/developers/accessibility.md": [] }, - { "docs/designers-developers/developers/internationalization.md": [] }, - { "docs/designers-developers/developers/tutorials/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ - { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ - { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ - { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ - { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/format-api/README.md": [ - { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ - { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/platform/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } - ] } - ] } - ] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] }, - { "docs/contributors/readme.md": [ - { "docs/contributors/develop.md": [ - { "docs/contributors/getting-started.md": [] }, - { "docs/contributors/git-workflow.md": [] }, - { "docs/contributors/coding-guidelines.md": [] }, - { "docs/contributors/testing-overview.md": [] }, - { "docs/contributors/grammar.md": [] }, - { "docs/contributors/scripts.md": [] }, - { "docs/contributors/managing-packages.md": [] }, - { "docs/contributors/release.md": [] }, - { "docs/contributors/native-mobile.md": [] }, - { "docs/contributors/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design.md": [ - { "docs/contributors/the-block.md": [] }, - { "docs/contributors/reference.md": [] } - ] }, - { "docs/contributors/document.md": [ - { "docs/contributors/copy-guide.md": [] } + { "docs/howto-guides/format-api/README.md": [ + { "docs/howto-guides/format-api/1-register-format.md": [] }, + { "docs/howto-guides/format-api/2-toolbar-button.md": [] }, + { "docs/howto-guides/format-api/3-apply-format.md": [] } ] }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/repository-management.md": [] } + { "docs/howto-guides/platform/README.md": [ + { "docs/howto-guides/platform/custom-block-editor/README.md": [ + { "docs/howto-guides/platform/custom-block-editor/tutorial.md": [] } + ] } + ] }, + { "docs/howto-guides/designers/README.md": [ + { "docs/howto-guides/designers/block-design.md": [] }, + { "docs/howto-guides/designers/user-interface.md": [] }, + { "docs/howto-guides/designers/design-resources.md": [] }, + { "docs/howto-guides/designers/animation.md": [] } + ] }, + { "docs/howto-guides/accessibility.md": [] }, + { "docs/howto-guides/internationalization.md": [] } ] }, - { "docs/designers-developers/developers/tutorials/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ - { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ - { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ - { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ - { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/format-api/README.md": [ - { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ - { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + { "docs/reference-guides/README.md": [ + { "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] }, + { "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] }, + {"docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ]}, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": []}, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } ] } ] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/designers-developers/developers/data/README.md": [ - { "docs/designers-developers/developers/data/data-core.md": []}, - { "docs/designers-developers/developers/data/data-core-annotations.md": [] }, - { "docs/designers-developers/developers/data/data-core-blocks.md": [] }, - { "docs/designers-developers/developers/data/data-core-block-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-edit-post.md": [] }, - { "docs/designers-developers/developers/data/data-core-notices.md": [] }, - { "docs/designers-developers/developers/data/data-core-nux.md": [] }, - { "docs/designers-developers/developers/data/data-core-viewport.md": [] } + { "docs/explanations/README.md": [ + { "docs/explanations/full-site-editing-templates.md": [] } ] }, - { "docs/designers-developers/developers/packages.md": "{{packages}}" } + { "docs/contributors/README.md": [ + { "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] }, + { "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } + ] }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] } ] From 11a2040a5111bab7883a2a1e051ad11ece279ac0 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 12:09:41 +0100 Subject: [PATCH 12/68] Update the folder structure of docs/ following toc.json --- docs/appendix/README.md | 10 ---------- docs/contributors/{ => code}/coding-guidelines.md | 0 docs/contributors/{ => code}/develop.md | 0 .../{ => code}/getting-started-native-mobile.md | 0 docs/contributors/{ => code}/getting-started.md | 0 docs/contributors/{ => code}/git-workflow.md | 0 docs/contributors/{ => code}/grammar.md | 0 docs/contributors/{ => code}/managing-packages.md | 0 docs/contributors/{ => code}/native-mobile.md | 0 docs/contributors/{ => code}/release.md | 0 docs/contributors/{ => code}/scripts.md | 0 docs/contributors/{ => code}/testing-overview.md | 0 docs/contributors/{ => design}/design.md | 0 docs/contributors/{ => design}/reference.md | 0 docs/contributors/{ => design}/the-block.md | 0 docs/contributors/{ => documentation}/copy-guide.md | 0 docs/contributors/{ => documentation}/document.md | 0 .../folder-structure.md | 0 docs/{ => contributors}/roadmap.md | 0 .../versions-in-wordpress.md | 0 docs/explanations/README.md | 0 .../full-site-editing-templates.md | 0 docs/{readme.md => getting-started/README.md} | 0 .../architecture/README.md} | 0 .../architecture/automated-testing.md | 0 .../{ => getting-started}/architecture/data-flow.md | 0 .../architecture/key-concepts.md | 0 .../architecture/modularity.md | 0 .../architecture/performance.md | 0 docs/{appendix => getting-started}/faq.md | 0 docs/{appendix => getting-started}/glossary.md | 0 docs/{appendix => getting-started}/history.md | 0 docs/{appendix => getting-started}/outreach.md | 0 .../tutorials/README.md} | 0 .../tutorials/create-block/README.md} | 0 .../tutorials/create-block/attributes.md | 0 .../tutorials/create-block/author-experience.md | 0 .../tutorials/create-block/block-anatomy.md | 0 .../tutorials/create-block/block-code.md | 0 .../tutorials/create-block/finishing.md | 0 .../create-block/submitting-to-block-directory.md | 0 .../tutorials/create-block/wp-plugin.md | 0 .../tutorials/devenv/README.md} | 0 .../tutorials/devenv/docker-ubuntu.md | 0 .../developers => howto-guides}/README.md | 0 .../developers => howto-guides}/accessibility.md | 0 .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin .../assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../assets/js-tutorial-console-log-success.png | Bin .../assets/js-tutorial-error-blocks-undefined.png | Bin .../plugin-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../assets/plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin .../assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin .../backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../backward-compatibility/meta-box.md | 0 .../block-based-themes/README.md | 0 .../block-based-themes-2-adding-blocks.md | 0 .../block-tutorial/README.md} | 0 .../applying-styles-with-stylesheets.md | 0 .../block-controls-toolbar-and-sidebar.md | 0 .../block-tutorial/creating-dynamic-blocks.md | 0 .../block-tutorial/generate-blocks-with-wp-cli.md | 0 .../introducing-attributes-and-editable-fields.md | 0 .../block-tutorial/nested-blocks-inner-blocks.md | 0 .../block-tutorial/writing-your-first-block-type.md | 0 .../designers/README.md | 0 .../designers/animation.md | 0 .../designers/assets/advanced-settings-do.png | Bin .../designers/assets/block-controls-do.png | Bin .../designers/assets/block-controls-dont.png | Bin .../designers/assets/block-descriptions-do.png | Bin .../designers/assets/block-descriptions-dont.png | Bin .../designers/assets/blocks-do.png | Bin .../designers/assets/blocks-dont.png | Bin .../designers/assets/placeholder-do.png | Bin .../designers/assets/placeholder-dont.png | Bin .../designers/block-design.md | 0 .../designers/design-resources.md | 0 .../designers/user-interface.md | 0 .../developers => howto-guides}/feature-flags.md | 0 .../format-api/1-register-format.md | 0 .../format-api/2-toolbar-button.md | 0 .../format-api/3-apply-format.md | 0 .../tutorials => howto-guides}/format-api/README.md | 0 .../internationalization.md | 0 .../readme.md => howto-guides/javascript/README.md} | 0 .../javascript/esnext-js.md | 0 .../javascript/extending-the-block-editor.md | 0 .../javascript/js-build-setup.md | 0 .../javascript/loading-javascript.md | 0 .../javascript/plugins-background.md | 0 .../javascript/scope-your-code.md | 0 .../javascript/troubleshooting.md | 0 .../javascript/versions-and-building.md | 0 .../readme.md => howto-guides/metabox/README.md} | 0 .../metabox/meta-block-1-intro.md | 0 .../metabox/meta-block-2-register-meta.md | 0 .../metabox/meta-block-3-add.md | 0 .../metabox/meta-block-4-use-data.md | 0 .../metabox/meta-block-5-finishing.md | 0 .../metabox/meta-block.png | Bin .../tutorials => howto-guides}/notices/README.md | 0 .../notices/block-editor-notice.png | Bin .../notices/classic-editor-notice.png | Bin .../developers => howto-guides}/platform/README.md | 0 .../platform/custom-block-editor/README.md | 0 .../platform/custom-block-editor/tutorial.md | 0 .../sidebar-tutorial/plugin-sidebar-0.md | 0 .../plugin-sidebar-1-up-and-running.md | 0 .../plugin-sidebar-2-styles-and-controls.md | 0 .../plugin-sidebar-3-register-meta.md | 0 .../plugin-sidebar-4-initialize-input.md | 0 .../plugin-sidebar-5-update-meta.md | 0 .../plugin-sidebar-6-finishing-touches.md | 0 .../developers => howto-guides}/themes/README.md | 0 .../themes/block-based-themes.md | 0 .../themes/theme-json.md | 0 .../themes/theme-support.md | 0 docs/reference-guides/README.md | 0 .../block-api/README.md | 0 .../block-api/block-annotations.md | 0 .../block-api/block-attributes.md | 0 .../block-api/block-context.md | 0 .../block-api/block-deprecation.md | 0 .../block-api/block-edit-save.md | 0 .../block-api/block-metadata.md | 0 .../block-api/block-patterns.md | 0 .../block-api/block-registration.md | 0 .../block-api/block-supports.md | 0 .../block-api/block-templates.md | 0 .../block-api/block-transforms.md | 0 .../block-api/versions.md | 0 docs/{appendix => reference-guides}/data/README.md | 0 .../data/data-core-annotations.md | 0 .../data/data-core-block-editor.md | 0 .../data/data-core-blocks.md | 0 .../data/data-core-edit-post.md | 0 .../data/data-core-editor.md | 0 .../data/data-core-keyboard-shortcuts.md | 0 .../data/data-core-notices.md | 0 .../data/data-core-nux.md | 0 .../data/data-core-viewport.md | 0 .../data/data-core.md | 0 .../filters/README.md | 0 .../filters/autocomplete-filters.md | 0 .../filters/block-filters.md | 0 .../filters/editor-filters.md | 0 .../filters/i18n-filters.md | 0 .../filters/parser-filters.md | 0 docs/{appendix => reference-guides}/packages.md | 0 .../developers => reference-guides}/richtext.md | 0 .../slotfills/README.md | 0 .../slotfills/main-dashboard-button.md | 0 .../slotfills/plugin-block-settings-menu-item.md | 0 .../slotfills/plugin-document-setting-panel.md | 0 .../slotfills/plugin-more-menu-item.md | 0 .../slotfills/plugin-post-publish-panel.md | 0 .../slotfills/plugin-post-status-info.md | 0 .../slotfills/plugin-pre-publish-panel.md | 0 .../slotfills/plugin-sidebar-more-menu-item.md | 0 .../slotfills/plugin-sidebar.md | 0 173 files changed, 10 deletions(-) delete mode 100644 docs/appendix/README.md rename docs/contributors/{ => code}/coding-guidelines.md (100%) rename docs/contributors/{ => code}/develop.md (100%) rename docs/contributors/{ => code}/getting-started-native-mobile.md (100%) rename docs/contributors/{ => code}/getting-started.md (100%) rename docs/contributors/{ => code}/git-workflow.md (100%) rename docs/contributors/{ => code}/grammar.md (100%) rename docs/contributors/{ => code}/managing-packages.md (100%) rename docs/contributors/{ => code}/native-mobile.md (100%) rename docs/contributors/{ => code}/release.md (100%) rename docs/contributors/{ => code}/scripts.md (100%) rename docs/contributors/{ => code}/testing-overview.md (100%) rename docs/contributors/{ => design}/design.md (100%) rename docs/contributors/{ => design}/reference.md (100%) rename docs/contributors/{ => design}/the-block.md (100%) rename docs/contributors/{ => documentation}/copy-guide.md (100%) rename docs/contributors/{ => documentation}/document.md (100%) rename docs/{architecture => contributors}/folder-structure.md (100%) rename docs/{ => contributors}/roadmap.md (100%) rename docs/{appendix => contributors}/versions-in-wordpress.md (100%) create mode 100644 docs/explanations/README.md rename docs/{designers-developers/developers => explanations}/full-site-editing-templates.md (100%) rename docs/{readme.md => getting-started/README.md} (100%) rename docs/{architecture/readme.md => getting-started/architecture/README.md} (100%) rename docs/{ => getting-started}/architecture/automated-testing.md (100%) rename docs/{ => getting-started}/architecture/data-flow.md (100%) rename docs/{ => getting-started}/architecture/key-concepts.md (100%) rename docs/{ => getting-started}/architecture/modularity.md (100%) rename docs/{ => getting-started}/architecture/performance.md (100%) rename docs/{appendix => getting-started}/faq.md (100%) rename docs/{appendix => getting-started}/glossary.md (100%) rename docs/{appendix => getting-started}/history.md (100%) rename docs/{appendix => getting-started}/outreach.md (100%) rename docs/{designers-developers/developers/tutorials/readme.md => getting-started/tutorials/README.md} (100%) rename docs/{designers-developers/developers/tutorials/create-block/readme.md => getting-started/tutorials/create-block/README.md} (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/attributes.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/author-experience.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/block-anatomy.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/block-code.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/finishing.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/submitting-to-block-directory.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/wp-plugin.md (100%) rename docs/{designers-developers/developers/tutorials/devenv/readme.md => getting-started/tutorials/devenv/README.md} (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/devenv/docker-ubuntu.md (100%) rename docs/{designers-developers/developers => howto-guides}/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/accessibility.md (100%) rename docs/{designers-developers => howto-guides}/assets/fancy-quote-in-inspector.png (100%) rename docs/{designers-developers => howto-guides}/assets/fancy-quote-with-style.png (100%) rename docs/{designers-developers => howto-guides}/assets/inspector.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-console-log-error.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-console-log-success.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-more-menu-item.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-post-publish-panel.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-post-status-info-location.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-pre-publish-panel.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-closed-state.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-open-state.png (100%) rename docs/{designers-developers => howto-guides}/assets/sidebar-style-and-controls.png (100%) rename docs/{designers-developers => howto-guides}/assets/sidebar-up-and-running.png (100%) rename docs/{designers-developers => howto-guides}/assets/toolbar-text.png (100%) rename docs/{designers-developers => howto-guides}/assets/toolbar-with-custom-button.png (100%) rename docs/{appendix => howto-guides}/backward-compatibility/README.md (100%) rename docs/{appendix => howto-guides}/backward-compatibility/deprecations.md (100%) rename docs/{appendix => howto-guides}/backward-compatibility/meta-box.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-based-themes/README.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-based-themes/block-based-themes-2-adding-blocks.md (100%) rename docs/{designers-developers/developers/tutorials/block-tutorial/readme.md => howto-guides/block-tutorial/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/applying-styles-with-stylesheets.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/block-controls-toolbar-and-sidebar.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/creating-dynamic-blocks.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/generate-blocks-with-wp-cli.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/introducing-attributes-and-editable-fields.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/nested-blocks-inner-blocks.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/writing-your-first-block-type.md (100%) rename docs/{designers-developers => howto-guides}/designers/README.md (100%) rename docs/{designers-developers => howto-guides}/designers/animation.md (100%) rename docs/{designers-developers => howto-guides}/designers/assets/advanced-settings-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-controls-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-controls-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-descriptions-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-descriptions-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/blocks-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/blocks-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/placeholder-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/placeholder-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/block-design.md (100%) rename docs/{designers-developers => howto-guides}/designers/design-resources.md (100%) rename docs/{designers-developers => howto-guides}/designers/user-interface.md (100%) rename docs/{designers-developers/developers => howto-guides}/feature-flags.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/1-register-format.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/2-toolbar-button.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/3-apply-format.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/internationalization.md (100%) rename docs/{designers-developers/developers/tutorials/javascript/readme.md => howto-guides/javascript/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/esnext-js.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/extending-the-block-editor.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/js-build-setup.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/loading-javascript.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/plugins-background.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/scope-your-code.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/troubleshooting.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/versions-and-building.md (100%) rename docs/{designers-developers/developers/tutorials/metabox/readme.md => howto-guides/metabox/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-1-intro.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-2-register-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-3-add.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-4-use-data.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-5-finishing.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block.png (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/README.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/block-editor-notice.png (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/classic-editor-notice.png (100%) rename docs/{designers-developers/developers => howto-guides}/platform/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/platform/custom-block-editor/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/platform/custom-block-editor/tutorial.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-0.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-1-up-and-running.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-3-register-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-4-initialize-input.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-5-update-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/block-based-themes.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/theme-json.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/theme-support.md (100%) create mode 100644 docs/reference-guides/README.md rename docs/{designers-developers/developers => reference-guides}/block-api/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-annotations.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-attributes.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-context.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-deprecation.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-edit-save.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-metadata.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-patterns.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-registration.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-supports.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-templates.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-transforms.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/versions.md (100%) rename docs/{appendix => reference-guides}/data/README.md (100%) rename docs/{appendix => reference-guides}/data/data-core-annotations.md (100%) rename docs/{appendix => reference-guides}/data/data-core-block-editor.md (100%) rename docs/{appendix => reference-guides}/data/data-core-blocks.md (100%) rename docs/{appendix => reference-guides}/data/data-core-edit-post.md (100%) rename docs/{appendix => reference-guides}/data/data-core-editor.md (100%) rename docs/{appendix => reference-guides}/data/data-core-keyboard-shortcuts.md (100%) rename docs/{appendix => reference-guides}/data/data-core-notices.md (100%) rename docs/{appendix => reference-guides}/data/data-core-nux.md (100%) rename docs/{appendix => reference-guides}/data/data-core-viewport.md (100%) rename docs/{appendix => reference-guides}/data/data-core.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/autocomplete-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/block-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/editor-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/i18n-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/parser-filters.md (100%) rename docs/{appendix => reference-guides}/packages.md (100%) rename docs/{designers-developers/developers => reference-guides}/richtext.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/main-dashboard-button.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-block-settings-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-document-setting-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-more-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-post-publish-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-post-status-info.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-pre-publish-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-sidebar-more-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-sidebar.md (100%) diff --git a/docs/appendix/README.md b/docs/appendix/README.md deleted file mode 100644 index e52bc7073548d..0000000000000 --- a/docs/appendix/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Appendix - -- [Package Reference](/docs/appendix/packages.md) -- [Data Module Reference](/docs/appendix/data/README.md) -- [Backward Compatibility](/docs/appendix/backward-compatibility/README.md) -- [Glossary](/docs/appendix/glossary.md) -- [Frequently Asked Questions](/docs/appendix/faq.md) -- [Versions in WordPress](/docs/appendix/versions-in-wordpress.md) -- [History](/docs/appendix/history.md) -- [Outreach](/docs/appendix/outreach) \ No newline at end of file diff --git a/docs/contributors/coding-guidelines.md b/docs/contributors/code/coding-guidelines.md similarity index 100% rename from docs/contributors/coding-guidelines.md rename to docs/contributors/code/coding-guidelines.md diff --git a/docs/contributors/develop.md b/docs/contributors/code/develop.md similarity index 100% rename from docs/contributors/develop.md rename to docs/contributors/code/develop.md diff --git a/docs/contributors/getting-started-native-mobile.md b/docs/contributors/code/getting-started-native-mobile.md similarity index 100% rename from docs/contributors/getting-started-native-mobile.md rename to docs/contributors/code/getting-started-native-mobile.md diff --git a/docs/contributors/getting-started.md b/docs/contributors/code/getting-started.md similarity index 100% rename from docs/contributors/getting-started.md rename to docs/contributors/code/getting-started.md diff --git a/docs/contributors/git-workflow.md b/docs/contributors/code/git-workflow.md similarity index 100% rename from docs/contributors/git-workflow.md rename to docs/contributors/code/git-workflow.md diff --git a/docs/contributors/grammar.md b/docs/contributors/code/grammar.md similarity index 100% rename from docs/contributors/grammar.md rename to docs/contributors/code/grammar.md diff --git a/docs/contributors/managing-packages.md b/docs/contributors/code/managing-packages.md similarity index 100% rename from docs/contributors/managing-packages.md rename to docs/contributors/code/managing-packages.md diff --git a/docs/contributors/native-mobile.md b/docs/contributors/code/native-mobile.md similarity index 100% rename from docs/contributors/native-mobile.md rename to docs/contributors/code/native-mobile.md diff --git a/docs/contributors/release.md b/docs/contributors/code/release.md similarity index 100% rename from docs/contributors/release.md rename to docs/contributors/code/release.md diff --git a/docs/contributors/scripts.md b/docs/contributors/code/scripts.md similarity index 100% rename from docs/contributors/scripts.md rename to docs/contributors/code/scripts.md diff --git a/docs/contributors/testing-overview.md b/docs/contributors/code/testing-overview.md similarity index 100% rename from docs/contributors/testing-overview.md rename to docs/contributors/code/testing-overview.md diff --git a/docs/contributors/design.md b/docs/contributors/design/design.md similarity index 100% rename from docs/contributors/design.md rename to docs/contributors/design/design.md diff --git a/docs/contributors/reference.md b/docs/contributors/design/reference.md similarity index 100% rename from docs/contributors/reference.md rename to docs/contributors/design/reference.md diff --git a/docs/contributors/the-block.md b/docs/contributors/design/the-block.md similarity index 100% rename from docs/contributors/the-block.md rename to docs/contributors/design/the-block.md diff --git a/docs/contributors/copy-guide.md b/docs/contributors/documentation/copy-guide.md similarity index 100% rename from docs/contributors/copy-guide.md rename to docs/contributors/documentation/copy-guide.md diff --git a/docs/contributors/document.md b/docs/contributors/documentation/document.md similarity index 100% rename from docs/contributors/document.md rename to docs/contributors/documentation/document.md diff --git a/docs/architecture/folder-structure.md b/docs/contributors/folder-structure.md similarity index 100% rename from docs/architecture/folder-structure.md rename to docs/contributors/folder-structure.md diff --git a/docs/roadmap.md b/docs/contributors/roadmap.md similarity index 100% rename from docs/roadmap.md rename to docs/contributors/roadmap.md diff --git a/docs/appendix/versions-in-wordpress.md b/docs/contributors/versions-in-wordpress.md similarity index 100% rename from docs/appendix/versions-in-wordpress.md rename to docs/contributors/versions-in-wordpress.md diff --git a/docs/explanations/README.md b/docs/explanations/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/full-site-editing-templates.md b/docs/explanations/full-site-editing-templates.md similarity index 100% rename from docs/designers-developers/developers/full-site-editing-templates.md rename to docs/explanations/full-site-editing-templates.md diff --git a/docs/readme.md b/docs/getting-started/README.md similarity index 100% rename from docs/readme.md rename to docs/getting-started/README.md diff --git a/docs/architecture/readme.md b/docs/getting-started/architecture/README.md similarity index 100% rename from docs/architecture/readme.md rename to docs/getting-started/architecture/README.md diff --git a/docs/architecture/automated-testing.md b/docs/getting-started/architecture/automated-testing.md similarity index 100% rename from docs/architecture/automated-testing.md rename to docs/getting-started/architecture/automated-testing.md diff --git a/docs/architecture/data-flow.md b/docs/getting-started/architecture/data-flow.md similarity index 100% rename from docs/architecture/data-flow.md rename to docs/getting-started/architecture/data-flow.md diff --git a/docs/architecture/key-concepts.md b/docs/getting-started/architecture/key-concepts.md similarity index 100% rename from docs/architecture/key-concepts.md rename to docs/getting-started/architecture/key-concepts.md diff --git a/docs/architecture/modularity.md b/docs/getting-started/architecture/modularity.md similarity index 100% rename from docs/architecture/modularity.md rename to docs/getting-started/architecture/modularity.md diff --git a/docs/architecture/performance.md b/docs/getting-started/architecture/performance.md similarity index 100% rename from docs/architecture/performance.md rename to docs/getting-started/architecture/performance.md diff --git a/docs/appendix/faq.md b/docs/getting-started/faq.md similarity index 100% rename from docs/appendix/faq.md rename to docs/getting-started/faq.md diff --git a/docs/appendix/glossary.md b/docs/getting-started/glossary.md similarity index 100% rename from docs/appendix/glossary.md rename to docs/getting-started/glossary.md diff --git a/docs/appendix/history.md b/docs/getting-started/history.md similarity index 100% rename from docs/appendix/history.md rename to docs/getting-started/history.md diff --git a/docs/appendix/outreach.md b/docs/getting-started/outreach.md similarity index 100% rename from docs/appendix/outreach.md rename to docs/getting-started/outreach.md diff --git a/docs/designers-developers/developers/tutorials/readme.md b/docs/getting-started/tutorials/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/readme.md rename to docs/getting-started/tutorials/README.md diff --git a/docs/designers-developers/developers/tutorials/create-block/readme.md b/docs/getting-started/tutorials/create-block/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/readme.md rename to docs/getting-started/tutorials/create-block/README.md diff --git a/docs/designers-developers/developers/tutorials/create-block/attributes.md b/docs/getting-started/tutorials/create-block/attributes.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/attributes.md rename to docs/getting-started/tutorials/create-block/attributes.md diff --git a/docs/designers-developers/developers/tutorials/create-block/author-experience.md b/docs/getting-started/tutorials/create-block/author-experience.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/author-experience.md rename to docs/getting-started/tutorials/create-block/author-experience.md diff --git a/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/block-anatomy.md rename to docs/getting-started/tutorials/create-block/block-anatomy.md diff --git a/docs/designers-developers/developers/tutorials/create-block/block-code.md b/docs/getting-started/tutorials/create-block/block-code.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/block-code.md rename to docs/getting-started/tutorials/create-block/block-code.md diff --git a/docs/designers-developers/developers/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/finishing.md rename to docs/getting-started/tutorials/create-block/finishing.md diff --git a/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md rename to docs/getting-started/tutorials/create-block/submitting-to-block-directory.md diff --git a/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/wp-plugin.md rename to docs/getting-started/tutorials/create-block/wp-plugin.md diff --git a/docs/designers-developers/developers/tutorials/devenv/readme.md b/docs/getting-started/tutorials/devenv/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/devenv/readme.md rename to docs/getting-started/tutorials/devenv/README.md diff --git a/docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md b/docs/getting-started/tutorials/devenv/docker-ubuntu.md similarity index 100% rename from docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md rename to docs/getting-started/tutorials/devenv/docker-ubuntu.md diff --git a/docs/designers-developers/developers/README.md b/docs/howto-guides/README.md similarity index 100% rename from docs/designers-developers/developers/README.md rename to docs/howto-guides/README.md diff --git a/docs/designers-developers/developers/accessibility.md b/docs/howto-guides/accessibility.md similarity index 100% rename from docs/designers-developers/developers/accessibility.md rename to docs/howto-guides/accessibility.md diff --git a/docs/designers-developers/assets/fancy-quote-in-inspector.png b/docs/howto-guides/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/designers-developers/assets/fancy-quote-in-inspector.png rename to docs/howto-guides/assets/fancy-quote-in-inspector.png diff --git a/docs/designers-developers/assets/fancy-quote-with-style.png b/docs/howto-guides/assets/fancy-quote-with-style.png similarity index 100% rename from docs/designers-developers/assets/fancy-quote-with-style.png rename to docs/howto-guides/assets/fancy-quote-with-style.png diff --git a/docs/designers-developers/assets/inspector.png b/docs/howto-guides/assets/inspector.png similarity index 100% rename from docs/designers-developers/assets/inspector.png rename to docs/howto-guides/assets/inspector.png diff --git a/docs/designers-developers/assets/js-tutorial-console-log-error.png b/docs/howto-guides/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-console-log-error.png rename to docs/howto-guides/assets/js-tutorial-console-log-error.png diff --git a/docs/designers-developers/assets/js-tutorial-console-log-success.png b/docs/howto-guides/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-console-log-success.png rename to docs/howto-guides/assets/js-tutorial-console-log-success.png diff --git a/docs/designers-developers/assets/js-tutorial-error-blocks-undefined.png b/docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-error-blocks-undefined.png rename to docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png b/docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/designers-developers/assets/plugin-more-menu-item.png b/docs/howto-guides/assets/plugin-more-menu-item.png similarity index 100% rename from docs/designers-developers/assets/plugin-more-menu-item.png rename to docs/howto-guides/assets/plugin-more-menu-item.png diff --git a/docs/designers-developers/assets/plugin-post-publish-panel.png b/docs/howto-guides/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/designers-developers/assets/plugin-post-publish-panel.png rename to docs/howto-guides/assets/plugin-post-publish-panel.png diff --git a/docs/designers-developers/assets/plugin-post-status-info-location.png b/docs/howto-guides/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/designers-developers/assets/plugin-post-status-info-location.png rename to docs/howto-guides/assets/plugin-post-status-info-location.png diff --git a/docs/designers-developers/assets/plugin-pre-publish-panel.png b/docs/howto-guides/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/designers-developers/assets/plugin-pre-publish-panel.png rename to docs/howto-guides/assets/plugin-pre-publish-panel.png diff --git a/docs/designers-developers/assets/plugin-sidebar-closed-state.png b/docs/howto-guides/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-closed-state.png rename to docs/howto-guides/assets/plugin-sidebar-closed-state.png diff --git a/docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif b/docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif rename to docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/designers-developers/assets/plugin-sidebar-open-state.png b/docs/howto-guides/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-open-state.png rename to docs/howto-guides/assets/plugin-sidebar-open-state.png diff --git a/docs/designers-developers/assets/sidebar-style-and-controls.png b/docs/howto-guides/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/designers-developers/assets/sidebar-style-and-controls.png rename to docs/howto-guides/assets/sidebar-style-and-controls.png diff --git a/docs/designers-developers/assets/sidebar-up-and-running.png b/docs/howto-guides/assets/sidebar-up-and-running.png similarity index 100% rename from docs/designers-developers/assets/sidebar-up-and-running.png rename to docs/howto-guides/assets/sidebar-up-and-running.png diff --git a/docs/designers-developers/assets/toolbar-text.png b/docs/howto-guides/assets/toolbar-text.png similarity index 100% rename from docs/designers-developers/assets/toolbar-text.png rename to docs/howto-guides/assets/toolbar-text.png diff --git a/docs/designers-developers/assets/toolbar-with-custom-button.png b/docs/howto-guides/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/designers-developers/assets/toolbar-with-custom-button.png rename to docs/howto-guides/assets/toolbar-with-custom-button.png diff --git a/docs/appendix/backward-compatibility/README.md b/docs/howto-guides/backward-compatibility/README.md similarity index 100% rename from docs/appendix/backward-compatibility/README.md rename to docs/howto-guides/backward-compatibility/README.md diff --git a/docs/appendix/backward-compatibility/deprecations.md b/docs/howto-guides/backward-compatibility/deprecations.md similarity index 100% rename from docs/appendix/backward-compatibility/deprecations.md rename to docs/howto-guides/backward-compatibility/deprecations.md diff --git a/docs/appendix/backward-compatibility/meta-box.md b/docs/howto-guides/backward-compatibility/meta-box.md similarity index 100% rename from docs/appendix/backward-compatibility/meta-box.md rename to docs/howto-guides/backward-compatibility/meta-box.md diff --git a/docs/designers-developers/developers/tutorials/block-based-themes/README.md b/docs/howto-guides/block-based-themes/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-based-themes/README.md rename to docs/howto-guides/block-based-themes/README.md diff --git a/docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md b/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md rename to docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/readme.md b/docs/howto-guides/block-tutorial/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/readme.md rename to docs/howto-guides/block-tutorial/README.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md b/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md rename to docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md rename to docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md rename to docs/howto-guides/block-tutorial/creating-dynamic-blocks.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md rename to docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md rename to docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md b/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md rename to docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md rename to docs/howto-guides/block-tutorial/writing-your-first-block-type.md diff --git a/docs/designers-developers/designers/README.md b/docs/howto-guides/designers/README.md similarity index 100% rename from docs/designers-developers/designers/README.md rename to docs/howto-guides/designers/README.md diff --git a/docs/designers-developers/designers/animation.md b/docs/howto-guides/designers/animation.md similarity index 100% rename from docs/designers-developers/designers/animation.md rename to docs/howto-guides/designers/animation.md diff --git a/docs/designers-developers/designers/assets/advanced-settings-do.png b/docs/howto-guides/designers/assets/advanced-settings-do.png similarity index 100% rename from docs/designers-developers/designers/assets/advanced-settings-do.png rename to docs/howto-guides/designers/assets/advanced-settings-do.png diff --git a/docs/designers-developers/designers/assets/block-controls-do.png b/docs/howto-guides/designers/assets/block-controls-do.png similarity index 100% rename from docs/designers-developers/designers/assets/block-controls-do.png rename to docs/howto-guides/designers/assets/block-controls-do.png diff --git a/docs/designers-developers/designers/assets/block-controls-dont.png b/docs/howto-guides/designers/assets/block-controls-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/block-controls-dont.png rename to docs/howto-guides/designers/assets/block-controls-dont.png diff --git a/docs/designers-developers/designers/assets/block-descriptions-do.png b/docs/howto-guides/designers/assets/block-descriptions-do.png similarity index 100% rename from docs/designers-developers/designers/assets/block-descriptions-do.png rename to docs/howto-guides/designers/assets/block-descriptions-do.png diff --git a/docs/designers-developers/designers/assets/block-descriptions-dont.png b/docs/howto-guides/designers/assets/block-descriptions-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/block-descriptions-dont.png rename to docs/howto-guides/designers/assets/block-descriptions-dont.png diff --git a/docs/designers-developers/designers/assets/blocks-do.png b/docs/howto-guides/designers/assets/blocks-do.png similarity index 100% rename from docs/designers-developers/designers/assets/blocks-do.png rename to docs/howto-guides/designers/assets/blocks-do.png diff --git a/docs/designers-developers/designers/assets/blocks-dont.png b/docs/howto-guides/designers/assets/blocks-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/blocks-dont.png rename to docs/howto-guides/designers/assets/blocks-dont.png diff --git a/docs/designers-developers/designers/assets/placeholder-do.png b/docs/howto-guides/designers/assets/placeholder-do.png similarity index 100% rename from docs/designers-developers/designers/assets/placeholder-do.png rename to docs/howto-guides/designers/assets/placeholder-do.png diff --git a/docs/designers-developers/designers/assets/placeholder-dont.png b/docs/howto-guides/designers/assets/placeholder-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/placeholder-dont.png rename to docs/howto-guides/designers/assets/placeholder-dont.png diff --git a/docs/designers-developers/designers/block-design.md b/docs/howto-guides/designers/block-design.md similarity index 100% rename from docs/designers-developers/designers/block-design.md rename to docs/howto-guides/designers/block-design.md diff --git a/docs/designers-developers/designers/design-resources.md b/docs/howto-guides/designers/design-resources.md similarity index 100% rename from docs/designers-developers/designers/design-resources.md rename to docs/howto-guides/designers/design-resources.md diff --git a/docs/designers-developers/designers/user-interface.md b/docs/howto-guides/designers/user-interface.md similarity index 100% rename from docs/designers-developers/designers/user-interface.md rename to docs/howto-guides/designers/user-interface.md diff --git a/docs/designers-developers/developers/feature-flags.md b/docs/howto-guides/feature-flags.md similarity index 100% rename from docs/designers-developers/developers/feature-flags.md rename to docs/howto-guides/feature-flags.md diff --git a/docs/designers-developers/developers/tutorials/format-api/1-register-format.md b/docs/howto-guides/format-api/1-register-format.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/1-register-format.md rename to docs/howto-guides/format-api/1-register-format.md diff --git a/docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md b/docs/howto-guides/format-api/2-toolbar-button.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md rename to docs/howto-guides/format-api/2-toolbar-button.md diff --git a/docs/designers-developers/developers/tutorials/format-api/3-apply-format.md b/docs/howto-guides/format-api/3-apply-format.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/3-apply-format.md rename to docs/howto-guides/format-api/3-apply-format.md diff --git a/docs/designers-developers/developers/tutorials/format-api/README.md b/docs/howto-guides/format-api/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/README.md rename to docs/howto-guides/format-api/README.md diff --git a/docs/designers-developers/developers/internationalization.md b/docs/howto-guides/internationalization.md similarity index 100% rename from docs/designers-developers/developers/internationalization.md rename to docs/howto-guides/internationalization.md diff --git a/docs/designers-developers/developers/tutorials/javascript/readme.md b/docs/howto-guides/javascript/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/readme.md rename to docs/howto-guides/javascript/README.md diff --git a/docs/designers-developers/developers/tutorials/javascript/esnext-js.md b/docs/howto-guides/javascript/esnext-js.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/esnext-js.md rename to docs/howto-guides/javascript/esnext-js.md diff --git a/docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md b/docs/howto-guides/javascript/extending-the-block-editor.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md rename to docs/howto-guides/javascript/extending-the-block-editor.md diff --git a/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/js-build-setup.md rename to docs/howto-guides/javascript/js-build-setup.md diff --git a/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md b/docs/howto-guides/javascript/loading-javascript.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/loading-javascript.md rename to docs/howto-guides/javascript/loading-javascript.md diff --git a/docs/designers-developers/developers/tutorials/javascript/plugins-background.md b/docs/howto-guides/javascript/plugins-background.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/plugins-background.md rename to docs/howto-guides/javascript/plugins-background.md diff --git a/docs/designers-developers/developers/tutorials/javascript/scope-your-code.md b/docs/howto-guides/javascript/scope-your-code.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/scope-your-code.md rename to docs/howto-guides/javascript/scope-your-code.md diff --git a/docs/designers-developers/developers/tutorials/javascript/troubleshooting.md b/docs/howto-guides/javascript/troubleshooting.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/troubleshooting.md rename to docs/howto-guides/javascript/troubleshooting.md diff --git a/docs/designers-developers/developers/tutorials/javascript/versions-and-building.md b/docs/howto-guides/javascript/versions-and-building.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/versions-and-building.md rename to docs/howto-guides/javascript/versions-and-building.md diff --git a/docs/designers-developers/developers/tutorials/metabox/readme.md b/docs/howto-guides/metabox/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/readme.md rename to docs/howto-guides/metabox/README.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md b/docs/howto-guides/metabox/meta-block-1-intro.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md rename to docs/howto-guides/metabox/meta-block-1-intro.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md b/docs/howto-guides/metabox/meta-block-2-register-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md rename to docs/howto-guides/metabox/meta-block-2-register-meta.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md b/docs/howto-guides/metabox/meta-block-3-add.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md rename to docs/howto-guides/metabox/meta-block-3-add.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md b/docs/howto-guides/metabox/meta-block-4-use-data.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md rename to docs/howto-guides/metabox/meta-block-4-use-data.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md b/docs/howto-guides/metabox/meta-block-5-finishing.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md rename to docs/howto-guides/metabox/meta-block-5-finishing.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block.png b/docs/howto-guides/metabox/meta-block.png similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block.png rename to docs/howto-guides/metabox/meta-block.png diff --git a/docs/designers-developers/developers/tutorials/notices/README.md b/docs/howto-guides/notices/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/README.md rename to docs/howto-guides/notices/README.md diff --git a/docs/designers-developers/developers/tutorials/notices/block-editor-notice.png b/docs/howto-guides/notices/block-editor-notice.png similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/block-editor-notice.png rename to docs/howto-guides/notices/block-editor-notice.png diff --git a/docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png b/docs/howto-guides/notices/classic-editor-notice.png similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png rename to docs/howto-guides/notices/classic-editor-notice.png diff --git a/docs/designers-developers/developers/platform/README.md b/docs/howto-guides/platform/README.md similarity index 100% rename from docs/designers-developers/developers/platform/README.md rename to docs/howto-guides/platform/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/README.md b/docs/howto-guides/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/README.md rename to docs/howto-guides/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md b/docs/howto-guides/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/tutorial.md rename to docs/howto-guides/platform/custom-block-editor/tutorial.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md diff --git a/docs/designers-developers/developers/themes/README.md b/docs/howto-guides/themes/README.md similarity index 100% rename from docs/designers-developers/developers/themes/README.md rename to docs/howto-guides/themes/README.md diff --git a/docs/designers-developers/developers/themes/block-based-themes.md b/docs/howto-guides/themes/block-based-themes.md similarity index 100% rename from docs/designers-developers/developers/themes/block-based-themes.md rename to docs/howto-guides/themes/block-based-themes.md diff --git a/docs/designers-developers/developers/themes/theme-json.md b/docs/howto-guides/themes/theme-json.md similarity index 100% rename from docs/designers-developers/developers/themes/theme-json.md rename to docs/howto-guides/themes/theme-json.md diff --git a/docs/designers-developers/developers/themes/theme-support.md b/docs/howto-guides/themes/theme-support.md similarity index 100% rename from docs/designers-developers/developers/themes/theme-support.md rename to docs/howto-guides/themes/theme-support.md diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/block-api/README.md b/docs/reference-guides/block-api/README.md similarity index 100% rename from docs/designers-developers/developers/block-api/README.md rename to docs/reference-guides/block-api/README.md diff --git a/docs/designers-developers/developers/block-api/block-annotations.md b/docs/reference-guides/block-api/block-annotations.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-annotations.md rename to docs/reference-guides/block-api/block-annotations.md diff --git a/docs/designers-developers/developers/block-api/block-attributes.md b/docs/reference-guides/block-api/block-attributes.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-attributes.md rename to docs/reference-guides/block-api/block-attributes.md diff --git a/docs/designers-developers/developers/block-api/block-context.md b/docs/reference-guides/block-api/block-context.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-context.md rename to docs/reference-guides/block-api/block-context.md diff --git a/docs/designers-developers/developers/block-api/block-deprecation.md b/docs/reference-guides/block-api/block-deprecation.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-deprecation.md rename to docs/reference-guides/block-api/block-deprecation.md diff --git a/docs/designers-developers/developers/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-edit-save.md rename to docs/reference-guides/block-api/block-edit-save.md diff --git a/docs/designers-developers/developers/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-metadata.md rename to docs/reference-guides/block-api/block-metadata.md diff --git a/docs/designers-developers/developers/block-api/block-patterns.md b/docs/reference-guides/block-api/block-patterns.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-patterns.md rename to docs/reference-guides/block-api/block-patterns.md diff --git a/docs/designers-developers/developers/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-registration.md rename to docs/reference-guides/block-api/block-registration.md diff --git a/docs/designers-developers/developers/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-supports.md rename to docs/reference-guides/block-api/block-supports.md diff --git a/docs/designers-developers/developers/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-templates.md rename to docs/reference-guides/block-api/block-templates.md diff --git a/docs/designers-developers/developers/block-api/block-transforms.md b/docs/reference-guides/block-api/block-transforms.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-transforms.md rename to docs/reference-guides/block-api/block-transforms.md diff --git a/docs/designers-developers/developers/block-api/versions.md b/docs/reference-guides/block-api/versions.md similarity index 100% rename from docs/designers-developers/developers/block-api/versions.md rename to docs/reference-guides/block-api/versions.md diff --git a/docs/appendix/data/README.md b/docs/reference-guides/data/README.md similarity index 100% rename from docs/appendix/data/README.md rename to docs/reference-guides/data/README.md diff --git a/docs/appendix/data/data-core-annotations.md b/docs/reference-guides/data/data-core-annotations.md similarity index 100% rename from docs/appendix/data/data-core-annotations.md rename to docs/reference-guides/data/data-core-annotations.md diff --git a/docs/appendix/data/data-core-block-editor.md b/docs/reference-guides/data/data-core-block-editor.md similarity index 100% rename from docs/appendix/data/data-core-block-editor.md rename to docs/reference-guides/data/data-core-block-editor.md diff --git a/docs/appendix/data/data-core-blocks.md b/docs/reference-guides/data/data-core-blocks.md similarity index 100% rename from docs/appendix/data/data-core-blocks.md rename to docs/reference-guides/data/data-core-blocks.md diff --git a/docs/appendix/data/data-core-edit-post.md b/docs/reference-guides/data/data-core-edit-post.md similarity index 100% rename from docs/appendix/data/data-core-edit-post.md rename to docs/reference-guides/data/data-core-edit-post.md diff --git a/docs/appendix/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md similarity index 100% rename from docs/appendix/data/data-core-editor.md rename to docs/reference-guides/data/data-core-editor.md diff --git a/docs/appendix/data/data-core-keyboard-shortcuts.md b/docs/reference-guides/data/data-core-keyboard-shortcuts.md similarity index 100% rename from docs/appendix/data/data-core-keyboard-shortcuts.md rename to docs/reference-guides/data/data-core-keyboard-shortcuts.md diff --git a/docs/appendix/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md similarity index 100% rename from docs/appendix/data/data-core-notices.md rename to docs/reference-guides/data/data-core-notices.md diff --git a/docs/appendix/data/data-core-nux.md b/docs/reference-guides/data/data-core-nux.md similarity index 100% rename from docs/appendix/data/data-core-nux.md rename to docs/reference-guides/data/data-core-nux.md diff --git a/docs/appendix/data/data-core-viewport.md b/docs/reference-guides/data/data-core-viewport.md similarity index 100% rename from docs/appendix/data/data-core-viewport.md rename to docs/reference-guides/data/data-core-viewport.md diff --git a/docs/appendix/data/data-core.md b/docs/reference-guides/data/data-core.md similarity index 100% rename from docs/appendix/data/data-core.md rename to docs/reference-guides/data/data-core.md diff --git a/docs/designers-developers/developers/filters/README.md b/docs/reference-guides/filters/README.md similarity index 100% rename from docs/designers-developers/developers/filters/README.md rename to docs/reference-guides/filters/README.md diff --git a/docs/designers-developers/developers/filters/autocomplete-filters.md b/docs/reference-guides/filters/autocomplete-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/autocomplete-filters.md rename to docs/reference-guides/filters/autocomplete-filters.md diff --git a/docs/designers-developers/developers/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/block-filters.md rename to docs/reference-guides/filters/block-filters.md diff --git a/docs/designers-developers/developers/filters/editor-filters.md b/docs/reference-guides/filters/editor-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/editor-filters.md rename to docs/reference-guides/filters/editor-filters.md diff --git a/docs/designers-developers/developers/filters/i18n-filters.md b/docs/reference-guides/filters/i18n-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/i18n-filters.md rename to docs/reference-guides/filters/i18n-filters.md diff --git a/docs/designers-developers/developers/filters/parser-filters.md b/docs/reference-guides/filters/parser-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/parser-filters.md rename to docs/reference-guides/filters/parser-filters.md diff --git a/docs/appendix/packages.md b/docs/reference-guides/packages.md similarity index 100% rename from docs/appendix/packages.md rename to docs/reference-guides/packages.md diff --git a/docs/designers-developers/developers/richtext.md b/docs/reference-guides/richtext.md similarity index 100% rename from docs/designers-developers/developers/richtext.md rename to docs/reference-guides/richtext.md diff --git a/docs/designers-developers/developers/slotfills/README.md b/docs/reference-guides/slotfills/README.md similarity index 100% rename from docs/designers-developers/developers/slotfills/README.md rename to docs/reference-guides/slotfills/README.md diff --git a/docs/designers-developers/developers/slotfills/main-dashboard-button.md b/docs/reference-guides/slotfills/main-dashboard-button.md similarity index 100% rename from docs/designers-developers/developers/slotfills/main-dashboard-button.md rename to docs/reference-guides/slotfills/main-dashboard-button.md diff --git a/docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md rename to docs/reference-guides/slotfills/plugin-block-settings-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/reference-guides/slotfills/plugin-document-setting-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md rename to docs/reference-guides/slotfills/plugin-document-setting-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-more-menu-item.md b/docs/reference-guides/slotfills/plugin-more-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-more-menu-item.md rename to docs/reference-guides/slotfills/plugin-more-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md b/docs/reference-guides/slotfills/plugin-post-publish-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md rename to docs/reference-guides/slotfills/plugin-post-publish-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-post-status-info.md b/docs/reference-guides/slotfills/plugin-post-status-info.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-post-status-info.md rename to docs/reference-guides/slotfills/plugin-post-status-info.md diff --git a/docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md rename to docs/reference-guides/slotfills/plugin-pre-publish-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md rename to docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-sidebar.md rename to docs/reference-guides/slotfills/plugin-sidebar.md From 809031c1557bb99f0cf18bcbc331ae5ca5a8fc56 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 16:02:07 +0100 Subject: [PATCH 13/68] Update links in the documentation after changing the folder structure --- docs/contributors/code/getting-started.md | 6 ++--- docs/contributors/design/reference.md | 6 ++--- docs/contributors/documentation/document.md | 4 +-- .../full-site-editing-templates.md | 2 +- docs/getting-started/README.md | 16 ++++++------ .../getting-started/architecture/data-flow.md | 2 +- .../architecture/key-concepts.md | 12 ++++----- .../architecture/modularity.md | 2 +- docs/getting-started/faq.md | 6 ++--- docs/getting-started/tutorials/README.md | 18 ++++++------- .../tutorials/create-block/README.md | 16 ++++++------ .../tutorials/create-block/attributes.md | 6 ++--- .../create-block/author-experience.md | 2 +- .../tutorials/create-block/block-anatomy.md | 8 +++--- .../tutorials/create-block/block-code.md | 2 +- .../tutorials/create-block/finishing.md | 8 +++--- .../submitting-to-block-directory.md | 8 +++--- .../tutorials/create-block/wp-plugin.md | 8 +++--- .../tutorials/devenv/README.md | 2 +- docs/howto-guides/README.md | 18 ++++++------- .../backward-compatibility/README.md | 2 +- .../backward-compatibility/deprecations.md | 8 +++--- .../backward-compatibility/meta-box.md | 2 +- .../howto-guides/block-based-themes/README.md | 14 +++++----- docs/howto-guides/block-tutorial/README.md | 2 +- .../block-tutorial/creating-dynamic-blocks.md | 6 ++--- .../generate-blocks-with-wp-cli.md | 2 +- ...roducing-attributes-and-editable-fields.md | 4 +-- .../writing-your-first-block-type.md | 4 +-- docs/howto-guides/designers/block-design.md | 4 +-- .../howto-guides/format-api/3-apply-format.md | 2 +- docs/howto-guides/format-api/README.md | 8 +++--- docs/howto-guides/internationalization.md | 2 +- docs/howto-guides/javascript/README.md | 16 ++++++------ .../javascript/extending-the-block-editor.md | 4 +-- .../howto-guides/javascript/js-build-setup.md | 6 ++--- .../javascript/troubleshooting.md | 4 +-- .../javascript/versions-and-building.md | 4 +-- docs/howto-guides/metabox/README.md | 6 ++--- .../metabox/meta-block-1-intro.md | 10 +++---- docs/howto-guides/metabox/meta-block-3-add.md | 4 +-- .../metabox/meta-block-5-finishing.md | 2 +- docs/howto-guides/notices/README.md | 4 +-- docs/howto-guides/platform/README.md | 2 +- .../platform/custom-block-editor/README.md | 4 +-- .../sidebar-tutorial/plugin-sidebar-0.md | 14 +++++----- .../plugin-sidebar-1-up-and-running.md | 2 +- .../plugin-sidebar-3-register-meta.md | 2 +- .../plugin-sidebar-4-initialize-input.md | 2 +- .../howto-guides/themes/block-based-themes.md | 4 +-- docs/howto-guides/themes/theme-support.md | 2 +- docs/reference-guides/block-api/README.md | 24 ++++++++--------- .../block-api/block-attributes.md | 2 +- .../block-api/block-deprecation.md | 6 ++--- .../block-api/block-edit-save.md | 14 +++++----- .../block-api/block-metadata.md | 26 +++++++++---------- .../block-api/block-registration.md | 10 +++---- .../block-api/block-supports.md | 6 ++--- .../block-api/block-templates.md | 2 +- docs/reference-guides/data/README.md | 18 ++++++------- .../reference-guides/filters/block-filters.md | 4 +-- docs/reference-guides/slotfills/README.md | 18 ++++++------- 62 files changed, 217 insertions(+), 217 deletions(-) diff --git a/docs/contributors/code/getting-started.md b/docs/contributors/code/getting-started.md index 7fe2d71e2e5cb..aa99fbf13b5b1 100644 --- a/docs/contributors/code/getting-started.md +++ b/docs/contributors/code/getting-started.md @@ -1,12 +1,12 @@ # Getting Started -The following guide is for setting up your local environment to contribute to the Gutenberg project. There is significant overlap between an environment to contribute and an environment used to extend the WordPress block editor. You can review the [Development Environment tutorial](/docs/designers-developers/developers/tutorials/devenv/readme.md) for additional setup information. +The following guide is for setting up your local environment to contribute to the Gutenberg project. There is significant overlap between an environment to contribute and an environment used to extend the WordPress block editor. You can review the [Development Environment tutorial](/docs/getting-started/tutorials/devenv/readme.md) for additional setup information. ## Development Tools (Node) Gutenberg is a JavaScript project and requires [Node.js](https://nodejs.org/). The project is built using the latest active LTS release of node, and the latest version of NPM. See the [LTS release schedule](https://github.com/nodejs/Release#release-schedule) for details. -We recommend using the [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) since it is the easiest way to install and manage node for macOS, Linux, and Windows 10 using WSL2. See [our Development Tools guide](/docs/designers-developers/developers/tutorials/devenv/readme.md#development-tools) or the Nodejs site for additional installation instructions. +We recommend using the [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) since it is the easiest way to install and manage node for macOS, Linux, and Windows 10 using WSL2. See [our Development Tools guide](/docs/getting-started/tutorials/devenv/readme.md#development-tools) or the Nodejs site for additional installation instructions. After installing Node, you can build Gutenberg by running the following from within the cloned repository: @@ -34,7 +34,7 @@ The [wp-env package](/packages/env/README.md) was developed with the Gutenberg p By default, `wp-env` can run in a plugin directory to create and run a WordPress environment, mounting and activating the plugin automatically. You can also configure `wp-env` to use existing installs, multiple plugins, or themes. See the [wp-env package](/packages/env/README.md#wp-envjson) for complete documentation. -If you don't already have it, you'll need to install Docker and Docker Compose in order to use `wp-env`. See the [Development Environment tutorial for additional details](/docs/designers-developers/developers/tutorials/devenv/readme.md). +If you don't already have it, you'll need to install Docker and Docker Compose in order to use `wp-env`. See the [Development Environment tutorial for additional details](/docs/getting-started/tutorials/devenv/readme.md). Once Docker is installed and running: To install WordPress, run the following from within the cloned gutenberg directory: diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 5bdda020f1979..9a4e6944aef83 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -1,9 +1,9 @@ # Reference -- [Glossary](/docs/designers-developers/glossary.md) +- [Glossary](/docs/getting-started/glossary.md) - [Coding Guidelines](/docs/contributors/coding-guidelines.md) - [Testing Overview](/docs/contributors/testing-overview.md) -- [Frequently Asked Questions](/docs/designers-developers/faq.md) +- [Frequently Asked Questions](/docs/getting-started/faq.md) ## Logo @@ -15,4 +15,4 @@ Released under GPL license, made by [Cristel Rossignol](https://twitter.com/cris ## Mockups -Mockup Sketch files are available in [the Design section](/docs/designers-developers/designers/design-resources.md). +Mockup Sketch files are available in [the Design section](/docs/howto-guides/designers/design-resources.md). diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index a88612abeee3b..a9d85c6679daa 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -39,7 +39,7 @@ To update an existing page: ### Create a New Document -To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md): +To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/howto-guides/javascript/js-build-setup.md): 1. Create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/HEAD/docs) folder, use lower-case, no spaces, if needed a dash separator, and .md extension. 2. Add content, all documents require one and only H1 tag, using markdown notation. @@ -73,7 +73,7 @@ An example, the link to this page is: `/docs/contributors/document.md` The code example in markdown should be wrapped in three tick marks \`\`\` and should additionally include a language specifier. See this [GitHub documentation around fenced code blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). -A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). Here is an example `codetabs` section: diff --git a/docs/explanations/full-site-editing-templates.md b/docs/explanations/full-site-editing-templates.md index 293b7f1f7bd30..4717eee4ecbe2 100644 --- a/docs/explanations/full-site-editing-templates.md +++ b/docs/explanations/full-site-editing-templates.md @@ -2,7 +2,7 @@ > This is the documentation for the current implementation of the block-based templates and template parts themes. This is part of the Full Site Editing project. These features are still experimental in the plugin. “Experimental” means this is just an early implementation that is subject to potential drastic and breaking changes in iterations based on feedback from users, contributors, and theme authors. -This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/designers-developers/developers/themes/block-based-themes.md). +This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/howto-guides/themes/block-based-themes.md). ## Storage diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index df67956d3e4f3..2d56c6e272d47 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -22,19 +22,19 @@ The Editor offers rich new value to users with visual, drag-and-drop creation to ### Create a Block Tutorial -[Learn how to create your first block](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. +[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. ### Develop for the block editor -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/designers-developers/developers/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/howto-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - [Gutenberg Architecture](/docs/architecture/readme.md) -- [Block Style Variations](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) -- [Creating Block Patterns](/docs/designers-developers/developers/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/designers-developers/developers/themes/readme.md) -- [Block API Reference](/docs/designers-developers/developers/block-api/readme.md) -- [Block Editor Accessibility](/docs/designers-developers/developers/accessibility.md) -- [Internationalization](/docs/designers-developers/developers/internationalization.md) +- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) +- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Theming for the Block Editor](/docs/howto-guides/themes/readme.md) +- [Block API Reference](/docs/reference-guides/block-api/readme.md) +- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) +- [Internationalization](/docs/howto-guides/internationalization.md) ### Contribute to the block editor diff --git a/docs/getting-started/architecture/data-flow.md b/docs/getting-started/architecture/data-flow.md index 3fefec3aae7e7..07957382ec1bf 100644 --- a/docs/getting-started/architecture/data-flow.md +++ b/docs/getting-started/architecture/data-flow.md @@ -104,7 +104,7 @@ After running this through the parser, we're left with a simple object we can ma This has dramatic implications for how simple and performant we can make our parser. These explicit boundaries also protect damage in a single block from bleeding into other blocks or tarnishing the entire document. It also allows the system to identify unrecognized blocks before rendering them. -_N.B.:_ The defining aspects of blocks are their semantics and the isolation mechanism they provide: in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](/docs/designers-developers/developers/block-api/block-attributes.md) for details. +_N.B.:_ The defining aspects of blocks are their semantics and the isolation mechanism they provide: in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](/docs/reference-guides/block-api/block-attributes.md) for details. ### The Anatomy of a Serialized Block diff --git a/docs/getting-started/architecture/key-concepts.md b/docs/getting-started/architecture/key-concepts.md index 553a00923d267..3ec6487b63794 100644 --- a/docs/getting-started/architecture/key-concepts.md +++ b/docs/getting-started/architecture/key-concepts.md @@ -32,12 +32,12 @@ Blocks have the ability to be transformed into other block types. This allows ba ### Variations -Given a block type, a block variation is a predefined set of its initial attributes. This API allows creating a single block from which multiple configurations are possible. Variations provide different possible interfaces, including showing up as entirely new blocks in the library, or as presets when inserting a new block. Read [the API documentation](/docs/designers-developers/developers/block-api/block-registration.md#variations-optional) for more details. +Given a block type, a block variation is a predefined set of its initial attributes. This API allows creating a single block from which multiple configurations are possible. Variations provide different possible interfaces, including showing up as entirely new blocks in the library, or as presets when inserting a new block. Read [the API documentation](/docs/reference-guides/block-api/block-registration.md#variations-optional) for more details. **More on Blocks** -- **[Block API](/docs/designers-developers/developers/block-api/README.md)** -- **[Tutorial: Building A Custom Block](/docs/designers-developers/developers/tutorials/create-block/readme.md)** +- **[Block API](/docs/reference-guides/block-api/README.md)** +- **[Tutorial: Building A Custom Block](/docs/getting-started/tutorials/create-block/readme.md)** ## Reusable Blocks @@ -49,14 +49,14 @@ In technical details, reusable blocks are stored as a hidden post type (`wp_bloc ## Patterns -A [block pattern](/docs/designers-developers/developers/block-api/block-patterns.md) is a group of blocks that have been combined together creating a design pattern. These design patterns provide a starting point for building more advanced pages and layouts quickly. A block pattern can be as small as a single block or as large as a full page of content. Unlike reusable blocks, once a pattern is inserted it doesn't remain in sync with the original content as the blocks contained are meant to be edited and customized by the user. Underneath the surface, patterns are just regular blocks composed together. Themes can register patterns to offer users quick starting points with a design language familiar to that theme's aesthetics. +A [block pattern](/docs/reference-guides/block-api/block-patterns.md) is a group of blocks that have been combined together creating a design pattern. These design patterns provide a starting point for building more advanced pages and layouts quickly. A block pattern can be as small as a single block or as large as a full page of content. Unlike reusable blocks, once a pattern is inserted it doesn't remain in sync with the original content as the blocks contained are meant to be edited and customized by the user. Underneath the surface, patterns are just regular blocks composed together. Themes can register patterns to offer users quick starting points with a design language familiar to that theme's aesthetics. ## Templates (in progress) -While the post editor concentrates on the content of a post, the [template](/docs/designers-developers/developers/block-api/block-templates.md) editor allows declaring and editing an entire site using blocks, from header to footer. To support these efforts there's a collection of blocks that interact with different parts of a site (like the site title, description, logo, navigation, etc) as well as semantic areas like header, sidebar, and footer. Templates are broken down between templates (that describe a full page) and template parts (that describe reusable areas within a template). These templates and template parts can be composed together and registered by a theme. They are also entirely editable by users using the block editor. Customized templates are saved in a `wp_template` post type. Block templates include both static pages and dynamic ones, like archives, singular, home, 404, etc. +While the post editor concentrates on the content of a post, the [template](/docs/reference-guides/block-api/block-templates.md) editor allows declaring and editing an entire site using blocks, from header to footer. To support these efforts there's a collection of blocks that interact with different parts of a site (like the site title, description, logo, navigation, etc) as well as semantic areas like header, sidebar, and footer. Templates are broken down between templates (that describe a full page) and template parts (that describe reusable areas within a template). These templates and template parts can be composed together and registered by a theme. They are also entirely editable by users using the block editor. Customized templates are saved in a `wp_template` post type. Block templates include both static pages and dynamic ones, like archives, singular, home, 404, etc. Note: custom post types can also be initialized with a starting `post_content` template that should not be confused with the theme template system described above. ## Global Styles (in progress) -Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/designers-developers/developers/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. +Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/howto-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. diff --git a/docs/getting-started/architecture/modularity.md b/docs/getting-started/architecture/modularity.md index 7f73a12ebadd6..6163d8f922a54 100644 --- a/docs/getting-started/architecture/modularity.md +++ b/docs/getting-started/architecture/modularity.md @@ -100,4 +100,4 @@ Structured this way, these packages can be used in a variety of combinations out ## Going further - - [Package Reference](/docs/designers-developers/developers/packages.md) + - [Package Reference](/docs/reference-guides/packages.md) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 779871544e9b2..cf0c5d2ce9aea 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -326,7 +326,7 @@ This is currently a work in progress and we recommend reviewing the [block based No, block variations are different versions of a single base block, sharing a similar functionality, but with slight differences in their implementation, or settings (attributes, InnerBlocks,etc). Block variations are transparent for users, and once there is a registered block variation, it will appear as a new block. For example, the `embed` block registers different block variations to embed content from specific providers. -Meanwhile, [block styles](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) allow you to provide alternative styles to existing blocks, and they work by adding a className to the block’s wrapper. Once a block has registered block styles, a block style selector will appear in its sidebar so that users can choose among the different registered styles. +Meanwhile, [block styles](/docs/reference-guides/filters/block-filters.md#block-style-variations) allow you to provide alternative styles to existing blocks, and they work by adding a className to the block’s wrapper. Once a block has registered block styles, a block style selector will appear in its sidebar so that users can choose among the different registered styles. ## How do editor styles work? @@ -339,7 +339,7 @@ function gutenbergtheme_editor_styles() { add_action( 'enqueue_block_editor_assets', 'gutenbergtheme_editor_styles' ); ``` -*See:* [Editor Styles](/docs/designers-developers/developers/themes/theme-support.md#editor-styles) +*See:* [Editor Styles](/docs/howto-guides/themes/theme-support.md#editor-styles) ## Should I be concerned that Gutenberg will make my plugin obsolete? @@ -390,7 +390,7 @@ Our approach—as outlined in [the technical overview introduction](https://make This also [gives us the flexibility](https://github.com/WordPress/gutenberg/issues/1516) to store those blocks that are inherently separate from the content stream (reusable pieces like widgets or small post type elements) elsewhere, and just keep token references for their placement. -We suggest you look at the [Gutenberg key concepts](/docs/designers-developers/key-concepts.md) to learn more about how this aspect of the project works. +We suggest you look at the [Gutenberg key concepts](/docs/getting-started/architecture/key-concepts.md) to learn more about how this aspect of the project works. ## How can I parse the post content back out into blocks in PHP or JS? In JS: diff --git a/docs/getting-started/tutorials/README.md b/docs/getting-started/tutorials/README.md index 17c428bbb508b..b122cadc61a2b 100644 --- a/docs/getting-started/tutorials/README.md +++ b/docs/getting-started/tutorials/README.md @@ -1,19 +1,19 @@ # Tutorials -- First things first, see [setting up your development environment](/docs/designers-developers/developers/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. +- First things first, see [setting up your development environment](/docs/getting-started/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. -- See the [Getting Started with JavaScript Tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) to learn about how to use JavaScript within WordPress. +- See the [Getting Started with JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. -- Beginners: The [Create a Block Tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. +- Beginners: The [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. -- Intermediate: The [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. +- Intermediate: The [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. -- See the [Meta Boxes Tutorial](/docs/designers-developers/developers/tutorials/metabox/readme.md) for new ways of extending the editor storing and using post meta data. +- See the [Meta Boxes Tutorial](/docs/howto-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. -- Check out the [Notices Tutorial](/docs/designers-developers/developers/tutorials/notices/README.md) to learn how to display informational UI at the top of the editor. +- Check out the [Notices Tutorial](/docs/howto-guides/notices/README.md) to learn how to display informational UI at the top of the editor. -- The [Sidebar Tutorial](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. +- The [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. -- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/designers-developers/developers/tutorials/format-api/). +- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/howto-guides/format-api/). -- Build your own [custom block editor instance](/docs/designers-developers/developers/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. +- Build your own [custom block editor instance](/docs/reference-guides/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. diff --git a/docs/getting-started/tutorials/create-block/README.md b/docs/getting-started/tutorials/create-block/README.md index 50b385928a467..653f14fca869f 100644 --- a/docs/getting-started/tutorials/create-block/README.md +++ b/docs/getting-started/tutorials/create-block/README.md @@ -6,7 +6,7 @@ The tutorial includes setting up your development environment, tools, and gettin ## Prerequisites -The first thing you need is a development environment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md). +The first thing you need is a development environment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/getting-started/tutorials/devenv/readme.md). ## Quick Start @@ -28,10 +28,10 @@ After activated, go to the block editor and use the inserter to search and add y The create a block tutorials breaks down to the following sections. -1. [WordPress Plugin](/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md) -2. [Anatomy of a Gutenberg Block ](/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md) -3. [Block Attributes](/docs/designers-developers/developers/tutorials/create-block/attributes.md) -4. [Code Implementation](/docs/designers-developers/developers/tutorials/create-block/block-code.md) -5. [Authoring Experience](/docs/designers-developers/developers/tutorials/create-block/author-experience.md) -6. [Finishing Touches](/docs/designers-developers/developers/tutorials/create-block/finishing.md) -7. [Share your Block with the World](/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md) +1. [WordPress Plugin](/docs/getting-started/tutorials/create-block/wp-plugin.md) +2. [Anatomy of a Gutenberg Block ](/docs/getting-started/tutorials/create-block/block-anatomy.md) +3. [Block Attributes](/docs/getting-started/tutorials/create-block/attributes.md) +4. [Code Implementation](/docs/getting-started/tutorials/create-block/block-code.md) +5. [Authoring Experience](/docs/getting-started/tutorials/create-block/author-experience.md) +6. [Finishing Touches](/docs/getting-started/tutorials/create-block/finishing.md) +7. [Share your Block with the World](/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md) diff --git a/docs/getting-started/tutorials/create-block/attributes.md b/docs/getting-started/tutorials/create-block/attributes.md index 5614987e33fa0..2c3360db158af 100644 --- a/docs/getting-started/tutorials/create-block/attributes.md +++ b/docs/getting-started/tutorials/create-block/attributes.md @@ -18,11 +18,11 @@ Add this to the `index.js` file within the `registerBlockType` function. The `at When the block loads it will look at the saved content for the block, look for the div tag, take the text portion, and store the content in an `attributes.message` variable. -Note: The text portion is equivalent to `innerText` attribute of a DOM element. For more details and other examples see the [Block Attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md). +Note: The text portion is equivalent to `innerText` attribute of a DOM element. For more details and other examples see the [Block Attributes documentation](/docs/reference-guides/block-api/block-attributes.md). ## Edit and Save -The **attributes** are passed to the `edit` and `save` functions, along with a **setAttributes** function to set the values. Additional parameters are also passed in to this functions, see [the edit/save documentation](/docs/designers-developers/developers/block-api/block-edit-save.md) for more details. +The **attributes** are passed to the `edit` and `save` functions, along with a **setAttributes** function to set the values. Additional parameters are also passed in to this functions, see [the edit/save documentation](/docs/reference-guides/block-api/block-edit-save.md) for more details. The `attributes` is a JavaScript object containing the values of each attribute, or default values if defined. The `setAttributes` is a function to update an attribute. @@ -71,4 +71,4 @@ export default function Save( { attributes, className } ) { Rebuild the block using `npm run build`, reload the editor and add the block. Type a message in the editor, save, and view it in the post. -Next Section: [Code Implementation](/docs/designers-developers/developers/tutorials/create-block/block-code.md) +Next Section: [Code Implementation](/docs/getting-started/tutorials/create-block/block-code.md) diff --git a/docs/getting-started/tutorials/create-block/author-experience.md b/docs/getting-started/tutorials/create-block/author-experience.md index accd856ae2562..a79b73e5d07b9 100644 --- a/docs/getting-started/tutorials/create-block/author-experience.md +++ b/docs/getting-started/tutorials/create-block/author-experience.md @@ -139,4 +139,4 @@ export default function Edit( { attributes, className, setAttributes } ) { } ``` -Next Section: [Finishing Touches](/docs/designers-developers/developers/tutorials/create-block/finishing.md) +Next Section: [Finishing Touches](/docs/getting-started/tutorials/create-block/finishing.md) diff --git a/docs/getting-started/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md index 2eea119b98ecd..2a807b7356105 100644 --- a/docs/getting-started/tutorials/create-block/block-anatomy.md +++ b/docs/getting-started/tutorials/create-block/block-anatomy.md @@ -2,7 +2,7 @@ At its simplest, a block in the WordPress block editor is a JavaScript object with a specific set of properties. -**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. +**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. Here is the complete code for registering a block: @@ -35,13 +35,13 @@ registerBlockType( 'create-block/gutenpride', { The first parameter in the **registerBlockType** function is the block name, this should match exactly to the name registered in the PHP file. -The second parameter to the function is the block object. See the [block registration documentation](/docs/designers-developers/developers/block-api/block-registration.md) for full details. +The second parameter to the function is the block object. See the [block registration documentation](/docs/reference-guides/block-api/block-registration.md) for full details. The **title** is the title of the block shown in the Inserter. The **icon** is the icon shown in the Inserter. The icon property expects any Dashicon name as a string, see [list of available icons](https://developer.wordpress.org/resource/dashicons/). You can also provide an SVG object, but for now it's easiest to just pick a Dashicon name. -The **category** specified is a string and must be one of: "common, formatting, layout, widgets, or embed". You can create your own custom category name, [see documentation for details](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). For this tutorial, I specified "widgets" as the category. +The **category** specified is a string and must be one of: "common, formatting, layout, widgets, or embed". You can create your own custom category name, [see documentation for details](/docs/reference-guides/filters/block-filters.md#managing-block-categories). For this tutorial, I specified "widgets" as the category. The last two block object properties are **edit** and **save**, these are the key parts of a block. Both properties should be defined as functions. @@ -61,4 +61,4 @@ __( 'Gutenpride', 'gutenpride' ); This is an internationalization wrapper that allows for the string "Gutenpride" to be translated. The second parameter, "gutenpride" is called the text domain and gives context for where the string is from. The JavaScript internationalization, often abbreviated i18n, matches the core WordPress internationalization process. See the [Internationalization in Plugin Developer Handbook](https://developer.wordpress.org/plugins/internationalization/) for more details. -Next Section: [Block Attributes](/docs/designers-developers/developers/tutorials/create-block/attributes.md) +Next Section: [Block Attributes](/docs/getting-started/tutorials/create-block/attributes.md) diff --git a/docs/getting-started/tutorials/create-block/block-code.md b/docs/getting-started/tutorials/create-block/block-code.md index 61a4b920aab95..23541de7ecb59 100644 --- a/docs/getting-started/tutorials/create-block/block-code.md +++ b/docs/getting-started/tutorials/create-block/block-code.md @@ -65,4 +65,4 @@ Update **gutenpride.php** to enqueue from generated file location: $editor_css = "build/index.css"; ``` -Next Section: [Authoring Experience](/docs/designers-developers/developers/tutorials/create-block/author-experience.md) +Next Section: [Authoring Experience](/docs/getting-started/tutorials/create-block/author-experience.md) diff --git a/docs/getting-started/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md index a07c82296123b..1eda38da32078 100644 --- a/docs/getting-started/tutorials/create-block/finishing.md +++ b/docs/getting-started/tutorials/create-block/finishing.md @@ -10,13 +10,13 @@ You can visually browse the components and what their implementation looks like ## Additional Tutorials -The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/designers-developers/developers/richtext.md) for documentation using this component. +The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/reference-guides/richtext.md) for documentation using this component. -The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. +The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. -The [Sidebar tutorial](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. +The [Sidebar tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. -Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md). +Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md). ## How did they do that diff --git a/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md index a0924099310f1..220c30a174ea4 100644 --- a/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md +++ b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md @@ -48,7 +48,7 @@ Examples for an Image Slider block: - carousel - gallery -[Read more about keywords.](/docs/designers-developers/developers/block-api/block-metadata.md#keywords) +[Read more about keywords.](/docs/reference-guides/block-api/block-metadata.md#keywords) ### Choose the right category @@ -62,13 +62,13 @@ The Block Editor allows you to indicate the category your block belongs in, maki - widgets - embed -[Read more about categories.](/docs/designers-developers/developers/block-api/block-metadata.md#category) +[Read more about categories.](/docs/reference-guides/block-api/block-metadata.md#category) Wondering where to input all this information? Read the next section :) ## Step 2: Analyze your plugin -Each block in your plugin should have a corresponding `block.json` file with the [block metadata](/docs/designers-developers/developers/block-api/block-metadata.md). This file provides the Block Directory important information about your block. Along with being the place to store contextual information about your block like the: `name`, `description`, `keywords` and `category`, the `block.json` file stores the location of your block’s files. +Each block in your plugin should have a corresponding `block.json` file with the [block metadata](/docs/reference-guides/block-api/block-metadata.md). This file provides the Block Directory important information about your block. Along with being the place to store contextual information about your block like the: `name`, `description`, `keywords` and `category`, the `block.json` file stores the location of your block’s files. Block plugins submitted to the Block Directory can contain mutliple blocks only if they are children of a single parent/ancestor. There should only be one main block. For example, a list block can contain list-item blocks. Children blocks must set the `parent` property in their `block.json` file. @@ -94,7 +94,7 @@ Here is an example of a basic block.json file. } ``` -The `block.json` file also contains other important properties. Take a look at an [example block.json](/docs/designers-developers/developers/block-api/block-metadata.md) for additional properties to be included in the block.json file. +The `block.json` file also contains other important properties. Take a look at an [example block.json](/docs/reference-guides/block-api/block-metadata.md) for additional properties to be included in the block.json file. ## Step 3: Zip & Submit diff --git a/docs/getting-started/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md index b044423658967..a7a5687c23740 100644 --- a/docs/getting-started/tutorials/create-block/wp-plugin.md +++ b/docs/getting-started/tutorials/create-block/wp-plugin.md @@ -49,7 +49,7 @@ Let's confirm the plugin is loaded and working. -or- -(3B) If you are using `wp-env`, see [Development Environment setup](/docs/designers-developers/developers/tutorials/devenv/readme.md), then you should now run from inside the `gutenpride` directory: +(3B) If you are using `wp-env`, see [Development Environment setup](/docs/getting-started/tutorials/devenv/readme.md), then you should now run from inside the `gutenpride` directory: ```sh wp-env start @@ -112,7 +112,7 @@ For the `editorScript` provided in the block metadata, the build process creates The `wp_register_script` function used internally registers a name, called the handle, and relates that name to the script file. The dependencies are used to specify if the script requires including other libraries. The version is specified so the browser will reload if the file changed. -The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/designers-developers/developers/internationalization.md) +The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/howto-guides/internationalization.md) With the above in place, create a new post to load the editor and check your plugin is in the inserter. You can use `/` to search, or click the box with the [+] and search for "Gutenpride" to find the block. @@ -124,10 +124,10 @@ To open the developer tools in Firefox, use the menu selecting Web Developer : T Try running `npm run start` that will start the watch process for automatic rebuilds. If you then make an update to `src/index.js` file, you will see the build run, and if you reload the WordPress editor you'll see the change. -For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) in the Block Editor Handbook. +For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/js-build-setup.md) in the Block Editor Handbook. ## Summary Hopefully, at this point, you have your plugin created and activated. We have the package.json with the `@wordpress/scripts` dependency, that defines the build and start scripts. The basic block is in place and can be added to the editor. -Next Section: [Anatomy of a Block](/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md) +Next Section: [Anatomy of a Block](/docs/getting-started/tutorials/create-block/block-anatomy.md) diff --git a/docs/getting-started/tutorials/devenv/README.md b/docs/getting-started/tutorials/devenv/README.md index 642e17b5528ac..212c7f689cd58 100644 --- a/docs/getting-started/tutorials/devenv/README.md +++ b/docs/getting-started/tutorials/devenv/README.md @@ -115,7 +115,7 @@ There are several ways to run WordPress locally on your own computer, or you cou The WordPress [wp-env package](https://www.npmjs.com/package/@wordpress/env) lets you set up a local WordPress environment for building and testing plugins and themes, without any additional configuration. -The `wp-env` tool uses Docker to create a virtual machine to that runs the WordPress site. There are instructions available for installing Docker on [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/), [all other versions of Windows](https://docs.docker.com/toolbox/toolbox_install_windows/), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/v17.12/install/linux/docker-ce/ubuntu/#install-using-the-convenience-script). If using Ubuntu, see our additional notes for [help installing Docker on Ubuntu](/docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md). +The `wp-env` tool uses Docker to create a virtual machine to that runs the WordPress site. There are instructions available for installing Docker on [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/), [all other versions of Windows](https://docs.docker.com/toolbox/toolbox_install_windows/), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/v17.12/install/linux/docker-ce/ubuntu/#install-using-the-convenience-script). If using Ubuntu, see our additional notes for [help installing Docker on Ubuntu](/docs/getting-started/tutorials/devenv/docker-ubuntu.md). After you have installed Docker, go ahead and install the `wp-env` tool. This command will install the tool globally, which means you can run it from any directory: diff --git a/docs/howto-guides/README.md b/docs/howto-guides/README.md index f79b1564f1787..dbed9976d4c9e 100644 --- a/docs/howto-guides/README.md +++ b/docs/howto-guides/README.md @@ -4,15 +4,15 @@ The new editor is highly flexible, like most of WordPress. You can build custom ## Creating Blocks -The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. +The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. -If you want to learn more about block creation, see the [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the best place to start. +If you want to learn more about block creation, see the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for the best place to start. ## Extending Blocks It is also possible to modify the behavior of existing blocks or even remove them completely using filters. -Learn more in the [Block Filters](/docs/designers-developers/developers/filters/block-filters.md) section. +Learn more in the [Block Filters](/docs/reference-guides/filters/block-filters.md) section. ## Extending the Editor UI @@ -20,26 +20,26 @@ Extending the editor UI can be accomplished with the `registerPlugin` API, allow Refer to the [Plugins](/packages/plugins/README.md) and [Edit Post](/packages/edit-post/README.md) section for more information. -You can also filter certain aspects of the editor; this is documented on the [Editor Filters](/docs/designers-developers/developers/filters/editor-filters.md) page. +You can also filter certain aspects of the editor; this is documented on the [Editor Filters](/docs/reference-guides/filters/editor-filters.md) page. ## Meta Boxes -Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/designers-developers/developers/tutorials/metabox/readme.md). +Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/howto-guides/metabox/readme.md). -See how the new editor [supports existing Meta Boxes](/docs/designers-developers/developers/backward-compatibility/meta-box.md). +See how the new editor [supports existing Meta Boxes](/docs/reference-guides/backward-compatibility/meta-box.md). ## Theme Support By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults. -There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/designers-developers/developers/themes/theme-support.md). +There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/howto-guides/themes/theme-support.md). ## Autocomplete -Autocompleters within blocks may be extended and overridden. Learn more about the [autocomplete](/docs/designers-developers/developers/filters/autocomplete-filters.md) filters. +Autocompleters within blocks may be extended and overridden. Learn more about the [autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) filters. ## Block Parsing and Serialization Posts in the editor move through a couple of different stages between being stored in `post_content` and appearing in the editor. Since the blocks themselves are data structures that live in memory it takes a parsing and serialization step to transform out from and into the stored format in the database. -Customizing the parser is an advanced topic that you can learn more about in the [Extending the Parser](/docs/designers-developers/developers/filters/parser-filters.md) section. +Customizing the parser is an advanced topic that you can learn more about in the [Extending the Parser](/docs/reference-guides/filters/parser-filters.md) section. diff --git a/docs/howto-guides/backward-compatibility/README.md b/docs/howto-guides/backward-compatibility/README.md index da58849dec322..82ede6ca49e0b 100644 --- a/docs/howto-guides/backward-compatibility/README.md +++ b/docs/howto-guides/backward-compatibility/README.md @@ -34,7 +34,7 @@ Production packages use the `wp` global variable to provide APIs to third-party * Existing usage of the block should not break or be marked as invalid when the editor is loaded. * The styling of the existing blocks should be guaranteed. -* Markup changes should be limited to the minimum possible, but if a block needs to change its saved markup, making previous versions invalid, a [**deprecated version**](/docs/designers-developers/developers/block-api/block-deprecation.md) of the block should be added. +* Markup changes should be limited to the minimum possible, but if a block needs to change its saved markup, making previous versions invalid, a [**deprecated version**](/docs/reference-guides/block-api/block-deprecation.md) of the block should be added. ## Class names and DOM updates diff --git a/docs/howto-guides/backward-compatibility/deprecations.md b/docs/howto-guides/backward-compatibility/deprecations.md index b643d3029e3ab..dc474423f93b5 100644 --- a/docs/howto-guides/backward-compatibility/deprecations.md +++ b/docs/howto-guides/backward-compatibility/deprecations.md @@ -8,12 +8,12 @@ For features included in the Gutenberg plugin, the deprecation policy is intende ## 8.6.0 -- Block API integration with [Block Context](/docs/designers-developers/developers/block-api/block-context.md) was updated. When registering a block use `usesContext` and `providesContext` pair in JavaScript files and `uses_context` and `provides_context` pair in PHP files instead of previous pair `context` and `providesContext`. +- Block API integration with [Block Context](/docs/reference-guides/block-api/block-context.md) was updated. When registering a block use `usesContext` and `providesContext` pair in JavaScript files and `uses_context` and `provides_context` pair in PHP files instead of previous pair `context` and `providesContext`. ## 8.3.0 -- The PHP function `gutenberg_get_post_from_context` has been removed. Use [Block Context](/docs/designers-developers/developers/block-api/block-context.md) instead. -- The old Block Pattern APIs `register_pattern`/`unregister_pattern` have been removed. Use the [new functions](/docs/designers-developers/developers/block-api/block-patterns.md#register_block_pattern) instead. +- The PHP function `gutenberg_get_post_from_context` has been removed. Use [Block Context](/docs/reference-guides/block-api/block-context.md) instead. +- The old Block Pattern APIs `register_pattern`/`unregister_pattern` have been removed. Use the [new functions](/docs/reference-guides/block-api/block-patterns.md#register_block_pattern) instead. ## 5.5.0 @@ -281,6 +281,6 @@ For features included in the Gutenberg plugin, the deprecation policy is intende - `wp.blocks.BlockDescription` component removed. Please use the `description` block property instead. - `wp.blocks.InspectorControls.*` components removed. Please use `wp.components.*` components instead. -- `wp.blocks.source.*` matchers removed. Please use the declarative attributes instead. See [block attributes](/docs/designers-developers/developers/block-api/block-attributes.md) for more info. +- `wp.blocks.source.*` matchers removed. Please use the declarative attributes instead. See [block attributes](/docs/reference-guides/block-api/block-attributes.md) for more info. - `wp.data.select( 'selector', ...args )` removed. Please use `wp.data.select( reducerKey' ).*` instead. - `wp.blocks.MediaUploadButton` component removed. Please use `wp.blocks.MediaUpload` component instead. diff --git a/docs/howto-guides/backward-compatibility/meta-box.md b/docs/howto-guides/backward-compatibility/meta-box.md index dc8ce593eb856..56432fd80b56d 100644 --- a/docs/howto-guides/backward-compatibility/meta-box.md +++ b/docs/howto-guides/backward-compatibility/meta-box.md @@ -1,6 +1,6 @@ # Meta Boxes -This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. +This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/howto-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. ### Testing, Converting, and Maintaining Existing Meta Boxes diff --git a/docs/howto-guides/block-based-themes/README.md b/docs/howto-guides/block-based-themes/README.md index a701cd4622881..faf0b054a163f 100644 --- a/docs/howto-guides/block-based-themes/README.md +++ b/docs/howto-guides/block-based-themes/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/designers-developers/developers/tutorials/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/designers-developers/developers/tutorials/block-based-themes/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/designers-developers/developers/tutorials/block-based-themes/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/designers-developers/developers/tutorials/block-based-themes/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/howto-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/howto-guides/block-based-themes/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/howto-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/howto-guides/block-based-themes/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -32,7 +32,7 @@ Each template or template part contains the [block grammar](https://developer.wo A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. -The theme may optionally include an [experimental-theme.json file](/docs/designers-developers/developers/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. +The theme may optionally include an [experimental-theme.json file](/docs/howto-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) diff --git a/docs/howto-guides/block-tutorial/README.md b/docs/howto-guides/block-tutorial/README.md index 42d72444e898e..b4b2b05a39dd2 100644 --- a/docs/howto-guides/block-tutorial/README.md +++ b/docs/howto-guides/block-tutorial/README.md @@ -4,6 +4,6 @@ The purpose of this tutorial is to step through the fundamentals of creating a n To follow along with this tutorial, you can [download the accompanying WordPress plugin](https://github.com/WordPress/gutenberg-examples) which includes all of the examples for you to try on your own site. At each step along the way, experiment by modifying the examples with your own ideas, and observe the effects they have on the block's behavior. -Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup/) to compile your code to a browser compatible format. +Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/howto-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. diff --git a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md index cc363293e31ea..443dce0e2477b 100644 --- a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md +++ b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md @@ -5,11 +5,11 @@ Dynamic blocks are blocks that build their structure and content on the fly when There are two primary uses for dynamic blocks: 1. Blocks where content should change even if a post has not been updated. One example from WordPress itself is the Latest Posts block. This block will update everywhere it is used when a new post is published. -2. Blocks where updates to the code (HTML, CSS, JS) should be immediately shown on the front end of the website. For example, if you update the structure of a block by adding a new class, adding an HTML element, or changing the layout in any other way, using a dynamic block ensures those changes are applied immediately on all occurrences of that block across the site. (If a dynamic block is not used then when block code is updated Guterberg's [validation process](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) generally applies, causing users to see the validation message, "This block appears to have been modified externally"). +2. Blocks where updates to the code (HTML, CSS, JS) should be immediately shown on the front end of the website. For example, if you update the structure of a block by adding a new class, adding an HTML element, or changing the layout in any other way, using a dynamic block ensures those changes are applied immediately on all occurrences of that block across the site. (If a dynamic block is not used then when block code is updated Guterberg's [validation process](/docs/reference-guides/block-api/block-edit-save.md#validation) generally applies, causing users to see the validation message, "This block appears to have been modified externally"). -For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/designers-developers/developers/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. +For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/reference-guides/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. -If you are using [InnerBlocks](/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` +If you are using [InnerBlocks](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` You can also save an HTML representation of the block. If you provide a server-side rendering callback, this HTML will be replaced with the output of your callback, but will be rendered if your block is deactivated or your render callback is removed. diff --git a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md index 74a9921a11f5f..d52bf29b2f609 100644 --- a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md +++ b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md @@ -4,4 +4,4 @@ **Deprecated:** It is not no longer recommended to use WP-CLI or create-guten-block to generate block scaffolding. -The official script to generate a block is the new [@wordpress/create-block](/packages/create-block/README.md) package. This package follows the new block directory guidelines, and creates the proper block, environment, and standards set by the project. See the new [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for a complete walk-through. +The official script to generate a block is the new [@wordpress/create-block](/packages/create-block/README.md) package. This package follows the new block directory guidelines, and creates the proper block, environment, and standards set by the project. See the new [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for a complete walk-through. diff --git a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md index e3696634992eb..8da80032db925 100644 --- a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md +++ b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md @@ -18,7 +18,7 @@ One challenge of maintaining the representation of a block as a JavaScript objec }, ``` -When registering a new block type, the `attributes` property describes the shape of the attributes object you'd like to receive in the `edit` and `save` functions. Each value is a [source function](/docs/designers-developers/developers/block-api/block-attributes.md) to find the desired value from the markup of the block. +When registering a new block type, the `attributes` property describes the shape of the attributes object you'd like to receive in the `edit` and `save` functions. Each value is a [source function](/docs/reference-guides/block-api/block-attributes.md) to find the desired value from the markup of the block. In the code snippet above, when loading the editor, the `content` value will be extracted from the HTML of the paragraph element in the saved post's markup. @@ -26,7 +26,7 @@ In the code snippet above, when loading the editor, the `content` value will be Earlier examples used the `createElement` function to create DOM nodes, but it's also possible to encapsulate this behavior into "components". This abstraction helps you share common behaviors and hide complexity in self-contained units. -There are a number of [components available](/docs/designers-developers/developers/packages/packages-editor.md#components) to use in implementing your blocks. You can see one such component in the code below: the [`RichText` component](/docs/designers-developers/developers/packages/packages-editor.md#richtext) is part of the `wp-editor` package. +There are a number of [components available](/docs/reference-guides/packages/packages-editor.md#components) to use in implementing your blocks. You can see one such component in the code below: the [`RichText` component](/docs/reference-guides/packages/packages-editor.md#richtext) is part of the `wp-editor` package. The `RichText` component can be considered as a super-powered `textarea` element, enabling rich content editing including bold, italics, hyperlinks, etc. diff --git a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md index 87d98bd4f9e76..537e233a1645e 100644 --- a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md +++ b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md @@ -36,7 +36,7 @@ function gutenberg_examples_01_register_block() { add_action( 'init', 'gutenberg_examples_01_register_block' ); ``` -Note the above example, shows using the [wp-scripts build step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup/) that automatically sets dependencies and versions the file. +Note the above example, shows using the [wp-scripts build step](/docs/howto-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. If you were using the ES5 code, you would specify `array( 'wp-blocks', 'wp-element' )` as the dependency array. See the [example 01](https://github.com/WordPress/gutenberg-examples/blob/HEAD/01-basic/index.php) in Gutenberg Examples repository for full syntax. @@ -123,7 +123,7 @@ registerBlockType( 'gutenberg-examples/example-01-basic-esnext', { _By now you should be able to see `Hello World, step 1 (from the editor).` in the admin side and `Hello World, step 1 (from the frontend).` on the frontend side._ -Once a block is registered, you should immediately see that it becomes available as an option in the editor inserter dialog, using values from `title`, `icon`, and `category` to organize its display. You can choose an icon from any included in the built-in [Dashicons icon set](https://developer.wordpress.org/resource/dashicons/), or provide a [custom svg element](/docs/designers-developers/developers/block-api/block-registration.md#icon-optional). +Once a block is registered, you should immediately see that it becomes available as an option in the editor inserter dialog, using values from `title`, `icon`, and `category` to organize its display. You can choose an icon from any included in the built-in [Dashicons icon set](https://developer.wordpress.org/resource/dashicons/), or provide a [custom svg element](/docs/reference-guides/block-api/block-registration.md#icon-optional). A block name must be prefixed with a namespace specific to your plugin. This helps prevent conflicts when more than one plugin registers a block with the same name. In this example, the namespace is `gutenberg-examples`. diff --git a/docs/howto-guides/designers/block-design.md b/docs/howto-guides/designers/block-design.md index 8ec0d4649e187..233d0476fa9fe 100644 --- a/docs/howto-guides/designers/block-design.md +++ b/docs/howto-guides/designers/block-design.md @@ -76,7 +76,7 @@ Avoid long, multi-line block names. Every block should include a description that clearly explains the block's function. The description will display in the Settings Sidebar. -You can add a description by using the description attribute in the [registerBlockType function](/docs/designers-developers/developers/block-api/block-registration.md). +You can add a description by using the description attribute in the [registerBlockType function](/docs/reference-guides/block-api/block-registration.md). Stick to a single imperative sentence with an action + subject format. Examples: @@ -132,7 +132,7 @@ Check how your block looks, feels, and works on as many devices and screen sizes ### Support Gutenberg's dark background editor scheme -Check how your block looks with [dark backgrounds](/docs/designers-developers/developers/themes/theme-support.md#dark-backgrounds) in the editor. +Check how your block looks with [dark backgrounds](/docs/howto-guides/themes/theme-support.md#dark-backgrounds) in the editor. ## Examples diff --git a/docs/howto-guides/format-api/3-apply-format.md b/docs/howto-guides/format-api/3-apply-format.md index 53e72e3ceba18..25dd678114eeb 100644 --- a/docs/howto-guides/format-api/3-apply-format.md +++ b/docs/howto-guides/format-api/3-apply-format.md @@ -71,4 +71,4 @@ The expected behavior is that the format will be toggled, meaning that the text Your browser may have already displayed the selection differently once the tag was applied, but you may want to use a special style of your own. You can use the `className` option in [`registerFormatType`](/packages/rich-text/README.md#registerFormatType) to target the new element by class name: if `className` is set, it'll be added to the new element. -That's it. This is all that is necessary to make a custom format available in the new editor. From here, you may want to check out other [tutorials](/docs/designers-developers/developers/tutorials/) or apply your new knowledge to your next plugin! +That's it. This is all that is necessary to make a custom format available in the new editor. From here, you may want to check out other [tutorials](/docs/getting-started/tutorials/) or apply your new knowledge to your next plugin! diff --git a/docs/howto-guides/format-api/README.md b/docs/howto-guides/format-api/README.md index 3ecb76c07e059..74b742db7bebd 100644 --- a/docs/howto-guides/format-api/README.md +++ b/docs/howto-guides/format-api/README.md @@ -4,10 +4,10 @@ The purpose of this tutorial is to introduce you to the Format API. The Format A In WordPress lingo, a _format_ is a [HTML tag with text-level semantics](https://www.w3.org/TR/html5/textlevel-semantics.html#text-level-semantics-usage-summary) used to give some special meaning to a text selection. For example, in this tutorial, the button to be hooked into the format toolbar will let users wrap a particular text selection with the [`` HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp). -If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) first. +If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) first. ## Table of Contents -1. [Register a new format](/docs/designers-developers/developers/tutorials/format-api/1-register-format.md) -2. [Add a button to the toolbar](/docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md) -3. [Apply the format when the button is clicked](/docs/designers-developers/developers/tutorials/format-api/3-apply-format.md) +1. [Register a new format](/docs/howto-guides/format-api/1-register-format.md) +2. [Add a button to the toolbar](/docs/howto-guides/format-api/2-toolbar-button.md) +3. [Apply the format when the button is clicked](/docs/howto-guides/format-api/3-apply-format.md) diff --git a/docs/howto-guides/internationalization.md b/docs/howto-guides/internationalization.md index 28d810db117fc..65ad0e204b680 100644 --- a/docs/howto-guides/internationalization.md +++ b/docs/howto-guides/internationalization.md @@ -273,4 +273,4 @@ With the language set, create a new post, add the block, and you will see the tr ### Filtering Translations -The outputs of the translation functions (`__()`, `_x()`, `_n()`, and `_nx()`) are filterable, see [i18n Filters](/docs/designers-developers/developers/filters/i18n-filters.md) for full information. +The outputs of the translation functions (`__()`, `_x()`, `_n()`, and `_nx()`) are filterable, see [i18n Filters](/docs/reference-guides/filters/i18n-filters.md) for full information. diff --git a/docs/howto-guides/javascript/README.md b/docs/howto-guides/javascript/README.md index c0a80e1b3e20c..b505191c791be 100644 --- a/docs/howto-guides/javascript/README.md +++ b/docs/howto-guides/javascript/README.md @@ -10,11 +10,11 @@ The block editor introduced in WordPress 5.0 is written in JavaScript, with the ### Table of Contents -1. [Plugins Background](/docs/designers-developers/developers/tutorials/javascript/plugins-background.md) -2. [Loading JavaScript](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) -3. [Extending the Block Editor](/docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md) -4. [Troubleshooting](/docs/designers-developers/developers/tutorials/javascript/troubleshooting.md) -5. [JavaScript Versions and Building](/docs/designers-developers/developers/tutorials/javascript/versions-and-building.md) -6. [Scope your code](/docs/designers-developers/developers/tutorials/javascript/scope-your-code.md) -7. [JavaScript Build Step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) -8. [ESNext Syntax](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) +1. [Plugins Background](/docs/howto-guides/javascript/plugins-background.md) +2. [Loading JavaScript](/docs/howto-guides/javascript/loading-javascript.md) +3. [Extending the Block Editor](/docs/howto-guides/javascript/extending-the-block-editor.md) +4. [Troubleshooting](/docs/howto-guides/javascript/troubleshooting.md) +5. [JavaScript Versions and Building](/docs/howto-guides/javascript/versions-and-building.md) +6. [Scope your code](/docs/howto-guides/javascript/scope-your-code.md) +7. [JavaScript Build Step](/docs/howto-guides/javascript/js-build-setup.md) +8. [ESNext Syntax](/docs/howto-guides/javascript/esnext-js.md) diff --git a/docs/howto-guides/javascript/extending-the-block-editor.md b/docs/howto-guides/javascript/extending-the-block-editor.md index 9ee0b5e03c86d..0609d78aa958e 100644 --- a/docs/howto-guides/javascript/extending-the-block-editor.md +++ b/docs/howto-guides/javascript/extending-the-block-editor.md @@ -1,6 +1,6 @@ # Extending the Block Editor -Let's look at using the [Block Style Variation example](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) to extend the editor. This example allows you to add your own custom CSS class name to any core block type. +Let's look at using the [Block Style Variation example](/docs/reference-guides/filters/block-filters.md#block-style-variations) to extend the editor. This example allows you to add your own custom CSS class name to any core block type. Replace the existing `console.log()` code in your `myguten.js` file with: @@ -30,7 +30,7 @@ add_action( 'enqueue_block_editor_assets', 'myguten_enqueue' ); The last argument in the `wp_enqueue_script()` function is an array of dependencies. WordPress makes packages available under the `wp` namespace. In the example, you use `wp.blocks` to access the items that the blocks package exports (in this case the `registerBlockStyle()` function). -See [Packages](/docs/designers-developers/developers/packages.md) for list of available packages and what objects they export. +See [Packages](/docs/reference-guides/packages.md) for list of available packages and what objects they export. After you have updated both JavaScript and PHP files, go to the block editor and create a new post. diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md index a1d3c9183aae7..1c3e3f314dc3a 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/howto-guides/javascript/js-build-setup.md @@ -2,7 +2,7 @@ ESNext is JavaScript written using syntax and features only available in a version newer than browser support—the support browser versions is referred to as ECMAScript 5 (ES5). [JSX](https://reactjs.org/docs/introducing-jsx.html) is a custom syntax extension to JavaScript, created by React project, that allows you to write JavaScript using a familiar HTML tag-like syntax. -See the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/getting-started.md) documentation. @@ -34,7 +34,7 @@ First, you need to set up Node.js for your development environment. The steps re - macOS: `brew install node` - Windows: `choco install node` -If you are not using a package manager, see the [developer environment setup documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md) for setting up Node using nvm, or see the official [Node.js download page](https://nodejs.org/en/download/) for installers and binaries. +If you are not using a package manager, see the [developer environment setup documentation](/docs/getting-started/tutorials/devenv/readme.md) for setting up Node using nvm, or see the official [Node.js download page](https://nodejs.org/en/download/) for installers and binaries. **Note:** The build tools and process occur on the command-line, so basic familiarity using a terminal application is required. Some text editors have a terminal built-in that is fine to use; Visual Studio Code and PhpStorm are two popular options. @@ -125,7 +125,7 @@ To configure npm to run a script, you use the scripts section in `package.json` You can then run the build using: `npm run build`. -After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md), and the block will load in the editor. +After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/howto-guides/javascript/loading-javascript.md), and the block will load in the editor. ## Development Mode diff --git a/docs/howto-guides/javascript/troubleshooting.md b/docs/howto-guides/javascript/troubleshooting.md index cd601db316bce..bb2bc57fd5633 100644 --- a/docs/howto-guides/javascript/troubleshooting.md +++ b/docs/howto-guides/javascript/troubleshooting.md @@ -55,7 +55,7 @@ If you are not seeing your changes, and no errors, check that your JavaScript fi If you do not see the file being loaded, double check the enqueue function is correct. You can also check your server logs to see if there is an error messages. -Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. +Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/howto-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. ## Confirm all dependencies are loading @@ -73,4 +73,4 @@ wp_enqueue_script( ); ``` -For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md#dependency-management). +For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/howto-guides/javascript/js-build-setup.md#dependency-management). diff --git a/docs/howto-guides/javascript/versions-and-building.md b/docs/howto-guides/javascript/versions-and-building.md index ccd02f71aca0b..9c13413d4b813 100644 --- a/docs/howto-guides/javascript/versions-and-building.md +++ b/docs/howto-guides/javascript/versions-and-building.md @@ -10,6 +10,6 @@ Additionally, the ESNext code examples in the handbook include [JSX syntax](http For simplicity, the JavaScript tutorial uses the ES5 definition, without JSX. This code can run straight in your browser and does not require an additional build step. In many cases, it is perfectly fine to follow the same approach for simple plugins or experimenting. As your codebase grows in complexity it might be a good idea to switch to ESNext. You will find the majority of code and documentation across the block editor uses ESNext. -See the [JavaScript Build Setup documentation](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. +See the [JavaScript Build Setup documentation](/docs/howto-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. -See the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. diff --git a/docs/howto-guides/metabox/README.md b/docs/howto-guides/metabox/README.md index a1e29fb2beeff..47c071489f00e 100644 --- a/docs/howto-guides/metabox/README.md +++ b/docs/howto-guides/metabox/README.md @@ -2,7 +2,7 @@ Prior to the block editor, custom meta boxes were used to extend the editor. With the new editor there are new ways to extend, giving more power to the developer and a better experience for the authors. Porting older custom meta boxes to one of these new methods is encouraged as to create a more unified and consistent experience for those using the editor. -The new block editor does support most existing meta boxes, see [this backward compatibility article](/docs/designers-developers/developers/backward-compatibility/meta-box.md) for more support details . +The new block editor does support most existing meta boxes, see [this backward compatibility article](/docs/reference-guides/backward-compatibility/meta-box.md) for more support details . Here are two mini-tutorials for creating similar functionality to meta boxes in the block editor. @@ -10,9 +10,9 @@ Here are two mini-tutorials for creating similar functionality to meta boxes in The first method is to use Blocks to store extra data with a post. The data is stored in a post meta field, similar to how meta boxes store information. -* [Store Post Meta with a Block](/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md) +* [Store Post Meta with a Block](/docs/howto-guides/metabox/meta-block-1-intro.md) ## Sidebar Plugin -If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/designers-developers/developers/tutorials/plugin-sidebar-0/). +If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md/). diff --git a/docs/howto-guides/metabox/meta-block-1-intro.md b/docs/howto-guides/metabox/meta-block-1-intro.md index ce001938ecfa6..1a02e4ec6fad1 100644 --- a/docs/howto-guides/metabox/meta-block-1-intro.md +++ b/docs/howto-guides/metabox/meta-block-1-intro.md @@ -6,12 +6,12 @@ In this short tutorial you will create one of these blocks, which will prompt a For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/architecture/key-concepts.md) of the handbook. -Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) for information setting up a plugin. +Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/howto-guides/javascript/readme.md) for information setting up a plugin. ## Table of Contents -1. [Register Meta Field](/docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md) -2. [Add Meta Block](/docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md) -3. [Use Post Meta Data](/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md) -4. [Finishing Touches](/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md) +1. [Register Meta Field](/docs/howto-guides/metabox/meta-block-2-register-meta.md) +2. [Add Meta Block](/docs/howto-guides/metabox/meta-block-3-add.md) +3. [Use Post Meta Data](/docs/howto-guides/metabox/meta-block-4-use-data.md) +4. [Finishing Touches](/docs/howto-guides/metabox/meta-block-5-finishing.md) diff --git a/docs/howto-guides/metabox/meta-block-3-add.md b/docs/howto-guides/metabox/meta-block-3-add.md index 621447015aa93..ae88a63e17e3b 100644 --- a/docs/howto-guides/metabox/meta-block-3-add.md +++ b/docs/howto-guides/metabox/meta-block-3-add.md @@ -1,6 +1,6 @@ # Create Meta Block -With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. +With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. For this block, you will use the TextControl component, which is similar to an HTML input text field. For additional components, check out the [Component Reference](/packages/components/README.md). @@ -138,4 +138,4 @@ You can now edit a draft post and add a Meta Block to the post. You will see you ![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) -You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. +You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/howto-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/howto-guides/metabox/meta-block-5-finishing.md b/docs/howto-guides/metabox/meta-block-5-finishing.md index b8f41f104b8c8..a5b02757ccaa9 100644 --- a/docs/howto-guides/metabox/meta-block-5-finishing.md +++ b/docs/howto-guides/metabox/meta-block-5-finishing.md @@ -1,6 +1,6 @@ # Finishing Touches -One problem using a meta block is the block is easy for an author to forget, since it requires being added to each post. You solve this by using [block templates](/docs/designers-developers/developers/block-api/block-templates.md). A block template is a predefined list of block items per post type. Templates allow you to specify a default initial state for a post type. +One problem using a meta block is the block is easy for an author to forget, since it requires being added to each post. You solve this by using [block templates](/docs/reference-guides/block-api/block-templates.md). A block template is a predefined list of block items per post type. Templates allow you to specify a default initial state for a post type. For this example, you use a template to automatically insert the meta block at the top of a post. diff --git a/docs/howto-guides/notices/README.md b/docs/howto-guides/notices/README.md index 5761139266942..7bef4e05911ec 100644 --- a/docs/howto-guides/notices/README.md +++ b/docs/howto-guides/notices/README.md @@ -71,10 +71,10 @@ To better understand the specific code example above: * `wp.data.dispatch('core/notices')` accesses functionality registered to the block editor data store by the Notices package. * `createNotice()` is a function offered by the Notices package to register a new notice. The block editor reads from the notice data store in order to know which notices to display. -Check out the [_Loading JavaScript_](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. +Check out the [_Loading JavaScript_](/docs/howto-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. ## Learn More The block editor offers a complete API for generating notices. The official documentation is a great place to review what's possible. -For a full list of the available actions and selectors, refer to the [Notices Data Handbook](/docs/designers-developers/developers/data/data-core-notices.md) page. +For a full list of the available actions and selectors, refer to the [Notices Data Handbook](/docs/reference-guides/data/data-core-notices.md) page. diff --git a/docs/howto-guides/platform/README.md b/docs/howto-guides/platform/README.md index cf19d6f05e7f0..67e909a5cad60 100644 --- a/docs/howto-guides/platform/README.md +++ b/docs/howto-guides/platform/README.md @@ -60,5 +60,5 @@ You can also play with the [Gutenberg Example #03](https://github.com/WordPress/ The [`@wordpress/block-editor` package](https://developer.wordpress.org/block-editor/packages/packages-block-editor/) allows you to create and use standalone block editors. -You can learn more by reading the [tutorial "Building a custom block editor"](/docs/designers-developers/developers/platform/custom-block-editor/README.md). +You can learn more by reading the [tutorial "Building a custom block editor"](/docs/reference-guides/platform/custom-block-editor/README.md). diff --git a/docs/howto-guides/platform/custom-block-editor/README.md b/docs/howto-guides/platform/custom-block-editor/README.md index adfb0dcc92147..65623044f31d5 100644 --- a/docs/howto-guides/platform/custom-block-editor/README.md +++ b/docs/howto-guides/platform/custom-block-editor/README.md @@ -1,6 +1,6 @@ # Building a custom block editor -The purpose of [this tutorial](/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md) is to step through the fundamentals of creating a custom instance of a "block editor". +The purpose of [this tutorial](/docs/reference-guides/platform/custom-block-editor/tutorial.md) is to step through the fundamentals of creating a custom instance of a "block editor". ![alt text](https://wordpress.org/gutenberg/files/2020/03/editor.png "The Standalone Editor instance populated with example Blocks within a custom WP Admin page.") @@ -15,4 +15,4 @@ Code snippets are provided in "ESNext". ESNext refers to the next versions of th Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. -* [Start custom block editor tutorial](/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md) +* [Start custom block editor tutorial](/docs/reference-guides/platform/custom-block-editor/tutorial.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md index f5f270cc9c533..47978feeb0ec9 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md @@ -1,12 +1,12 @@ # Creating a Sidebar for Your Plugin -This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/designers-developers/developers/tutorials/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. +This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/howto-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. -1. [Get a sidebar up and running](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) -2. [Tweak the sidebar style and add controls](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) -3. [Register a new meta field](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md) -4. [Initialize the input control with the meta field value](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) -5. [Update the meta field value when input's content changes](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md) -6. [Finishing touches](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) +1. [Get a sidebar up and running](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) +2. [Tweak the sidebar style and add controls](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) +3. [Register a new meta field](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) +4. [Initialize the input control with the meta field value](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) +5. [Update the meta field value when input's content changes](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) +6. [Finishing touches](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md index 84894b9335ef6..17fdc3cad62de 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md @@ -1,6 +1,6 @@ # Get a Sidebar up and Running -The first step in the journey is to tell the editor that there is a new plugin that will have its own sidebar. You can do so by using the [registerPlugin](/packages/plugins/README.md), [PluginSidebar](/packages/edit-post/README.md#pluginsidebar), and [createElement](/packages/element/README.md) utilities provided by WordPress, to be found in the `@wordpress/plugins`, `@wordpress/edit-post`, and `@wordpress/element` [packages](/docs/designers-developers/developers/packages.md), respectively. +The first step in the journey is to tell the editor that there is a new plugin that will have its own sidebar. You can do so by using the [registerPlugin](/packages/plugins/README.md), [PluginSidebar](/packages/edit-post/README.md#pluginsidebar), and [createElement](/packages/element/README.md) utilities provided by WordPress, to be found in the `@wordpress/plugins`, `@wordpress/edit-post`, and `@wordpress/element` [packages](/docs/reference-guides/packages.md), respectively. Add the following code to a JavaScript file called `plugin-sidebar.js` and save it within your plugin's directory: diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md index afa859da1e35c..fc1e15024a85a 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md @@ -12,7 +12,7 @@ register_post_meta( 'post', 'sidebar_plugin_meta_block_field', array( ) ); ``` -To make sure the field has been loaded, query the block editor [internal data structures](/docs/designers-developers/developers/data/), also known as _stores_. Open your browser's console, and execute this piece of code: +To make sure the field has been loaded, query the block editor [internal data structures](/docs/reference-guides/data/), also known as _stores_. Open your browser's console, and execute this piece of code: ```js wp.data.select( 'core/editor' ).getCurrentPost().meta; diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md index bc602e39b2798..94e7e52db98cc 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md @@ -105,7 +105,7 @@ This is how the code changes from the previous section: * The `MetaBlockField` function has now a `props` argument as input. It contains the data object returned by the `mapSelectToProps` function, which it uses to initialize its value property. * The component rendered within the `div` element was also updated, the plugin now uses `MetaBlockFieldWithData`. This will be updated every time the original data changes. -* [getEditedPostAttribute](/docs/designers-developers/developers/data/data-core-editor.md#geteditedpostattribute) is used to retrieve data instead of [getCurrentPost](/docs/designers-developers/developers/data/data-core-editor.md#getcurrentpost) because it returns the most recent values of the post, including user editions that haven't been yet saved. +* [getEditedPostAttribute](/docs/reference-guides/data/data-core-editor.md#geteditedpostattribute) is used to retrieve data instead of [getCurrentPost](/docs/reference-guides/data/data-core-editor.md#getcurrentpost) because it returns the most recent values of the post, including user editions that haven't been yet saved. Update the code and open the sidebar. The input's content is no longer `Initial value` but a void string. Users can't type values yet, but let's check that the component is updated if the value in the store changes. Open the browser's console, execute diff --git a/docs/howto-guides/themes/block-based-themes.md b/docs/howto-guides/themes/block-based-themes.md index 34d37f32c403d..6b59aa1f14f70 100644 --- a/docs/howto-guides/themes/block-based-themes.md +++ b/docs/howto-guides/themes/block-based-themes.md @@ -31,7 +31,7 @@ theme |__ ... ``` -The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/designers-developers/developers/themes/theme-json.md) file for some styles. +The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/howto-guides/themes/theme-json.md) file for some styles. ## What is a block template? @@ -126,7 +126,7 @@ As we're still early in the process, the number of blocks specifically dedicated ## Styling -One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/designers-developers/developers/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. +One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/howto-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. ## Resources diff --git a/docs/howto-guides/themes/theme-support.md b/docs/howto-guides/themes/theme-support.md index 50497c0a59e52..66607e3264e32 100644 --- a/docs/howto-guides/themes/theme-support.md +++ b/docs/howto-guides/themes/theme-support.md @@ -360,7 +360,7 @@ To change the main column width of the editor, add the following CSS to `style-e You can use those editor widths to match those in your theme. You can use any CSS width unit, including `%` or `px`. -Further reading: [Applying Styles with Stylesheets](/docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md). +Further reading: [Applying Styles with Stylesheets](/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md). ## Responsive embedded content diff --git a/docs/reference-guides/block-api/README.md b/docs/reference-guides/block-api/README.md index 790e694aa65ba..753ba459c8919 100644 --- a/docs/reference-guides/block-api/README.md +++ b/docs/reference-guides/block-api/README.md @@ -4,15 +4,15 @@ Blocks are the fundamental element of the editor. They are the primary way in wh The following sections will walk you through the existing block APIs: -- [Block registration](/docs/designers-developers/developers/block-api/block-registration.md) -- [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) -- [Attributes](/docs/designers-developers/developers/block-api/block-attributes.md) -- [Context](/docs/designers-developers/developers/block-api/block-context.md) -- [Deprecation](/docs/designers-developers/developers/block-api/block-deprecation.md) -- [Supports](/docs/designers-developers/developers/block-api/block-supports.md) -- [Transformations](/docs/designers-developers/developers/block-api/block-transforms.md) -- [Templates](/docs/designers-developers/developers/block-api/block-templates.md) -- [Metadata](/docs/designers-developers/developers/block-api/block-metadata.md) -- [Block Patterns](/docs/designers-developers/developers/block-api/block-patterns.md) -- [Annotations](/docs/designers-developers/developers/block-api/block-annotations.md) -- [Versions](/docs/designers-developers/developers/block-api/versions.md) +- [Block registration](/docs/reference-guides/block-api/block-registration.md) +- [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) +- [Attributes](/docs/reference-guides/block-api/block-attributes.md) +- [Context](/docs/reference-guides/block-api/block-context.md) +- [Deprecation](/docs/reference-guides/block-api/block-deprecation.md) +- [Supports](/docs/reference-guides/block-api/block-supports.md) +- [Transformations](/docs/reference-guides/block-api/block-transforms.md) +- [Templates](/docs/reference-guides/block-api/block-templates.md) +- [Metadata](/docs/reference-guides/block-api/block-metadata.md) +- [Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Annotations](/docs/reference-guides/block-api/block-annotations.md) +- [Versions](/docs/reference-guides/block-api/versions.md) diff --git a/docs/reference-guides/block-api/block-attributes.md b/docs/reference-guides/block-api/block-attributes.md index dd482fd49e5c9..b5cdb3399b338 100644 --- a/docs/reference-guides/block-api/block-attributes.md +++ b/docs/reference-guides/block-api/block-attributes.md @@ -20,7 +20,7 @@ See [WordPress's REST API documentation](https://developer.wordpress.org/rest-ap Attribute sources are used to define how the block attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block. -If no attribute source is specified, the attribute will be saved to (and read from) the block's [comment delimiter](/docs/designers-developers/key-concepts.md#delimiters-and-parsing-expression-grammar). +If no attribute source is specified, the attribute will be saved to (and read from) the block's [comment delimiter](/docs/getting-started/architecture/key-concepts.md#delimiters-and-parsing-expression-grammar). The keys specified in the attributes source object are named as you see fit. The result of the attribute source definition is assigned as a value to each key. diff --git a/docs/reference-guides/block-api/block-deprecation.md b/docs/reference-guides/block-api/block-deprecation.md index f998a428857d3..e15f1a76cde0d 100644 --- a/docs/reference-guides/block-api/block-deprecation.md +++ b/docs/reference-guides/block-api/block-deprecation.md @@ -37,9 +37,9 @@ It is also recommended to keep [fixtures](https://github.com/WordPress/gutenberg Deprecations are defined on a block type as its `deprecated` property, an array of deprecation objects where each object takes the form: -- `attributes` (Object): The [attributes definition](/docs/designers-developers/developers/block-api/block-attributes.md) of the deprecated form of the block. -- `supports` (Object): The [supports definition](/docs/designers-developers/developers/block-api/block-registration.md) of the deprecated form of the block. -- `save` (Function): The [save implementation](/docs/designers-developers/developers/block-api/block-edit-save.md) of the deprecated form of the block. +- `attributes` (Object): The [attributes definition](/docs/reference-guides/block-api/block-attributes.md) of the deprecated form of the block. +- `supports` (Object): The [supports definition](/docs/reference-guides/block-api/block-registration.md) of the deprecated form of the block. +- `save` (Function): The [save implementation](/docs/reference-guides/block-api/block-edit-save.md) of the deprecated form of the block. - `migrate` (Function, Optional): A function which, given the old attributes and inner blocks is expected to return either the new attributes or a tuple array of `[ attributes, innerBlocks ]` compatible with the block. As mentioned above, a deprecation's `migrate` will not be run if its `save` function does not return a valid block so you will need to make sure your migrations are available in all the deprecations where they are relevant. - `isEligible` (Function, Optional): A function which, given the attributes and inner blocks of the parsed block, returns true if the deprecation can handle the block migration even if the block is valid. This is particularly useful in cases where a block is technically valid even once deprecated, and requires updates to its attributes or inner blocks. This function is not called when the results of all previous deprecations' `save` functions were invalid. diff --git a/docs/reference-guides/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md index a1a3765996390..17dbd38cbff41 100644 --- a/docs/reference-guides/block-api/block-edit-save.md +++ b/docs/reference-guides/block-api/block-edit-save.md @@ -92,7 +92,7 @@ var blockSettings = { The `edit` function also receives a number of properties through an object argument. You can use these properties to adapt the behavior of your block. -The `attributes` property surfaces all the available attributes and their corresponding values, as described by the `attributes` property when the block type was registered. See [attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for how to specify attribute sources. +The `attributes` property surfaces all the available attributes and their corresponding values, as described by the `attributes` property when the block type was registered. See [attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for how to specify attribute sources. In this case, assuming we had defined an attribute of `content` during block registration, we would receive and use that value in our edit function: @@ -285,10 +285,10 @@ _Note:_ The save function should be a pure function that depends only on the att It can not have any side effect or retrieve information from another source, e.g. it is not possible to use the data module inside it `select( store ).selector( ... )`. This is because if the external information changes, the block may be flagged as invalid when the post is later edited ([read more about Validation](#validation)). If there is a need to have other information as part of the save, developers can consider one of these two alternatives: - - Use [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. + - Use [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. - Store the external value as an attribute which is dynamically updated in the block's `edit` function as changes occur. -For [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. +For [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. If left unspecified, the default implementation will save no markup in post content for the dynamic block, instead deferring this to always be calculated when the block is shown on the front of the site. @@ -324,11 +324,11 @@ save: function( props ) { {% end %} -When saving your block, you want to save the attributes in the same format specified by the attribute source definition. If no attribute source is specified, the attribute will be saved to the block's comment delimiter. See the [Block Attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for more details. +When saving your block, you want to save the attributes in the same format specified by the attribute source definition. If no attribute source is specified, the attribute will be saved to the block's comment delimiter. See the [Block Attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for more details. ## Examples -Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. +Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. ### Saving Attributes to Child Elements @@ -504,10 +504,10 @@ The two most common sources of block invalidations are: Before starting to debug, be sure to familiarize yourself with the validation step described above documenting the process for detecting whether a block is invalid. A block is invalid if its regenerated markup does not match what is saved in post content, so often this can be caused by the attributes of a block being parsed incorrectly from the saved content. -If you're using [attribute sources](/docs/designers-developers/developers/block-api/block-attributes.md), be sure that attributes sourced from markup are saved exactly as you expect, and in the correct type (usually a `'string'` or `'number'`). +If you're using [attribute sources](/docs/reference-guides/block-api/block-attributes.md), be sure that attributes sourced from markup are saved exactly as you expect, and in the correct type (usually a `'string'` or `'number'`). When a block is detected as invalid, a warning will be logged into your browser's developer tools console. The warning will include specific details about the exact point at which a difference in markup occurred. Be sure to look closely at any differences in the expected and actual markups to see where problems are occurring. **I've changed my block's `save` behavior and old content now includes invalid blocks. How can I fix this?** -Refer to the guide on [Deprecated Blocks](/docs/designers-developers/developers/block-api/block-deprecation.md) to learn more about how to accommodate legacy content in intentional markup changes. +Refer to the guide on [Deprecated Blocks](/docs/reference-guides/block-api/block-deprecation.md) to learn more about how to accommodate legacy content in intentional markup changes. diff --git a/docs/reference-guides/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md index 182283fdaa1a9..a3c115f23773b 100644 --- a/docs/reference-guides/block-api/block-metadata.md +++ b/docs/reference-guides/block-api/block-metadata.md @@ -50,7 +50,7 @@ To register a new block type using metadata that can be shared between codebase } ``` -The same file is also used when [submitting block to Block Directory](/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md). +The same file is also used when [submitting block to Block Directory](/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md). ## Server-side registration @@ -130,7 +130,7 @@ The core provided categories are: - widgets - embed -Plugins and Themes can also register [custom block categories](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). +Plugins and Themes can also register [custom block categories](/docs/reference-guides/filters/block-filters.md#managing-block-categories). An implementation should expect and tolerate unknown categories, providing some reasonable fallback behavior (e.g. a "text" category). @@ -232,7 +232,7 @@ The [gettext](https://www.gnu.org/software/gettext/) text domain of the plugin/b Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface. -See the [the attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for more details. +See the [the attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for more details. ### Provides Context @@ -244,7 +244,7 @@ See the [the attributes documentation](/docs/designers-developers/developers/blo Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block's own attribute. -See [the block context documentation](/docs/designers-developers/developers/block-api/block-context.md) for more details. +See [the block context documentation](/docs/reference-guides/block-api/block-context.md) for more details. ```json { @@ -264,7 +264,7 @@ See [the block context documentation](/docs/designers-developers/developers/bloc Array of the names of context values to inherit from an ancestor provider. -See [the block context documentation](/docs/designers-developers/developers/block-api/block-context.md) for more details. +See [the block context documentation](/docs/reference-guides/block-api/block-context.md) for more details. ```json { @@ -280,7 +280,7 @@ See [the block context documentation](/docs/designers-developers/developers/bloc - Property: `supports` - Default: `{}` -It contains as set of options to control features used in the editor. See the [the supports documentation](/docs/designers-developers/developers/block-api/block-supports.md) for more details. +It contains as set of options to control features used in the editor. See the [the supports documentation](/docs/reference-guides/block-api/block-supports.md) for more details. ### Style Variations @@ -301,7 +301,7 @@ It contains as set of options to control features used in the editor. See the [t Block styles can be used to provide alternative styles to block. It works by adding a class name to the block's wrapper. Using CSS, a theme developer can target the class name for the style variation if it is selected. -Plugins and Themes can also register [custom block style](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) for existing blocks. +Plugins and Themes can also register [custom block style](/docs/reference-guides/filters/block-filters.md#block-style-variations) for existing blocks. ### Example @@ -322,7 +322,7 @@ Plugins and Themes can also register [custom block style](/docs/designers-develo It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block. -See the [the example documentation](/docs/designers-developers/developers/block-api/block-registration.md#example-optional) for more details. +See the [the example documentation](/docs/reference-guides/block-api/block-registration.md#example-optional) for more details. ### Editor Script @@ -471,10 +471,10 @@ Once all details are ready, Core Blocks will be migrated iteratively and third-p The following properties are going to be supported for backward compatibility reasons on the client-side only. Some of them might be replaced with alternative APIs in the future: -- `edit` - see the [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) documentation for more details. -- `save` - see the [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) documentation for more details. -- `transforms` - see the [Transforms](/docs/designers-developers/developers/block-api/block-registration.md#transforms-optional) documentation for more details. -- `deprecated` - see the [Deprecated Blocks](/docs/designers-developers/developers/block-api/block-deprecation.md) documentation for more details. +- `edit` - see the [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) documentation for more details. +- `save` - see the [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) documentation for more details. +- `transforms` - see the [Transforms](/docs/reference-guides/block-api/block-registration.md#transforms-optional) documentation for more details. +- `deprecated` - see the [Deprecated Blocks](/docs/reference-guides/block-api/block-deprecation.md) documentation for more details. - `merge` - undocumented as of today. Its role is to handle merging multiple blocks into one. - `getEditWrapperProps` - undocumented as well. Its role is to inject additional props to the block edit's component wrapper. @@ -494,4 +494,4 @@ wp.blocks.registerBlockType( 'my-block/name', { } ); ``` -In the case of [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. +In the case of [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. diff --git a/docs/reference-guides/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md index cc184fbf945b0..ffebee4a48800 100644 --- a/docs/reference-guides/block-api/block-registration.md +++ b/docs/reference-guides/block-api/block-registration.md @@ -67,7 +67,7 @@ The core provided categories are: category: 'widgets', ``` -Plugins and Themes can also register [custom block categories](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). +Plugins and Themes can also register [custom block categories](/docs/reference-guides/filters/block-filters.md#managing-block-categories). #### icon (optional) @@ -138,7 +138,7 @@ styles: [ ], ``` -Plugins and Themes can also register [custom block style](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) for existing blocks. +Plugins and Themes can also register [custom block style](/docs/reference-guides/filters/block-filters.md#block-style-variations) for existing blocks. #### attributes (optional) @@ -166,7 +166,7 @@ attributes: { }, ``` -- **See: [Attributes](/docs/designers-developers/developers/block-api/block-attributes.md).** +- **See: [Attributes](/docs/reference-guides/block-api/block-attributes.md).** #### example (optional) @@ -292,13 +292,13 @@ variations: [ - **_Type:_** `Object` -Supports contains as set of options to control features used in the editor. See the [the supports documentation](/docs/designers-developers/developers/block-api/block-supports.md) for more details. +Supports contains as set of options to control features used in the editor. See the [the supports documentation](/docs/reference-guides/block-api/block-supports.md) for more details. #### transforms (optional) - **Type:** `Object` -Transforms provide rules for what a block can be transformed from and what it can be transformed to. A block can be transformed from another block, a shortcode, a regular expression, a file or a raw DOM node. Take a look at the [Block Transforms API](/docs/designers-developers/developers/block-api/block-transforms.md) for more info about each available transformation. +Transforms provide rules for what a block can be transformed from and what it can be transformed to. A block can be transformed from another block, a shortcode, a regular expression, a file or a raw DOM node. Take a look at the [Block Transforms API](/docs/reference-guides/block-api/block-transforms.md) for more info about each available transformation. #### parent (optional) diff --git a/docs/reference-guides/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md index dd53f61342178..0a2e36c36cf17 100644 --- a/docs/reference-guides/block-api/block-supports.md +++ b/docs/reference-guides/block-api/block-supports.md @@ -57,7 +57,7 @@ attributes: { - Type: `boolean` - Default value: `true` -This property allows to enable [wide alignment](/docs/designers-developers/developers/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. +This property allows to enable [wide alignment](/docs/howto-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. ```js supports: { @@ -271,7 +271,7 @@ supports: { - Type: `boolean` - Default value: `false` -This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/designers-developers/developers/themes/theme-support.md#supporting-custom-line-heights). +This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/howto-guides/themes/theme-support.md#supporting-custom-line-heights). ```js supports: { @@ -330,7 +330,7 @@ supports: { - Subproperties: - `padding`: type `boolean`, default value `false` -This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/designers-developers/developers/themes/theme-support.md##cover-block-padding). +This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/howto-guides/themes/theme-support.md##cover-block-padding). ```js supports: { diff --git a/docs/reference-guides/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md index dc456d5dc3c19..1ebd48e76bf50 100644 --- a/docs/reference-guides/block-api/block-templates.md +++ b/docs/reference-guides/block-api/block-templates.md @@ -59,7 +59,7 @@ registerBlockType( 'myplugin/template', { }); ``` -See the [Meta Block Tutorial](/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md) for a full example of a template in use. +See the [Meta Block Tutorial](/docs/howto-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. ## Custom Post types diff --git a/docs/reference-guides/data/README.md b/docs/reference-guides/data/README.md index 7408d171144cf..d03590a09dcc8 100644 --- a/docs/reference-guides/data/README.md +++ b/docs/reference-guides/data/README.md @@ -1,11 +1,11 @@ # Data Module Reference - - [**core**: WordPress Core Data](/docs/designers-developers/developers/data/data-core.md) - - [**core/annotations**: Annotations](/docs/designers-developers/developers/data/data-core-annotations.md) - - [**core/blocks**: Block Types Data](/docs/designers-developers/developers/data/data-core-blocks.md) - - [**core/block-editor**: The Block Editor’s Data](/docs/designers-developers/developers/data/data-core-block-editor.md) - - [**core/editor**: The Post Editor’s Data](/docs/designers-developers/developers/data/data-core-editor.md) - - [**core/edit-post**: The Editor’s UI Data](/docs/designers-developers/developers/data/data-core-edit-post.md) - - [**core/notices**: Notices Data](/docs/designers-developers/developers/data/data-core-notices.md) - - [**core/nux**: The NUX (New User Experience) Data](/docs/designers-developers/developers/data/data-core-nux.md) - - [**core/viewport**: The Viewport Data](/docs/designers-developers/developers/data/data-core-viewport.md) \ No newline at end of file + - [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) + - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) + - [**core/blocks**: Block Types Data](/docs/reference-guides/data/data-core-blocks.md) + - [**core/block-editor**: The Block Editor’s Data](/docs/reference-guides/data/data-core-block-editor.md) + - [**core/editor**: The Post Editor’s Data](/docs/reference-guides/data/data-core-editor.md) + - [**core/edit-post**: The Editor’s UI Data](/docs/reference-guides/data/data-core-edit-post.md) + - [**core/notices**: Notices Data](/docs/reference-guides/data/data-core-notices.md) + - [**core/nux**: The NUX (New User Experience) Data](/docs/reference-guides/data/data-core-nux.md) + - [**core/viewport**: The Viewport Data](/docs/reference-guides/data/data-core-viewport.md) \ No newline at end of file diff --git a/docs/reference-guides/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md index da02d5f550b66..05390c7a816a2 100644 --- a/docs/reference-guides/filters/block-filters.md +++ b/docs/reference-guides/filters/block-filters.md @@ -4,7 +4,7 @@ To modify the behavior of existing blocks, WordPress exposes several APIs: ### Block Style Variations -Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/) for a full example. +Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/) for a full example. _Example:_ @@ -178,7 +178,7 @@ wp.hooks.addFilter( ); ``` -_Note:_ A [block validation](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content output by the `save()` function. +_Note:_ A [block validation](/docs/reference-guides/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content output by the `save()` function. To avoid this validation error, use `render_block` server-side to modify existing post content instead of this filter. See [render_block documentation](https://developer.wordpress.org/reference/hooks/render_block/). diff --git a/docs/reference-guides/slotfills/README.md b/docs/reference-guides/slotfills/README.md index c01ff23c948f7..da88e6cb7661e 100644 --- a/docs/reference-guides/slotfills/README.md +++ b/docs/reference-guides/slotfills/README.md @@ -97,12 +97,12 @@ const PostStatus = ( { isOpened, onTogglePanel } ) => ( The following SlotFills are available in the `edit-post` package. Please refer to the individual items below for usage and example details: -* [MainDashboardButton](/docs/designers-developers/developers/slotfills/main-dashboard-button.md) -* [PluginBlockSettingsMenuItem](/docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md) -* [PluginDocumentSettingPanel](/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md) -* [PluginMoreMenuItem](/docs/designers-developers/developers/slotfills/plugin-more-menu-item.md) -* [PluginPostPublishPanel](/docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md) -* [PluginPostStatusInfo](/docs/designers-developers/developers/slotfills/plugin-post-status-info.md) -* [PluginPrePublishPanel](/docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md) -* [PluginSidebar](/docs/designers-developers/developers/slotfills/plugin-sidebar.md) -* [PluginSidebarMoreMenuItem](/docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md) +* [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) +* [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) +* [PluginDocumentSettingPanel](/docs/reference-guides/slotfills/plugin-document-setting-panel.md) +* [PluginMoreMenuItem](/docs/reference-guides/slotfills/plugin-more-menu-item.md) +* [PluginPostPublishPanel](/docs/reference-guides/slotfills/plugin-post-publish-panel.md) +* [PluginPostStatusInfo](/docs/reference-guides/slotfills/plugin-post-status-info.md) +* [PluginPrePublishPanel](/docs/reference-guides/slotfills/plugin-pre-publish-panel.md) +* [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) +* [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) From fa812c369811847e5347722fc57cad90caa4039b Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:02:22 +0100 Subject: [PATCH 14/68] Update links for contributor section --- docs/contributors/accessibility-testing.md | 2 +- docs/contributors/code/coding-guidelines.md | 6 +++--- docs/contributors/code/develop.md | 14 +++++++------- docs/contributors/code/git-workflow.md | 2 +- docs/contributors/code/native-mobile.md | 6 +++--- docs/contributors/code/testing-overview.md | 8 ++++---- docs/contributors/design/reference.md | 4 ++-- docs/contributors/documentation/document.md | 4 ++-- docs/contributors/repository-management.md | 2 +- .../architecture/automated-testing.md | 2 +- docs/getting-started/architecture/performance.md | 2 +- docs/getting-started/tutorials/devenv/README.md | 2 +- docs/howto-guides/javascript/js-build-setup.md | 2 +- docs/manifest.json | 6 ++++++ docs/toc.json | 1 + 15 files changed, 35 insertions(+), 28 deletions(-) diff --git a/docs/contributors/accessibility-testing.md b/docs/contributors/accessibility-testing.md index 2db10c43c128c..03d35765087fb 100644 --- a/docs/contributors/accessibility-testing.md +++ b/docs/contributors/accessibility-testing.md @@ -4,7 +4,7 @@ This is a guide on how to test accessibility on Gutenberg. This is a living docu ## Getting Started -Make sure you have set up your local environment following the instructions on [Getting Started](/docs/contributors/getting-started.md). +Make sure you have set up your local environment following the instructions on [Getting Started](/docs/contributors/code/getting-started.md). ## Keyboard Testing diff --git a/docs/contributors/code/coding-guidelines.md b/docs/contributors/code/coding-guidelines.md index bf2f24ca816b2..70959b81aad42 100644 --- a/docs/contributors/code/coding-guidelines.md +++ b/docs/contributors/code/coding-guidelines.md @@ -220,7 +220,7 @@ It is preferred to implement all components as [function components](https://rea ## JavaScript Documentation using JSDoc -Gutenberg follows the [WordPress JavaScript Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/), with additional guidelines relevant for its distinct use of [import semantics](/docs/contributors/coding-guidelines.md#imports) in organizing files, the [use of TypeScript tooling](/docs/contributors/testing-overview.md#javascript-testing) for types validation, and automated documentation generation using [`@wordpress/docgen`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/docgen). +Gutenberg follows the [WordPress JavaScript Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/), with additional guidelines relevant for its distinct use of [import semantics](/docs/contributors/code/coding-guidelines.md#imports) in organizing files, the [use of TypeScript tooling](/docs/contributors/code/testing-overview.md#javascript-testing) for types validation, and automated documentation generation using [`@wordpress/docgen`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/docgen). For additional guidance, consult the following resources: @@ -266,7 +266,7 @@ Note the use of quotes when defining a set of string literals. As in the [JavaSc Use the [TypeScript `import` function](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#import-types) to import type declarations from other files or third-party dependencies. -Since an imported type declaration can occupy an excess of the available line length and become verbose when referenced multiple times, you are encouraged to create an alias of the external type using a `@typedef` declaration at the top of the file, immediately following [the `import` groupings](/docs/contributors/coding-guidelines.md#imports). +Since an imported type declaration can occupy an excess of the available line length and become verbose when referenced multiple times, you are encouraged to create an alias of the external type using a `@typedef` declaration at the top of the file, immediately following [the `import` groupings](/docs/contributors/code/coding-guidelines.md#imports). ```js /** @typedef {import('@wordpress/data').WPDataRegistry} WPDataRegistry */ @@ -472,6 +472,6 @@ For class components, there is no recommendation for documenting the props of th We use [`phpcs` (PHP_CodeSniffer)](https://github.com/squizlabs/PHP_CodeSniffer) with the [WordPress Coding Standards ruleset](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) to run a lot of automated checks against all PHP code in this project. This ensures that we are consistent with WordPress PHP coding standards. -The easiest way to use PHPCS is [local environment](/docs/contributors/getting-started.md#local-environment). Once that's installed, you can check your PHP by running `npm run lint-php`. +The easiest way to use PHPCS is [local environment](/docs/contributors/code/getting-started.md#local-environment). Once that's installed, you can check your PHP by running `npm run lint-php`. If you prefer to install PHPCS locally, you should use `composer`. [Install `composer`](https://getcomposer.org/download/) on your computer, then run `composer install`. This will install `phpcs` and `WordPress-Coding-Standards` which you can then run via `composer lint`. diff --git a/docs/contributors/code/develop.md b/docs/contributors/code/develop.md index d606b1d88b995..ae1d8df2d69fc 100644 --- a/docs/contributors/code/develop.md +++ b/docs/contributors/code/develop.md @@ -16,11 +16,11 @@ Browse [the issues list](https://github.com/wordpress/gutenberg/issues) to find ## Contributor Resources -* [Getting Started](/docs/contributors/getting-started.md) documents getting your development environment setup, this includes your test site and developer tools suggestions. -* [Git Workflow](/docs/contributors/git-workflow.md) documents the git process for deploying changes using pull requests. -* [Coding Guidelines](/docs/contributors/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. -* [Testing Overview](/docs/contributors/testing-overview.md) for PHP and JavaScript development in Gutenberg. +* [Getting Started](/docs/contributors/code/getting-started.md) documents getting your development environment setup, this includes your test site and developer tools suggestions. +* [Git Workflow](/docs/contributors/code/git-workflow.md) documents the git process for deploying changes using pull requests. +* [Coding Guidelines](/docs/contributors/code/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. +* [Testing Overview](/docs/contributors/code/testing-overview.md) for PHP and JavaScript development in Gutenberg. * [Accessibility Testing](/docs/contributors/accessibility-testing.md) documents the process of testing accessibility in Gutenberg. -* [Managing Packages](/docs/contributors/managing-packages.md) documents the process for managing the npm packages. -* [Gutenberg Release Process](/docs/contributors/release.md) - a checklist for the different types of releases for the Gutenberg project. -* [React Native mobile Gutenberg](/docs/contributors/native-mobile.md) - a guide on the React Native based mobile Gutenberg editor. +* [Managing Packages](/docs/contributors/code/managing-packages.md) documents the process for managing the npm packages. +* [Gutenberg Release Process](/docs/contributors/code/release.md) - a checklist for the different types of releases for the Gutenberg project. +* [React Native mobile Gutenberg](/docs/contributors/code/native-mobile.md) - a guide on the React Native based mobile Gutenberg editor. diff --git a/docs/contributors/code/git-workflow.md b/docs/contributors/code/git-workflow.md index abf66ea8536be..024a42de0c1e2 100644 --- a/docs/contributors/code/git-workflow.md +++ b/docs/contributors/code/git-workflow.md @@ -49,7 +49,7 @@ This will create a directory called `gutenberg` with all the files for the proje git switch -c update/my-branch ``` -**Step 4**: Make the code changes. Build, confirm, and test your change thoroughly. See [coding guidelines](/docs/contributors/coding-guidelines.md) and [testing overview](/docs/contributors/testing-overview.md) for guidance. +**Step 4**: Make the code changes. Build, confirm, and test your change thoroughly. See [coding guidelines](/docs/contributors/code/coding-guidelines.md) and [testing overview](/docs/contributors/code/testing-overview.md) for guidance. **Step 5**: Commit your change with a [good commit message](https://make.wordpress.org/core/handbook/best-practices/commit-messages/). This will commit your change to your local copy of the repository. diff --git a/docs/contributors/code/native-mobile.md b/docs/contributors/code/native-mobile.md index 4f1bc73ad3433..e62ba1254d32e 100644 --- a/docs/contributors/code/native-mobile.md +++ b/docs/contributors/code/native-mobile.md @@ -4,7 +4,7 @@ Intertwined with the web codepaths, the Gutenberg repo also includes the [React ## Running Gutenberg Mobile on Android and iOS -For instructions on how to run the **Gutenberg Mobile Demo App** on Android or iOS, see [Getting Started for the React Native based Mobile Gutenberg](/docs/contributors/getting-started-native-mobile.md) +For instructions on how to run the **Gutenberg Mobile Demo App** on Android or iOS, see [Getting Started for the React Native based Mobile Gutenberg](/docs/contributors/code/getting-started-native-mobile.md) Also, the mobile client is packaged and released via the [official WordPress apps](https://wordpress.org/mobile/). Even though the build pipeline is slightly different then the mobile demo apps and lives in its own repo for now ([here's the native mobile repo](https://github.com/wordpress-mobile/gutenberg-mobile)), the source code itself is taken directly from this repo and the "web" side codepaths. @@ -21,11 +21,11 @@ Our tooling isn't as good yet as we'd like to and it's hard to have a good aware If you encounter a failed Android/iOS test on your pull request, we recommend the following steps: 1. Re-running the failed GitHub Action job ([guide for how to re-run](https://docs.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#viewing-your-workflow-history)) - This should fix failed tests the majority of the time. Cases where you need to re-run tests for a pass should go down in the near future as flakiness in tests is actively being worked on. See the following GitHub issue for updated info on known failures: https://github.com/WordPress/gutenberg/issues/23949 -2. You can check if the test is failing locally by following the steps to run the E2E test on your machine from the [mobile getting started guide](/docs/contributors/getting-started-native-mobile.md#ui-tests), with even more relevant info in the [relevant directory README.md](https://github.com/WordPress/gutenberg/tree/HEAD/packages/react-native-editor/__device-tests__#running-the-tests-locally) +2. You can check if the test is failing locally by following the steps to run the E2E test on your machine from the [mobile getting started guide](/docs/contributors/code/getting-started-native-mobile.md#ui-tests), with even more relevant info in the [relevant directory README.md](https://github.com/WordPress/gutenberg/tree/HEAD/packages/react-native-editor/__device-tests__#running-the-tests-locally) 3. In addition to reading the logs from the E2E test, you can download a video recording from the Artifacts section of the GitHub job that may have additional useful information. 4. Check if any changes in your PR would require corresponding changes to `.native.js` versions of files. 5. Lastly, if you're stuck on a failing mobile test, feel free to reach out to contributors on Slack in the #mobile or #core-editor chats in the WordPress Core Slack, [free to join](https://make.wordpress.org/chat/). ## Debugging the native mobile unit tests -Follow the instructions in [Native mobile testing](/docs/contributors/testing-overview.md#native-mobile-testing) to locally debug the native mobile unit tests when needed. +Follow the instructions in [Native mobile testing](/docs/contributors/code/testing-overview.md#native-mobile-testing) to locally debug the native mobile unit tests when needed. diff --git a/docs/contributors/code/testing-overview.md b/docs/contributors/code/testing-overview.md index 83eb76e6e5a18..e923a41954d9c 100644 --- a/docs/contributors/code/testing-overview.md +++ b/docs/contributors/code/testing-overview.md @@ -23,7 +23,7 @@ Tests for JavaScript use [Jest](https://jestjs.io/) as the test runner and its A It should be noted that in the past, React components were unit tested with [Enzyme](https://github.com/airbnb/enzyme). However, for new tests, it is preferred to use React Testing Library (RTL) and over time old tests should be refactored to use RTL too (typically when working on code that touches an old test). -Assuming you've followed the [instructions](/docs/contributors/getting-started.md) to install Node and project dependencies, tests can be run from the command-line with NPM: +Assuming you've followed the [instructions](/docs/contributors/code/getting-started.md) to install Node and project dependencies, tests can be run from the command-line with NPM: ``` npm test @@ -31,7 +31,7 @@ npm test Linting is static code analysis used to enforce coding standards and to avoid potential errors. This project uses [ESLint](http://eslint.org/) and [TypeScript's JavaScript type-checking](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html) to capture these issues. While the above `npm test` will execute both unit tests and code linting, code linting can be verified independently by running `npm run lint`. Some JavaScript issues can be fixed automatically by running `npm run lint-js:fix`. -To improve your developer workflow, you should setup an editor linting integration. See the [getting started documentation](/docs/contributors/getting-started.md) for additional information. +To improve your developer workflow, you should setup an editor linting integration. See the [getting started documentation](/docs/contributors/code/getting-started.md) for additional information. To run unit tests only, without the linter, use `npm run test-unit` instead. @@ -386,7 +386,7 @@ Contributors to Gutenberg will note that PRs include continuous integration E2E End-to-end tests use [Puppeteer](https://github.com/puppeteer/puppeteer) as a headless Chromium driver, and are otherwise still run by a [Jest](https://jestjs.io/) test runner. -If you're using the built-in [local environment](/docs/contributors/getting-started.md#local-environment), you can run the e2e tests locally using this command: +If you're using the built-in [local environment](/docs/contributors/code/getting-started.md#local-environment), you can run the e2e tests locally using this command: ```bash npm run test-e2e @@ -454,7 +454,7 @@ Every core block is required to have at least one set of fixture files for its m ## PHP Testing -Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. If you're using the built-in [local environment](/docs/contributors/getting-started.md#local-environment), you can run the PHP tests locally using this command: +Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. If you're using the built-in [local environment](/docs/contributors/code/getting-started.md#local-environment), you can run the PHP tests locally using this command: ```bash npm run test-php diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 9a4e6944aef83..281961bda5c7f 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -1,8 +1,8 @@ # Reference - [Glossary](/docs/getting-started/glossary.md) -- [Coding Guidelines](/docs/contributors/coding-guidelines.md) -- [Testing Overview](/docs/contributors/testing-overview.md) +- [Coding Guidelines](/docs/contributors/code/coding-guidelines.md) +- [Testing Overview](/docs/contributors/code/testing-overview.md) - [Frequently Asked Questions](/docs/getting-started/faq.md) ## Logo diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index a9d85c6679daa..781dcd2fa49be 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -25,7 +25,7 @@ The Block Editor Handbook is a mix of markdown files in the `/docs/` directory o An automated job publishes the docs every 15 minutes to the [Block Editor Handbook site](https://developer.wordpress.org/block-editor/). -See [the Git Workflow](/docs/contributors/git-workflow.md) documentation for how to use git to deploy changes using pull requests. Additionally, see the [video walk-through](https://wordpress.tv/2020/09/02/marcus-kazmierczak-contribute-developer-documentation-to-gutenberg/) and the accompanying [slides for contributing documentation to Gutenberg](https://mkaz.blog/wordpress/contribute-documentation-to-gutenberg/). +See [the Git Workflow](/docs/contributors/code/git-workflow.md) documentation for how to use git to deploy changes using pull requests. Additionally, see the [video walk-through](https://wordpress.tv/2020/09/02/marcus-kazmierczak-contribute-developer-documentation-to-gutenberg/) and the accompanying [slides for contributing documentation to Gutenberg](https://mkaz.blog/wordpress/contribute-documentation-to-gutenberg/). ### Update a Document @@ -96,7 +96,7 @@ The preferred format for code examples is ESNext, this should be the default vie ### Editor Config -You should configure your editor to use Prettier to auto-format markdown documents. See the [Getting Started documentation](/docs/contributors/develop/getting-started.md) for complete details. +You should configure your editor to use Prettier to auto-format markdown documents. See the [Getting Started documentation](/docs/contributors/code/getting-started.md) for complete details. An example config for using Visual Studio Code and the Prettier extensions: diff --git a/docs/contributors/repository-management.md b/docs/contributors/repository-management.md index 609b194453b00..65bb58288d39b 100644 --- a/docs/contributors/repository-management.md +++ b/docs/contributors/repository-management.md @@ -123,7 +123,7 @@ A pull request can generally be merged once it is: - Vetted against all potential edge cases. - Changelog entries were properly added. - Reviewed by someone other than the original author. -- [Rebased](/docs/contributors/git-workflow.md#keeping-your-branch-up-to-date) onto the latest version of the master branch. +- [Rebased](/docs/contributors/code/git-workflow.md#keeping-your-branch-up-to-date) onto the latest version of the master branch. The final pull request merge decision is made by the **@wordpress/gutenberg-core** team. diff --git a/docs/getting-started/architecture/automated-testing.md b/docs/getting-started/architecture/automated-testing.md index 4ca6555c8fbfb..42dfd28a571b0 100644 --- a/docs/getting-started/architecture/automated-testing.md +++ b/docs/getting-started/architecture/automated-testing.md @@ -13,7 +13,7 @@ These include: For more context, refer to the following resources: -- [Testing Overview: End-to-End Testing](/docs/contributors/testing-overview.md#end-to-end-testing) +- [Testing Overview: End-to-End Testing](/docs/contributors/code/testing-overview.md#end-to-end-testing) - [Testing: Experiment with Puppeteer for E2E testing](https://github.com/WordPress/gutenberg/pull/5618) - In early iterations, the contributing team opted to use Cypress for end-to-end testing. This pull request outlines problems with the approach, and proposed the initial transition to Puppeteer. - [JavaScript Chat Summary: January 28, 2020](https://make.wordpress.org/core/2020/02/04/javascript-chat-summary-january-28-2020/) diff --git a/docs/getting-started/architecture/performance.md b/docs/getting-started/architecture/performance.md index e4473b2350f1f..a886beaf73850 100644 --- a/docs/getting-started/architecture/performance.md +++ b/docs/getting-started/architecture/performance.md @@ -4,7 +4,7 @@ Performance is a key feature for editor applications and the Block editor is not ## Metrics -To ensure the block editor stays performant across releases and development, we monitor some key metrics using [performance testing](/docs/contributors/testing-overview.md#performance-testing). +To ensure the block editor stays performant across releases and development, we monitor some key metrics using [performance testing](/docs/contributors/code/testing-overview.md#performance-testing). **Loading Time:** The time it takes to load an editor page. **Typing Time:** The time it takes for the browser to respond while typing on the editor. diff --git a/docs/getting-started/tutorials/devenv/README.md b/docs/getting-started/tutorials/devenv/README.md index 212c7f689cd58..05ae80c3da4fb 100644 --- a/docs/getting-started/tutorials/devenv/README.md +++ b/docs/getting-started/tutorials/devenv/README.md @@ -1,6 +1,6 @@ # Development Environment -This guide is for setting up your local environment for JavaScript development for creating plugins and tools to extend WordPress and the block editor. If you are looking to contribute to Gutenberg project itself, see additional documentation in the [Getting Started guide](/docs/contributors/getting-started.md). +This guide is for setting up your local environment for JavaScript development for creating plugins and tools to extend WordPress and the block editor. If you are looking to contribute to Gutenberg project itself, see additional documentation in the [Getting Started guide](/docs/contributors/code/getting-started.md). A development environment is a catch-all term for what you need setup on your computer to work. The three main pieces needed for our development environment are: diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md index 1c3e3f314dc3a..ddff1bb175888 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/howto-guides/javascript/js-build-setup.md @@ -4,7 +4,7 @@ ESNext is JavaScript written using syntax and features only available in a versi See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. -Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/getting-started.md) documentation. +Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/code/getting-started.md) documentation. Browsers cannot interpret or run ESNext and JSX syntaxes, so we must use a transformation step to convert these syntaxes to code that browsers can understand. diff --git a/docs/manifest.json b/docs/manifest.json index d929c5c1f0771..d30d078ac9560 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1847,6 +1847,12 @@ "markdown_source": "../docs/contributors/localizing.md", "parent": "contributors" }, + { + "title": "Accessibility Testing", + "slug": "accessibility-testing", + "markdown_source": "../docs/contributors/accessibility-testing.md", + "parent": "contributors" + }, { "title": "Repository Management", "slug": "repository-management", diff --git a/docs/toc.json b/docs/toc.json index 8dc2de711652a..db4be1003e5f6 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -165,6 +165,7 @@ ] }, { "docs/contributors/triage.md": [] }, { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, { "docs/contributors/repository-management.md": [] }, { "docs/contributors/folder-structure.md": [] }, { "docs/contributors/versions-in-wordpress.md": [] }, From 4312e07bce9e78213fb0907e20a9a6d3ce0647c7 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:12:34 +0100 Subject: [PATCH 15/68] Move architecture folder under explanation --- .../architecture/README.md | 0 .../architecture/automated-testing.md | 0 .../architecture/data-flow.md | 0 .../full-site-editing-templates.md | 0 .../architecture/key-concepts.md | 0 .../architecture/modularity.md | 0 .../architecture/performance.md | 0 docs/manifest.json | 76 +++++++++---------- docs/toc.json | 17 +++-- 9 files changed, 47 insertions(+), 46 deletions(-) rename docs/{getting-started => explanations}/architecture/README.md (100%) rename docs/{getting-started => explanations}/architecture/automated-testing.md (100%) rename docs/{getting-started => explanations}/architecture/data-flow.md (100%) rename docs/explanations/{ => architecture}/full-site-editing-templates.md (100%) rename docs/{getting-started => explanations}/architecture/key-concepts.md (100%) rename docs/{getting-started => explanations}/architecture/modularity.md (100%) rename docs/{getting-started => explanations}/architecture/performance.md (100%) diff --git a/docs/getting-started/architecture/README.md b/docs/explanations/architecture/README.md similarity index 100% rename from docs/getting-started/architecture/README.md rename to docs/explanations/architecture/README.md diff --git a/docs/getting-started/architecture/automated-testing.md b/docs/explanations/architecture/automated-testing.md similarity index 100% rename from docs/getting-started/architecture/automated-testing.md rename to docs/explanations/architecture/automated-testing.md diff --git a/docs/getting-started/architecture/data-flow.md b/docs/explanations/architecture/data-flow.md similarity index 100% rename from docs/getting-started/architecture/data-flow.md rename to docs/explanations/architecture/data-flow.md diff --git a/docs/explanations/full-site-editing-templates.md b/docs/explanations/architecture/full-site-editing-templates.md similarity index 100% rename from docs/explanations/full-site-editing-templates.md rename to docs/explanations/architecture/full-site-editing-templates.md diff --git a/docs/getting-started/architecture/key-concepts.md b/docs/explanations/architecture/key-concepts.md similarity index 100% rename from docs/getting-started/architecture/key-concepts.md rename to docs/explanations/architecture/key-concepts.md diff --git a/docs/getting-started/architecture/modularity.md b/docs/explanations/architecture/modularity.md similarity index 100% rename from docs/getting-started/architecture/modularity.md rename to docs/explanations/architecture/modularity.md diff --git a/docs/getting-started/architecture/performance.md b/docs/explanations/architecture/performance.md similarity index 100% rename from docs/getting-started/architecture/performance.md rename to docs/explanations/architecture/performance.md diff --git a/docs/manifest.json b/docs/manifest.json index d30d078ac9560..10f076a35e3dc 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -65,42 +65,6 @@ "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", "parent": "create-block" }, - { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/getting-started/architecture/README.md", - "parent": "getting-started" - }, - { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/getting-started/architecture/key-concepts.md", - "parent": "architecture" - }, - { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/getting-started/architecture/data-flow.md", - "parent": "architecture" - }, - { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/getting-started/architecture/modularity.md", - "parent": "architecture" - }, - { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/getting-started/architecture/performance.md", - "parent": "architecture" - }, - { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/getting-started/architecture/automated-testing.md", - "parent": "architecture" - }, { "title": "Glossary", "slug": "glossary", @@ -1727,11 +1691,47 @@ "markdown_source": "../docs/explanations/README.md", "parent": null }, + { + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/explanations/architecture/README.md", + "parent": "explanations" + }, + { + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/explanations/architecture/key-concepts.md", + "parent": "architecture" + }, + { + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/explanations/architecture/data-flow.md", + "parent": "architecture" + }, + { + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/explanations/architecture/modularity.md", + "parent": "architecture" + }, + { + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/explanations/architecture/performance.md", + "parent": "architecture" + }, + { + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/explanations/architecture/automated-testing.md", + "parent": "architecture" + }, { "title": "FullSiteEditingTemplates", "slug": "full-site-editing-templates", - "markdown_source": "../docs/explanations/full-site-editing-templates.md", - "parent": "explanations" + "markdown_source": "../docs/explanations/architecture/full-site-editing-templates.md", + "parent": "architecture" }, { "title": "Contributor Guide", diff --git a/docs/toc.json b/docs/toc.json index db4be1003e5f6..35ac7d3b29f72 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -13,13 +13,6 @@ { "docs/getting-started/tutorials/create-block/finishing.md": [] } ] } ] }, - { "docs/getting-started/architecture/README.md": [ - { "docs/getting-started/architecture/key-concepts.md": [] }, - { "docs/getting-started/architecture/data-flow.md": [] }, - { "docs/getting-started/architecture/modularity.md": [] }, - { "docs/getting-started/architecture/performance.md": [] }, - { "docs/getting-started/architecture/automated-testing.md": [] } - ] }, { "docs/getting-started/glossary.md": [] }, { "docs/getting-started/faq.md": [] }, { "docs/getting-started/history.md": [] }, @@ -141,7 +134,15 @@ ] } ] }, { "docs/explanations/README.md": [ - { "docs/explanations/full-site-editing-templates.md": [] } + + { "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] } ] }, { "docs/contributors/README.md": [ { "docs/contributors/code/develop.md": [ From 7f3604a3e608ffbb4b5fc17e9ba1b29ce430ff07 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:25:42 +0100 Subject: [PATCH 16/68] Replace occurence of howto-guides with how-to-guides --- docs/contributors/design/reference.md | 2 +- docs/contributors/documentation/document.md | 4 +- .../full-site-editing-templates.md | 2 +- .../explanations/architecture/key-concepts.md | 2 +- docs/getting-started/README.md | 6 +- docs/getting-started/faq.md | 2 +- docs/getting-started/tutorials/README.md | 12 +- .../tutorials/create-block/block-anatomy.md | 2 +- .../tutorials/create-block/finishing.md | 6 +- .../tutorials/create-block/wp-plugin.md | 4 +- .../{howto-guides => how-to-guides}/README.md | 6 +- .../accessibility.md | 0 .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin .../assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../js-tutorial-console-log-success.png | Bin .../js-tutorial-error-blocks-undefined.png | Bin ...in-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin .../assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin .../backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../backward-compatibility/meta-box.md | 2 +- .../block-based-themes/README.md | 14 +- .../block-based-themes-2-adding-blocks.md | 0 .../block-tutorial/README.md | 2 +- .../applying-styles-with-stylesheets.md | 0 .../block-controls-toolbar-and-sidebar.md | 0 .../block-tutorial/creating-dynamic-blocks.md | 2 +- .../generate-blocks-with-wp-cli.md | 0 ...roducing-attributes-and-editable-fields.md | 0 .../nested-blocks-inner-blocks.md | 0 .../writing-your-first-block-type.md | 2 +- .../designers/README.md | 0 .../designers/animation.md | 0 .../designers/assets/advanced-settings-do.png | Bin .../designers/assets/block-controls-do.png | Bin .../designers/assets/block-controls-dont.png | Bin .../assets/block-descriptions-do.png | Bin .../assets/block-descriptions-dont.png | Bin .../designers/assets/blocks-do.png | Bin .../designers/assets/blocks-dont.png | Bin .../designers/assets/placeholder-do.png | Bin .../designers/assets/placeholder-dont.png | Bin .../designers/block-design.md | 2 +- .../designers/design-resources.md | 0 .../designers/user-interface.md | 0 .../feature-flags.md | 0 .../format-api/1-register-format.md | 0 .../format-api/2-toolbar-button.md | 0 .../format-api/3-apply-format.md | 0 .../format-api/README.md | 8 +- .../internationalization.md | 0 .../javascript/README.md | 16 +- .../javascript/esnext-js.md | 0 .../javascript/extending-the-block-editor.md | 0 .../javascript/js-build-setup.md | 4 +- .../javascript/loading-javascript.md | 0 .../javascript/plugins-background.md | 0 .../javascript/scope-your-code.md | 0 .../javascript/troubleshooting.md | 4 +- .../javascript/versions-and-building.md | 4 +- .../metabox/README.md | 4 +- .../metabox/meta-block-1-intro.md | 10 +- .../metabox/meta-block-2-register-meta.md | 0 .../metabox/meta-block-3-add.md | 4 +- .../metabox/meta-block-4-use-data.md | 0 .../metabox/meta-block-5-finishing.md | 0 .../metabox/meta-block.png | Bin .../notices/README.md | 2 +- .../notices/block-editor-notice.png | Bin .../notices/classic-editor-notice.png | Bin .../platform/README.md | 0 .../platform/custom-block-editor/README.md | 0 .../platform/custom-block-editor/tutorial.md | 0 .../sidebar-tutorial/plugin-sidebar-0.md | 12 + .../plugin-sidebar-1-up-and-running.md | 0 .../plugin-sidebar-2-styles-and-controls.md | 0 .../plugin-sidebar-3-register-meta.md | 0 .../plugin-sidebar-4-initialize-input.md | 0 .../plugin-sidebar-5-update-meta.md | 0 .../plugin-sidebar-6-finishing-touches.md | 0 .../themes/README.md | 0 .../themes/block-based-themes.md | 4 +- .../themes/theme-json.md | 0 .../themes/theme-support.md | 2 +- .../sidebar-tutorial/plugin-sidebar-0.md | 12 - docs/manifest.json | 140 +++---- .../block-api/block-edit-save.md | 6 +- .../block-api/block-metadata.md | 2 +- .../block-api/block-supports.md | 6 +- .../block-api/block-templates.md | 2 +- .../reference-guides/filters/block-filters.md | 2 +- docs/toc.json | 392 ++++++++++-------- 104 files changed, 377 insertions(+), 331 deletions(-) rename docs/{howto-guides => how-to-guides}/README.md (88%) rename docs/{howto-guides => how-to-guides}/accessibility.md (100%) rename docs/{howto-guides => how-to-guides}/assets/fancy-quote-in-inspector.png (100%) rename docs/{howto-guides => how-to-guides}/assets/fancy-quote-with-style.png (100%) rename docs/{howto-guides => how-to-guides}/assets/inspector.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-console-log-error.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-console-log-success.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-more-menu-item.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-post-publish-panel.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-post-status-info-location.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-pre-publish-panel.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-closed-state.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-open-state.png (100%) rename docs/{howto-guides => how-to-guides}/assets/sidebar-style-and-controls.png (100%) rename docs/{howto-guides => how-to-guides}/assets/sidebar-up-and-running.png (100%) rename docs/{howto-guides => how-to-guides}/assets/toolbar-text.png (100%) rename docs/{howto-guides => how-to-guides}/assets/toolbar-with-custom-button.png (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/README.md (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/deprecations.md (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/meta-box.md (98%) rename docs/{howto-guides => how-to-guides}/block-based-themes/README.md (92%) rename docs/{howto-guides => how-to-guides}/block-based-themes/block-based-themes-2-adding-blocks.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/README.md (91%) rename docs/{howto-guides => how-to-guides}/block-tutorial/applying-styles-with-stylesheets.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/block-controls-toolbar-and-sidebar.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/creating-dynamic-blocks.md (97%) rename docs/{howto-guides => how-to-guides}/block-tutorial/generate-blocks-with-wp-cli.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/introducing-attributes-and-editable-fields.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/nested-blocks-inner-blocks.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/writing-your-first-block-type.md (98%) rename docs/{howto-guides => how-to-guides}/designers/README.md (100%) rename docs/{howto-guides => how-to-guides}/designers/animation.md (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/advanced-settings-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-controls-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-controls-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-descriptions-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-descriptions-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/blocks-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/blocks-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/placeholder-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/placeholder-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/block-design.md (98%) rename docs/{howto-guides => how-to-guides}/designers/design-resources.md (100%) rename docs/{howto-guides => how-to-guides}/designers/user-interface.md (100%) rename docs/{howto-guides => how-to-guides}/feature-flags.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/1-register-format.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/2-toolbar-button.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/3-apply-format.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/README.md (74%) rename docs/{howto-guides => how-to-guides}/internationalization.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/README.md (59%) rename docs/{howto-guides => how-to-guides}/javascript/esnext-js.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/extending-the-block-editor.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/js-build-setup.md (96%) rename docs/{howto-guides => how-to-guides}/javascript/loading-javascript.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/plugins-background.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/scope-your-code.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/troubleshooting.md (94%) rename docs/{howto-guides => how-to-guides}/javascript/versions-and-building.md (82%) rename docs/{howto-guides => how-to-guides}/metabox/README.md (83%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-1-intro.md (63%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-2-register-meta.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-3-add.md (91%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-4-use-data.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-5-finishing.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block.png (100%) rename docs/{howto-guides => how-to-guides}/notices/README.md (95%) rename docs/{howto-guides => how-to-guides}/notices/block-editor-notice.png (100%) rename docs/{howto-guides => how-to-guides}/notices/classic-editor-notice.png (100%) rename docs/{howto-guides => how-to-guides}/platform/README.md (100%) rename docs/{howto-guides => how-to-guides}/platform/custom-block-editor/README.md (100%) rename docs/{howto-guides => how-to-guides}/platform/custom-block-editor/tutorial.md (100%) create mode 100644 docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-1-up-and-running.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-3-register-meta.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-4-initialize-input.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-5-update-meta.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md (100%) rename docs/{howto-guides => how-to-guides}/themes/README.md (100%) rename docs/{howto-guides => how-to-guides}/themes/block-based-themes.md (96%) rename docs/{howto-guides => how-to-guides}/themes/theme-json.md (100%) rename docs/{howto-guides => how-to-guides}/themes/theme-support.md (99%) delete mode 100644 docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 281961bda5c7f..b3d589576c7b0 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -15,4 +15,4 @@ Released under GPL license, made by [Cristel Rossignol](https://twitter.com/cris ## Mockups -Mockup Sketch files are available in [the Design section](/docs/howto-guides/designers/design-resources.md). +Mockup Sketch files are available in [the Design section](/docs/how-to-guides/designers/design-resources.md). diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index 781dcd2fa49be..857b2487c6b48 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -39,7 +39,7 @@ To update an existing page: ### Create a New Document -To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/howto-guides/javascript/js-build-setup.md): +To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/how-to-guides/javascript/js-build-setup.md): 1. Create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/HEAD/docs) folder, use lower-case, no spaces, if needed a dash separator, and .md extension. 2. Add content, all documents require one and only H1 tag, using markdown notation. @@ -73,7 +73,7 @@ An example, the link to this page is: `/docs/contributors/document.md` The code example in markdown should be wrapped in three tick marks \`\`\` and should additionally include a language specifier. See this [GitHub documentation around fenced code blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). -A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). +A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). Here is an example `codetabs` section: diff --git a/docs/explanations/architecture/full-site-editing-templates.md b/docs/explanations/architecture/full-site-editing-templates.md index 4717eee4ecbe2..7c19996eaa699 100644 --- a/docs/explanations/architecture/full-site-editing-templates.md +++ b/docs/explanations/architecture/full-site-editing-templates.md @@ -2,7 +2,7 @@ > This is the documentation for the current implementation of the block-based templates and template parts themes. This is part of the Full Site Editing project. These features are still experimental in the plugin. “Experimental” means this is just an early implementation that is subject to potential drastic and breaking changes in iterations based on feedback from users, contributors, and theme authors. -This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/howto-guides/themes/block-based-themes.md). +This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/how-to-guides/themes/block-based-themes.md). ## Storage diff --git a/docs/explanations/architecture/key-concepts.md b/docs/explanations/architecture/key-concepts.md index 3ec6487b63794..080e2c5803f75 100644 --- a/docs/explanations/architecture/key-concepts.md +++ b/docs/explanations/architecture/key-concepts.md @@ -59,4 +59,4 @@ Note: custom post types can also be initialized with a starting `post_content` t ## Global Styles (in progress) -Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/howto-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. +Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/how-to-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 2d56c6e272d47..0f91f0036e907 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -26,15 +26,15 @@ The Editor offers rich new value to users with visual, drag-and-drop creation to ### Develop for the block editor -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/howto-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - [Gutenberg Architecture](/docs/architecture/readme.md) - [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) - [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/howto-guides/themes/readme.md) +- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) - [Block API Reference](/docs/reference-guides/block-api/readme.md) - [Block Editor Accessibility](/docs/reference-guides/accessibility.md) -- [Internationalization](/docs/howto-guides/internationalization.md) +- [Internationalization](/docs/how-to-guides/internationalization.md) ### Contribute to the block editor diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index cf0c5d2ce9aea..33742d31259e1 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -339,7 +339,7 @@ function gutenbergtheme_editor_styles() { add_action( 'enqueue_block_editor_assets', 'gutenbergtheme_editor_styles' ); ``` -*See:* [Editor Styles](/docs/howto-guides/themes/theme-support.md#editor-styles) +*See:* [Editor Styles](/docs/how-to-guides/themes/theme-support.md#editor-styles) ## Should I be concerned that Gutenberg will make my plugin obsolete? diff --git a/docs/getting-started/tutorials/README.md b/docs/getting-started/tutorials/README.md index b122cadc61a2b..57a4d2557461f 100644 --- a/docs/getting-started/tutorials/README.md +++ b/docs/getting-started/tutorials/README.md @@ -2,18 +2,18 @@ - First things first, see [setting up your development environment](/docs/getting-started/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. -- See the [Getting Started with JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. +- See the [Getting Started with JavaScript Tutorial](/docs/how-to-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. - Beginners: The [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. -- Intermediate: The [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. +- Intermediate: The [Block Tutorial](/docs/how-to-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. -- See the [Meta Boxes Tutorial](/docs/howto-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. +- See the [Meta Boxes Tutorial](/docs/how-to-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. -- Check out the [Notices Tutorial](/docs/howto-guides/notices/README.md) to learn how to display informational UI at the top of the editor. +- Check out the [Notices Tutorial](/docs/how-to-guides/notices/README.md) to learn how to display informational UI at the top of the editor. -- The [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. +- The [Sidebar Tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. -- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/howto-guides/format-api/). +- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/how-to-guides/format-api/). - Build your own [custom block editor instance](/docs/reference-guides/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. diff --git a/docs/getting-started/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md index 2a807b7356105..0e99d24a3c2c7 100644 --- a/docs/getting-started/tutorials/create-block/block-anatomy.md +++ b/docs/getting-started/tutorials/create-block/block-anatomy.md @@ -2,7 +2,7 @@ At its simplest, a block in the WordPress block editor is a JavaScript object with a specific set of properties. -**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. +**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. Here is the complete code for registering a block: diff --git a/docs/getting-started/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md index 1eda38da32078..1691547970414 100644 --- a/docs/getting-started/tutorials/create-block/finishing.md +++ b/docs/getting-started/tutorials/create-block/finishing.md @@ -12,11 +12,11 @@ You can visually browse the components and what their implementation looks like The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/reference-guides/richtext.md) for documentation using this component. -The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. +The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. -The [Sidebar tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. +The [Sidebar tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. -Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md). +Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md). ## How did they do that diff --git a/docs/getting-started/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md index a7a5687c23740..269ac279251e1 100644 --- a/docs/getting-started/tutorials/create-block/wp-plugin.md +++ b/docs/getting-started/tutorials/create-block/wp-plugin.md @@ -112,7 +112,7 @@ For the `editorScript` provided in the block metadata, the build process creates The `wp_register_script` function used internally registers a name, called the handle, and relates that name to the script file. The dependencies are used to specify if the script requires including other libraries. The version is specified so the browser will reload if the file changed. -The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/howto-guides/internationalization.md) +The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/how-to-guides/internationalization.md) With the above in place, create a new post to load the editor and check your plugin is in the inserter. You can use `/` to search, or click the box with the [+] and search for "Gutenpride" to find the block. @@ -124,7 +124,7 @@ To open the developer tools in Firefox, use the menu selecting Web Developer : T Try running `npm run start` that will start the watch process for automatic rebuilds. If you then make an update to `src/index.js` file, you will see the build run, and if you reload the WordPress editor you'll see the change. -For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/js-build-setup.md) in the Block Editor Handbook. +For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/how-to-guides/javascript/js-build-setup.md) in the Block Editor Handbook. ## Summary diff --git a/docs/howto-guides/README.md b/docs/how-to-guides/README.md similarity index 88% rename from docs/howto-guides/README.md rename to docs/how-to-guides/README.md index dbed9976d4c9e..fee7fdf2657bb 100644 --- a/docs/howto-guides/README.md +++ b/docs/how-to-guides/README.md @@ -4,7 +4,7 @@ The new editor is highly flexible, like most of WordPress. You can build custom ## Creating Blocks -The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. +The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. If you want to learn more about block creation, see the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for the best place to start. @@ -24,7 +24,7 @@ You can also filter certain aspects of the editor; this is documented on the [Ed ## Meta Boxes -Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/howto-guides/metabox/readme.md). +Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/how-to-guides/metabox/readme.md). See how the new editor [supports existing Meta Boxes](/docs/reference-guides/backward-compatibility/meta-box.md). @@ -32,7 +32,7 @@ See how the new editor [supports existing Meta Boxes](/docs/reference-guides/bac By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults. -There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/howto-guides/themes/theme-support.md). +There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/how-to-guides/themes/theme-support.md). ## Autocomplete diff --git a/docs/howto-guides/accessibility.md b/docs/how-to-guides/accessibility.md similarity index 100% rename from docs/howto-guides/accessibility.md rename to docs/how-to-guides/accessibility.md diff --git a/docs/howto-guides/assets/fancy-quote-in-inspector.png b/docs/how-to-guides/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/howto-guides/assets/fancy-quote-in-inspector.png rename to docs/how-to-guides/assets/fancy-quote-in-inspector.png diff --git a/docs/howto-guides/assets/fancy-quote-with-style.png b/docs/how-to-guides/assets/fancy-quote-with-style.png similarity index 100% rename from docs/howto-guides/assets/fancy-quote-with-style.png rename to docs/how-to-guides/assets/fancy-quote-with-style.png diff --git a/docs/howto-guides/assets/inspector.png b/docs/how-to-guides/assets/inspector.png similarity index 100% rename from docs/howto-guides/assets/inspector.png rename to docs/how-to-guides/assets/inspector.png diff --git a/docs/howto-guides/assets/js-tutorial-console-log-error.png b/docs/how-to-guides/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-console-log-error.png rename to docs/how-to-guides/assets/js-tutorial-console-log-error.png diff --git a/docs/howto-guides/assets/js-tutorial-console-log-success.png b/docs/how-to-guides/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-console-log-success.png rename to docs/how-to-guides/assets/js-tutorial-console-log-success.png diff --git a/docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png b/docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png rename to docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png b/docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/howto-guides/assets/plugin-more-menu-item.png b/docs/how-to-guides/assets/plugin-more-menu-item.png similarity index 100% rename from docs/howto-guides/assets/plugin-more-menu-item.png rename to docs/how-to-guides/assets/plugin-more-menu-item.png diff --git a/docs/howto-guides/assets/plugin-post-publish-panel.png b/docs/how-to-guides/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/howto-guides/assets/plugin-post-publish-panel.png rename to docs/how-to-guides/assets/plugin-post-publish-panel.png diff --git a/docs/howto-guides/assets/plugin-post-status-info-location.png b/docs/how-to-guides/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/howto-guides/assets/plugin-post-status-info-location.png rename to docs/how-to-guides/assets/plugin-post-status-info-location.png diff --git a/docs/howto-guides/assets/plugin-pre-publish-panel.png b/docs/how-to-guides/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/howto-guides/assets/plugin-pre-publish-panel.png rename to docs/how-to-guides/assets/plugin-pre-publish-panel.png diff --git a/docs/howto-guides/assets/plugin-sidebar-closed-state.png b/docs/how-to-guides/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-closed-state.png rename to docs/how-to-guides/assets/plugin-sidebar-closed-state.png diff --git a/docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif b/docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif rename to docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/howto-guides/assets/plugin-sidebar-open-state.png b/docs/how-to-guides/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-open-state.png rename to docs/how-to-guides/assets/plugin-sidebar-open-state.png diff --git a/docs/howto-guides/assets/sidebar-style-and-controls.png b/docs/how-to-guides/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/howto-guides/assets/sidebar-style-and-controls.png rename to docs/how-to-guides/assets/sidebar-style-and-controls.png diff --git a/docs/howto-guides/assets/sidebar-up-and-running.png b/docs/how-to-guides/assets/sidebar-up-and-running.png similarity index 100% rename from docs/howto-guides/assets/sidebar-up-and-running.png rename to docs/how-to-guides/assets/sidebar-up-and-running.png diff --git a/docs/howto-guides/assets/toolbar-text.png b/docs/how-to-guides/assets/toolbar-text.png similarity index 100% rename from docs/howto-guides/assets/toolbar-text.png rename to docs/how-to-guides/assets/toolbar-text.png diff --git a/docs/howto-guides/assets/toolbar-with-custom-button.png b/docs/how-to-guides/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/howto-guides/assets/toolbar-with-custom-button.png rename to docs/how-to-guides/assets/toolbar-with-custom-button.png diff --git a/docs/howto-guides/backward-compatibility/README.md b/docs/how-to-guides/backward-compatibility/README.md similarity index 100% rename from docs/howto-guides/backward-compatibility/README.md rename to docs/how-to-guides/backward-compatibility/README.md diff --git a/docs/howto-guides/backward-compatibility/deprecations.md b/docs/how-to-guides/backward-compatibility/deprecations.md similarity index 100% rename from docs/howto-guides/backward-compatibility/deprecations.md rename to docs/how-to-guides/backward-compatibility/deprecations.md diff --git a/docs/howto-guides/backward-compatibility/meta-box.md b/docs/how-to-guides/backward-compatibility/meta-box.md similarity index 98% rename from docs/howto-guides/backward-compatibility/meta-box.md rename to docs/how-to-guides/backward-compatibility/meta-box.md index 56432fd80b56d..ebffb327ffe7f 100644 --- a/docs/howto-guides/backward-compatibility/meta-box.md +++ b/docs/how-to-guides/backward-compatibility/meta-box.md @@ -1,6 +1,6 @@ # Meta Boxes -This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/howto-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. +This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/how-to-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. ### Testing, Converting, and Maintaining Existing Meta Boxes diff --git a/docs/howto-guides/block-based-themes/README.md b/docs/how-to-guides/block-based-themes/README.md similarity index 92% rename from docs/howto-guides/block-based-themes/README.md rename to docs/how-to-guides/block-based-themes/README.md index faf0b054a163f..310ec28a3ec7a 100644 --- a/docs/howto-guides/block-based-themes/README.md +++ b/docs/how-to-guides/block-based-themes/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/howto-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/howto-guides/block-based-themes/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/howto-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/howto-guides/block-based-themes/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -32,7 +32,7 @@ Each template or template part contains the [block grammar](https://developer.wo A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. -The theme may optionally include an [experimental-theme.json file](/docs/howto-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. +The theme may optionally include an [experimental-theme.json file](/docs/how-to-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) diff --git a/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md b/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md similarity index 100% rename from docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md rename to docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md diff --git a/docs/howto-guides/block-tutorial/README.md b/docs/how-to-guides/block-tutorial/README.md similarity index 91% rename from docs/howto-guides/block-tutorial/README.md rename to docs/how-to-guides/block-tutorial/README.md index b4b2b05a39dd2..d16645fdf45e0 100644 --- a/docs/howto-guides/block-tutorial/README.md +++ b/docs/how-to-guides/block-tutorial/README.md @@ -4,6 +4,6 @@ The purpose of this tutorial is to step through the fundamentals of creating a n To follow along with this tutorial, you can [download the accompanying WordPress plugin](https://github.com/WordPress/gutenberg-examples) which includes all of the examples for you to try on your own site. At each step along the way, experiment by modifying the examples with your own ideas, and observe the effects they have on the block's behavior. -Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/howto-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. +Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/how-to-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. diff --git a/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md b/docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md similarity index 100% rename from docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md rename to docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md diff --git a/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md similarity index 100% rename from docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md rename to docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md diff --git a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md b/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md similarity index 97% rename from docs/howto-guides/block-tutorial/creating-dynamic-blocks.md rename to docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md index 443dce0e2477b..bcd7fc023eba8 100644 --- a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md +++ b/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md @@ -9,7 +9,7 @@ There are two primary uses for dynamic blocks: For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/reference-guides/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. -If you are using [InnerBlocks](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` +If you are using [InnerBlocks](/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` You can also save an HTML representation of the block. If you provide a server-side rendering callback, this HTML will be replaced with the output of your callback, but will be rendered if your block is deactivated or your render callback is removed. diff --git a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md b/docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md similarity index 100% rename from docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md rename to docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md diff --git a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md similarity index 100% rename from docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md rename to docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md diff --git a/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md b/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md similarity index 100% rename from docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md rename to docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md diff --git a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md b/docs/how-to-guides/block-tutorial/writing-your-first-block-type.md similarity index 98% rename from docs/howto-guides/block-tutorial/writing-your-first-block-type.md rename to docs/how-to-guides/block-tutorial/writing-your-first-block-type.md index 537e233a1645e..55faf6d69f757 100644 --- a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md +++ b/docs/how-to-guides/block-tutorial/writing-your-first-block-type.md @@ -36,7 +36,7 @@ function gutenberg_examples_01_register_block() { add_action( 'init', 'gutenberg_examples_01_register_block' ); ``` -Note the above example, shows using the [wp-scripts build step](/docs/howto-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. +Note the above example, shows using the [wp-scripts build step](/docs/how-to-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. If you were using the ES5 code, you would specify `array( 'wp-blocks', 'wp-element' )` as the dependency array. See the [example 01](https://github.com/WordPress/gutenberg-examples/blob/HEAD/01-basic/index.php) in Gutenberg Examples repository for full syntax. diff --git a/docs/howto-guides/designers/README.md b/docs/how-to-guides/designers/README.md similarity index 100% rename from docs/howto-guides/designers/README.md rename to docs/how-to-guides/designers/README.md diff --git a/docs/howto-guides/designers/animation.md b/docs/how-to-guides/designers/animation.md similarity index 100% rename from docs/howto-guides/designers/animation.md rename to docs/how-to-guides/designers/animation.md diff --git a/docs/howto-guides/designers/assets/advanced-settings-do.png b/docs/how-to-guides/designers/assets/advanced-settings-do.png similarity index 100% rename from docs/howto-guides/designers/assets/advanced-settings-do.png rename to docs/how-to-guides/designers/assets/advanced-settings-do.png diff --git a/docs/howto-guides/designers/assets/block-controls-do.png b/docs/how-to-guides/designers/assets/block-controls-do.png similarity index 100% rename from docs/howto-guides/designers/assets/block-controls-do.png rename to docs/how-to-guides/designers/assets/block-controls-do.png diff --git a/docs/howto-guides/designers/assets/block-controls-dont.png b/docs/how-to-guides/designers/assets/block-controls-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/block-controls-dont.png rename to docs/how-to-guides/designers/assets/block-controls-dont.png diff --git a/docs/howto-guides/designers/assets/block-descriptions-do.png b/docs/how-to-guides/designers/assets/block-descriptions-do.png similarity index 100% rename from docs/howto-guides/designers/assets/block-descriptions-do.png rename to docs/how-to-guides/designers/assets/block-descriptions-do.png diff --git a/docs/howto-guides/designers/assets/block-descriptions-dont.png b/docs/how-to-guides/designers/assets/block-descriptions-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/block-descriptions-dont.png rename to docs/how-to-guides/designers/assets/block-descriptions-dont.png diff --git a/docs/howto-guides/designers/assets/blocks-do.png b/docs/how-to-guides/designers/assets/blocks-do.png similarity index 100% rename from docs/howto-guides/designers/assets/blocks-do.png rename to docs/how-to-guides/designers/assets/blocks-do.png diff --git a/docs/howto-guides/designers/assets/blocks-dont.png b/docs/how-to-guides/designers/assets/blocks-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/blocks-dont.png rename to docs/how-to-guides/designers/assets/blocks-dont.png diff --git a/docs/howto-guides/designers/assets/placeholder-do.png b/docs/how-to-guides/designers/assets/placeholder-do.png similarity index 100% rename from docs/howto-guides/designers/assets/placeholder-do.png rename to docs/how-to-guides/designers/assets/placeholder-do.png diff --git a/docs/howto-guides/designers/assets/placeholder-dont.png b/docs/how-to-guides/designers/assets/placeholder-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/placeholder-dont.png rename to docs/how-to-guides/designers/assets/placeholder-dont.png diff --git a/docs/howto-guides/designers/block-design.md b/docs/how-to-guides/designers/block-design.md similarity index 98% rename from docs/howto-guides/designers/block-design.md rename to docs/how-to-guides/designers/block-design.md index 233d0476fa9fe..818dd4436962d 100644 --- a/docs/howto-guides/designers/block-design.md +++ b/docs/how-to-guides/designers/block-design.md @@ -132,7 +132,7 @@ Check how your block looks, feels, and works on as many devices and screen sizes ### Support Gutenberg's dark background editor scheme -Check how your block looks with [dark backgrounds](/docs/howto-guides/themes/theme-support.md#dark-backgrounds) in the editor. +Check how your block looks with [dark backgrounds](/docs/how-to-guides/themes/theme-support.md#dark-backgrounds) in the editor. ## Examples diff --git a/docs/howto-guides/designers/design-resources.md b/docs/how-to-guides/designers/design-resources.md similarity index 100% rename from docs/howto-guides/designers/design-resources.md rename to docs/how-to-guides/designers/design-resources.md diff --git a/docs/howto-guides/designers/user-interface.md b/docs/how-to-guides/designers/user-interface.md similarity index 100% rename from docs/howto-guides/designers/user-interface.md rename to docs/how-to-guides/designers/user-interface.md diff --git a/docs/howto-guides/feature-flags.md b/docs/how-to-guides/feature-flags.md similarity index 100% rename from docs/howto-guides/feature-flags.md rename to docs/how-to-guides/feature-flags.md diff --git a/docs/howto-guides/format-api/1-register-format.md b/docs/how-to-guides/format-api/1-register-format.md similarity index 100% rename from docs/howto-guides/format-api/1-register-format.md rename to docs/how-to-guides/format-api/1-register-format.md diff --git a/docs/howto-guides/format-api/2-toolbar-button.md b/docs/how-to-guides/format-api/2-toolbar-button.md similarity index 100% rename from docs/howto-guides/format-api/2-toolbar-button.md rename to docs/how-to-guides/format-api/2-toolbar-button.md diff --git a/docs/howto-guides/format-api/3-apply-format.md b/docs/how-to-guides/format-api/3-apply-format.md similarity index 100% rename from docs/howto-guides/format-api/3-apply-format.md rename to docs/how-to-guides/format-api/3-apply-format.md diff --git a/docs/howto-guides/format-api/README.md b/docs/how-to-guides/format-api/README.md similarity index 74% rename from docs/howto-guides/format-api/README.md rename to docs/how-to-guides/format-api/README.md index 74b742db7bebd..bc028f4f07317 100644 --- a/docs/howto-guides/format-api/README.md +++ b/docs/how-to-guides/format-api/README.md @@ -4,10 +4,10 @@ The purpose of this tutorial is to introduce you to the Format API. The Format A In WordPress lingo, a _format_ is a [HTML tag with text-level semantics](https://www.w3.org/TR/html5/textlevel-semantics.html#text-level-semantics-usage-summary) used to give some special meaning to a text selection. For example, in this tutorial, the button to be hooked into the format toolbar will let users wrap a particular text selection with the [`` HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp). -If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) first. +If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/how-to-guides/javascript/readme.md) first. ## Table of Contents -1. [Register a new format](/docs/howto-guides/format-api/1-register-format.md) -2. [Add a button to the toolbar](/docs/howto-guides/format-api/2-toolbar-button.md) -3. [Apply the format when the button is clicked](/docs/howto-guides/format-api/3-apply-format.md) +1. [Register a new format](/docs/how-to-guides/format-api/1-register-format.md) +2. [Add a button to the toolbar](/docs/how-to-guides/format-api/2-toolbar-button.md) +3. [Apply the format when the button is clicked](/docs/how-to-guides/format-api/3-apply-format.md) diff --git a/docs/howto-guides/internationalization.md b/docs/how-to-guides/internationalization.md similarity index 100% rename from docs/howto-guides/internationalization.md rename to docs/how-to-guides/internationalization.md diff --git a/docs/howto-guides/javascript/README.md b/docs/how-to-guides/javascript/README.md similarity index 59% rename from docs/howto-guides/javascript/README.md rename to docs/how-to-guides/javascript/README.md index b505191c791be..b31b0fa4d9989 100644 --- a/docs/howto-guides/javascript/README.md +++ b/docs/how-to-guides/javascript/README.md @@ -10,11 +10,11 @@ The block editor introduced in WordPress 5.0 is written in JavaScript, with the ### Table of Contents -1. [Plugins Background](/docs/howto-guides/javascript/plugins-background.md) -2. [Loading JavaScript](/docs/howto-guides/javascript/loading-javascript.md) -3. [Extending the Block Editor](/docs/howto-guides/javascript/extending-the-block-editor.md) -4. [Troubleshooting](/docs/howto-guides/javascript/troubleshooting.md) -5. [JavaScript Versions and Building](/docs/howto-guides/javascript/versions-and-building.md) -6. [Scope your code](/docs/howto-guides/javascript/scope-your-code.md) -7. [JavaScript Build Step](/docs/howto-guides/javascript/js-build-setup.md) -8. [ESNext Syntax](/docs/howto-guides/javascript/esnext-js.md) +1. [Plugins Background](/docs/how-to-guides/javascript/plugins-background.md) +2. [Loading JavaScript](/docs/how-to-guides/javascript/loading-javascript.md) +3. [Extending the Block Editor](/docs/how-to-guides/javascript/extending-the-block-editor.md) +4. [Troubleshooting](/docs/how-to-guides/javascript/troubleshooting.md) +5. [JavaScript Versions and Building](/docs/how-to-guides/javascript/versions-and-building.md) +6. [Scope your code](/docs/how-to-guides/javascript/scope-your-code.md) +7. [JavaScript Build Step](/docs/how-to-guides/javascript/js-build-setup.md) +8. [ESNext Syntax](/docs/how-to-guides/javascript/esnext-js.md) diff --git a/docs/howto-guides/javascript/esnext-js.md b/docs/how-to-guides/javascript/esnext-js.md similarity index 100% rename from docs/howto-guides/javascript/esnext-js.md rename to docs/how-to-guides/javascript/esnext-js.md diff --git a/docs/howto-guides/javascript/extending-the-block-editor.md b/docs/how-to-guides/javascript/extending-the-block-editor.md similarity index 100% rename from docs/howto-guides/javascript/extending-the-block-editor.md rename to docs/how-to-guides/javascript/extending-the-block-editor.md diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/how-to-guides/javascript/js-build-setup.md similarity index 96% rename from docs/howto-guides/javascript/js-build-setup.md rename to docs/how-to-guides/javascript/js-build-setup.md index ddff1bb175888..b3b4eeaf035ec 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/how-to-guides/javascript/js-build-setup.md @@ -2,7 +2,7 @@ ESNext is JavaScript written using syntax and features only available in a version newer than browser support—the support browser versions is referred to as ECMAScript 5 (ES5). [JSX](https://reactjs.org/docs/introducing-jsx.html) is a custom syntax extension to JavaScript, created by React project, that allows you to write JavaScript using a familiar HTML tag-like syntax. -See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/code/getting-started.md) documentation. @@ -125,7 +125,7 @@ To configure npm to run a script, you use the scripts section in `package.json` You can then run the build using: `npm run build`. -After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/howto-guides/javascript/loading-javascript.md), and the block will load in the editor. +After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/how-to-guides/javascript/loading-javascript.md), and the block will load in the editor. ## Development Mode diff --git a/docs/howto-guides/javascript/loading-javascript.md b/docs/how-to-guides/javascript/loading-javascript.md similarity index 100% rename from docs/howto-guides/javascript/loading-javascript.md rename to docs/how-to-guides/javascript/loading-javascript.md diff --git a/docs/howto-guides/javascript/plugins-background.md b/docs/how-to-guides/javascript/plugins-background.md similarity index 100% rename from docs/howto-guides/javascript/plugins-background.md rename to docs/how-to-guides/javascript/plugins-background.md diff --git a/docs/howto-guides/javascript/scope-your-code.md b/docs/how-to-guides/javascript/scope-your-code.md similarity index 100% rename from docs/howto-guides/javascript/scope-your-code.md rename to docs/how-to-guides/javascript/scope-your-code.md diff --git a/docs/howto-guides/javascript/troubleshooting.md b/docs/how-to-guides/javascript/troubleshooting.md similarity index 94% rename from docs/howto-guides/javascript/troubleshooting.md rename to docs/how-to-guides/javascript/troubleshooting.md index bb2bc57fd5633..30179342bc5ac 100644 --- a/docs/howto-guides/javascript/troubleshooting.md +++ b/docs/how-to-guides/javascript/troubleshooting.md @@ -55,7 +55,7 @@ If you are not seeing your changes, and no errors, check that your JavaScript fi If you do not see the file being loaded, double check the enqueue function is correct. You can also check your server logs to see if there is an error messages. -Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/howto-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. +Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/how-to-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. ## Confirm all dependencies are loading @@ -73,4 +73,4 @@ wp_enqueue_script( ); ``` -For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/howto-guides/javascript/js-build-setup.md#dependency-management). +For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/how-to-guides/javascript/js-build-setup.md#dependency-management). diff --git a/docs/howto-guides/javascript/versions-and-building.md b/docs/how-to-guides/javascript/versions-and-building.md similarity index 82% rename from docs/howto-guides/javascript/versions-and-building.md rename to docs/how-to-guides/javascript/versions-and-building.md index 9c13413d4b813..afe4c365b51d7 100644 --- a/docs/howto-guides/javascript/versions-and-building.md +++ b/docs/how-to-guides/javascript/versions-and-building.md @@ -10,6 +10,6 @@ Additionally, the ESNext code examples in the handbook include [JSX syntax](http For simplicity, the JavaScript tutorial uses the ES5 definition, without JSX. This code can run straight in your browser and does not require an additional build step. In many cases, it is perfectly fine to follow the same approach for simple plugins or experimenting. As your codebase grows in complexity it might be a good idea to switch to ESNext. You will find the majority of code and documentation across the block editor uses ESNext. -See the [JavaScript Build Setup documentation](/docs/howto-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. +See the [JavaScript Build Setup documentation](/docs/how-to-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. -See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. diff --git a/docs/howto-guides/metabox/README.md b/docs/how-to-guides/metabox/README.md similarity index 83% rename from docs/howto-guides/metabox/README.md rename to docs/how-to-guides/metabox/README.md index 47c071489f00e..a35a9edac92a3 100644 --- a/docs/howto-guides/metabox/README.md +++ b/docs/how-to-guides/metabox/README.md @@ -10,9 +10,9 @@ Here are two mini-tutorials for creating similar functionality to meta boxes in The first method is to use Blocks to store extra data with a post. The data is stored in a post meta field, similar to how meta boxes store information. -* [Store Post Meta with a Block](/docs/howto-guides/metabox/meta-block-1-intro.md) +* [Store Post Meta with a Block](/docs/how-to-guides/metabox/meta-block-1-intro.md) ## Sidebar Plugin -If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md/). +If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md/). diff --git a/docs/howto-guides/metabox/meta-block-1-intro.md b/docs/how-to-guides/metabox/meta-block-1-intro.md similarity index 63% rename from docs/howto-guides/metabox/meta-block-1-intro.md rename to docs/how-to-guides/metabox/meta-block-1-intro.md index 1a02e4ec6fad1..4e13ac7a7d3d0 100644 --- a/docs/howto-guides/metabox/meta-block-1-intro.md +++ b/docs/how-to-guides/metabox/meta-block-1-intro.md @@ -6,12 +6,12 @@ In this short tutorial you will create one of these blocks, which will prompt a For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/architecture/key-concepts.md) of the handbook. -Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/howto-guides/javascript/readme.md) for information setting up a plugin. +Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/how-to-guides/javascript/readme.md) for information setting up a plugin. ## Table of Contents -1. [Register Meta Field](/docs/howto-guides/metabox/meta-block-2-register-meta.md) -2. [Add Meta Block](/docs/howto-guides/metabox/meta-block-3-add.md) -3. [Use Post Meta Data](/docs/howto-guides/metabox/meta-block-4-use-data.md) -4. [Finishing Touches](/docs/howto-guides/metabox/meta-block-5-finishing.md) +1. [Register Meta Field](/docs/how-to-guides/metabox/meta-block-2-register-meta.md) +2. [Add Meta Block](/docs/how-to-guides/metabox/meta-block-3-add.md) +3. [Use Post Meta Data](/docs/how-to-guides/metabox/meta-block-4-use-data.md) +4. [Finishing Touches](/docs/how-to-guides/metabox/meta-block-5-finishing.md) diff --git a/docs/howto-guides/metabox/meta-block-2-register-meta.md b/docs/how-to-guides/metabox/meta-block-2-register-meta.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-2-register-meta.md rename to docs/how-to-guides/metabox/meta-block-2-register-meta.md diff --git a/docs/howto-guides/metabox/meta-block-3-add.md b/docs/how-to-guides/metabox/meta-block-3-add.md similarity index 91% rename from docs/howto-guides/metabox/meta-block-3-add.md rename to docs/how-to-guides/metabox/meta-block-3-add.md index ae88a63e17e3b..aa138b1418d3c 100644 --- a/docs/howto-guides/metabox/meta-block-3-add.md +++ b/docs/how-to-guides/metabox/meta-block-3-add.md @@ -1,6 +1,6 @@ # Create Meta Block -With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. +With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/how-to-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. For this block, you will use the TextControl component, which is similar to an HTML input text field. For additional components, check out the [Component Reference](/packages/components/README.md). @@ -138,4 +138,4 @@ You can now edit a draft post and add a Meta Block to the post. You will see you ![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) -You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/howto-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. +You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/how-to-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/howto-guides/metabox/meta-block-4-use-data.md b/docs/how-to-guides/metabox/meta-block-4-use-data.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-4-use-data.md rename to docs/how-to-guides/metabox/meta-block-4-use-data.md diff --git a/docs/howto-guides/metabox/meta-block-5-finishing.md b/docs/how-to-guides/metabox/meta-block-5-finishing.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-5-finishing.md rename to docs/how-to-guides/metabox/meta-block-5-finishing.md diff --git a/docs/howto-guides/metabox/meta-block.png b/docs/how-to-guides/metabox/meta-block.png similarity index 100% rename from docs/howto-guides/metabox/meta-block.png rename to docs/how-to-guides/metabox/meta-block.png diff --git a/docs/howto-guides/notices/README.md b/docs/how-to-guides/notices/README.md similarity index 95% rename from docs/howto-guides/notices/README.md rename to docs/how-to-guides/notices/README.md index 7bef4e05911ec..85e2aa1acc61a 100644 --- a/docs/howto-guides/notices/README.md +++ b/docs/how-to-guides/notices/README.md @@ -71,7 +71,7 @@ To better understand the specific code example above: * `wp.data.dispatch('core/notices')` accesses functionality registered to the block editor data store by the Notices package. * `createNotice()` is a function offered by the Notices package to register a new notice. The block editor reads from the notice data store in order to know which notices to display. -Check out the [_Loading JavaScript_](/docs/howto-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. +Check out the [_Loading JavaScript_](/docs/how-to-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. ## Learn More diff --git a/docs/howto-guides/notices/block-editor-notice.png b/docs/how-to-guides/notices/block-editor-notice.png similarity index 100% rename from docs/howto-guides/notices/block-editor-notice.png rename to docs/how-to-guides/notices/block-editor-notice.png diff --git a/docs/howto-guides/notices/classic-editor-notice.png b/docs/how-to-guides/notices/classic-editor-notice.png similarity index 100% rename from docs/howto-guides/notices/classic-editor-notice.png rename to docs/how-to-guides/notices/classic-editor-notice.png diff --git a/docs/howto-guides/platform/README.md b/docs/how-to-guides/platform/README.md similarity index 100% rename from docs/howto-guides/platform/README.md rename to docs/how-to-guides/platform/README.md diff --git a/docs/howto-guides/platform/custom-block-editor/README.md b/docs/how-to-guides/platform/custom-block-editor/README.md similarity index 100% rename from docs/howto-guides/platform/custom-block-editor/README.md rename to docs/how-to-guides/platform/custom-block-editor/README.md diff --git a/docs/howto-guides/platform/custom-block-editor/tutorial.md b/docs/how-to-guides/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/howto-guides/platform/custom-block-editor/tutorial.md rename to docs/how-to-guides/platform/custom-block-editor/tutorial.md diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md new file mode 100644 index 0000000000000..fa33fb682c874 --- /dev/null +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md @@ -0,0 +1,12 @@ +# Creating a Sidebar for Your Plugin + +This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/how-to-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. + + In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. + +1. [Get a sidebar up and running](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) +2. [Tweak the sidebar style and add controls](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) +3. [Register a new meta field](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) +4. [Initialize the input control with the meta field value](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) +5. [Update the meta field value when input's content changes](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) +6. [Finishing touches](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md diff --git a/docs/howto-guides/themes/README.md b/docs/how-to-guides/themes/README.md similarity index 100% rename from docs/howto-guides/themes/README.md rename to docs/how-to-guides/themes/README.md diff --git a/docs/howto-guides/themes/block-based-themes.md b/docs/how-to-guides/themes/block-based-themes.md similarity index 96% rename from docs/howto-guides/themes/block-based-themes.md rename to docs/how-to-guides/themes/block-based-themes.md index 6b59aa1f14f70..ef2abcc107d90 100644 --- a/docs/howto-guides/themes/block-based-themes.md +++ b/docs/how-to-guides/themes/block-based-themes.md @@ -31,7 +31,7 @@ theme |__ ... ``` -The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/howto-guides/themes/theme-json.md) file for some styles. +The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/how-to-guides/themes/theme-json.md) file for some styles. ## What is a block template? @@ -126,7 +126,7 @@ As we're still early in the process, the number of blocks specifically dedicated ## Styling -One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/howto-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. +One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/how-to-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. ## Resources diff --git a/docs/howto-guides/themes/theme-json.md b/docs/how-to-guides/themes/theme-json.md similarity index 100% rename from docs/howto-guides/themes/theme-json.md rename to docs/how-to-guides/themes/theme-json.md diff --git a/docs/howto-guides/themes/theme-support.md b/docs/how-to-guides/themes/theme-support.md similarity index 99% rename from docs/howto-guides/themes/theme-support.md rename to docs/how-to-guides/themes/theme-support.md index 66607e3264e32..1b434af064b1d 100644 --- a/docs/howto-guides/themes/theme-support.md +++ b/docs/how-to-guides/themes/theme-support.md @@ -360,7 +360,7 @@ To change the main column width of the editor, add the following CSS to `style-e You can use those editor widths to match those in your theme. You can use any CSS width unit, including `%` or `px`. -Further reading: [Applying Styles with Stylesheets](/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md). +Further reading: [Applying Styles with Stylesheets](/docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md). ## Responsive embedded content diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md deleted file mode 100644 index 47978feeb0ec9..0000000000000 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md +++ /dev/null @@ -1,12 +0,0 @@ -# Creating a Sidebar for Your Plugin - -This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/howto-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. - - In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. - -1. [Get a sidebar up and running](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) -2. [Tweak the sidebar style and add controls](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) -3. [Register a new meta field](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) -4. [Initialize the input control with the meta field value](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) -5. [Update the meta field value when input's content changes](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) -6. [Finishing touches](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/manifest.json b/docs/manifest.json index 10f076a35e3dc..4fcc8896476d7 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -91,333 +91,333 @@ }, { "title": "Developer Documentation", - "slug": "howto-guides", - "markdown_source": "../docs/howto-guides/README.md", + "slug": "how-to-guides", + "markdown_source": "../docs/how-to-guides/README.md", "parent": null }, { "title": "Getting Started with JavaScript", "slug": "javascript", - "markdown_source": "../docs/howto-guides/javascript/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/javascript/README.md", + "parent": "how-to-guides" }, { "title": "Plugins Background", "slug": "plugins-background", - "markdown_source": "../docs/howto-guides/javascript/plugins-background.md", + "markdown_source": "../docs/how-to-guides/javascript/plugins-background.md", "parent": "javascript" }, { "title": "Loading JavaScript", "slug": "loading-javascript", - "markdown_source": "../docs/howto-guides/javascript/loading-javascript.md", + "markdown_source": "../docs/how-to-guides/javascript/loading-javascript.md", "parent": "javascript" }, { "title": "Extending the Block Editor", "slug": "extending-the-block-editor", - "markdown_source": "../docs/howto-guides/javascript/extending-the-block-editor.md", + "markdown_source": "../docs/how-to-guides/javascript/extending-the-block-editor.md", "parent": "javascript" }, { "title": "Troubleshooting", "slug": "troubleshooting", - "markdown_source": "../docs/howto-guides/javascript/troubleshooting.md", + "markdown_source": "../docs/how-to-guides/javascript/troubleshooting.md", "parent": "javascript" }, { "title": "JavaScript Versions and Build Step", "slug": "versions-and-building", - "markdown_source": "../docs/howto-guides/javascript/versions-and-building.md", + "markdown_source": "../docs/how-to-guides/javascript/versions-and-building.md", "parent": "javascript" }, { "title": "Scope Your Code", "slug": "scope-your-code", - "markdown_source": "../docs/howto-guides/javascript/scope-your-code.md", + "markdown_source": "../docs/how-to-guides/javascript/scope-your-code.md", "parent": "javascript" }, { "title": "JavaScript Build Setup", "slug": "js-build-setup", - "markdown_source": "../docs/howto-guides/javascript/js-build-setup.md", + "markdown_source": "../docs/how-to-guides/javascript/js-build-setup.md", "parent": "javascript" }, { "title": "ESNext Syntax", "slug": "esnext-js", - "markdown_source": "../docs/howto-guides/javascript/esnext-js.md", + "markdown_source": "../docs/how-to-guides/javascript/esnext-js.md", "parent": "javascript" }, { "title": "Meta Boxes", "slug": "metabox", - "markdown_source": "../docs/howto-guides/metabox/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/metabox/README.md", + "parent": "how-to-guides" }, { "title": "Store Post Meta with a Block", "slug": "meta-block-1-intro", - "markdown_source": "../docs/howto-guides/metabox/meta-block-1-intro.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-1-intro.md", "parent": "metabox" }, { "title": "Register Meta Field", "slug": "meta-block-2-register-meta", - "markdown_source": "../docs/howto-guides/metabox/meta-block-2-register-meta.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-2-register-meta.md", "parent": "metabox" }, { "title": "Create Meta Block", "slug": "meta-block-3-add", - "markdown_source": "../docs/howto-guides/metabox/meta-block-3-add.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-3-add.md", "parent": "metabox" }, { "title": "Use Post Meta Data", "slug": "meta-block-4-use-data", - "markdown_source": "../docs/howto-guides/metabox/meta-block-4-use-data.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-4-use-data.md", "parent": "metabox" }, { "title": "Finishing Touches", "slug": "meta-block-5-finishing", - "markdown_source": "../docs/howto-guides/metabox/meta-block-5-finishing.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-5-finishing.md", "parent": "metabox" }, { "title": "Displaying Notices from Your Plugin or Theme", "slug": "notices", - "markdown_source": "../docs/howto-guides/notices/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/notices/README.md", + "parent": "how-to-guides" }, { "title": "Creating a Sidebar for Your Plugin", "slug": "plugin-sidebar-0", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md", + "parent": "how-to-guides" }, { "title": "Get a Sidebar up and Running", "slug": "plugin-sidebar-1-up-and-running", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", "parent": "plugin-sidebar-0" }, { "title": "Tweak the sidebar style and add controls", "slug": "plugin-sidebar-2-styles-and-controls", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", "parent": "plugin-sidebar-0" }, { "title": "Register the Meta Field", "slug": "plugin-sidebar-3-register-meta", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", "parent": "plugin-sidebar-0" }, { "title": "Initialize the Input Control", "slug": "plugin-sidebar-4-initialize-input", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", "parent": "plugin-sidebar-0" }, { "title": "Update the Meta Field When the Input's Content Changes", "slug": "plugin-sidebar-5-update-meta", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", "parent": "plugin-sidebar-0" }, { "title": "Finishing Touches", "slug": "plugin-sidebar-6-finishing-touches", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", "parent": "plugin-sidebar-0" }, { "title": "Blocks", "slug": "block-tutorial", - "markdown_source": "../docs/howto-guides/block-tutorial/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/block-tutorial/README.md", + "parent": "how-to-guides" }, { "title": "Writing Your First Block Type", "slug": "writing-your-first-block-type", - "markdown_source": "../docs/howto-guides/block-tutorial/writing-your-first-block-type.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/writing-your-first-block-type.md", "parent": "block-tutorial" }, { "title": "Applying Styles From a Stylesheet", "slug": "applying-styles-with-stylesheets", - "markdown_source": "../docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md", "parent": "block-tutorial" }, { "title": "Introducing Attributes and Editable Fields", "slug": "introducing-attributes-and-editable-fields", - "markdown_source": "../docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md", "parent": "block-tutorial" }, { "title": "Block Controls: Block Toolbar and Settings Sidebar", "slug": "block-controls-toolbar-and-sidebar", - "markdown_source": "../docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", "parent": "block-tutorial" }, { "title": "Creating dynamic blocks", "slug": "creating-dynamic-blocks", - "markdown_source": "../docs/howto-guides/block-tutorial/creating-dynamic-blocks.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md", "parent": "block-tutorial" }, { "title": "Generate Blocks with WP-CLI", "slug": "generate-blocks-with-wp-cli", - "markdown_source": "../docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md", "parent": "block-tutorial" }, { "title": "Nested Blocks: Using InnerBlocks", "slug": "nested-blocks-inner-blocks", - "markdown_source": "../docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md", "parent": "block-tutorial" }, { "title": "Feature Flags", "slug": "feature-flags", - "markdown_source": "../docs/howto-guides/feature-flags.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/feature-flags.md", + "parent": "how-to-guides" }, { "title": "Theming for the Block Editor", "slug": "themes", - "markdown_source": "../docs/howto-guides/themes/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/themes/README.md", + "parent": "how-to-guides" }, { "title": "Theme Support", "slug": "theme-support", - "markdown_source": "../docs/howto-guides/themes/theme-support.md", + "markdown_source": "../docs/how-to-guides/themes/theme-support.md", "parent": "themes" }, { "title": "Themes & Block Editor: experimental theme.json", "slug": "theme-json", - "markdown_source": "../docs/howto-guides/themes/theme-json.md", + "markdown_source": "../docs/how-to-guides/themes/theme-json.md", "parent": "themes" }, { "title": "Creating a block-based theme", "slug": "block-based-themes", - "markdown_source": "../docs/howto-guides/block-based-themes/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/block-based-themes/README.md", + "parent": "how-to-guides" }, { "title": "Adding blocks to your theme", "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md", + "markdown_source": "../docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md", "parent": "block-based-themes" }, { "title": "Backward Compatibility", "slug": "backward-compatibility", - "markdown_source": "../docs/howto-guides/backward-compatibility/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/backward-compatibility/README.md", + "parent": "how-to-guides" }, { "title": "Deprecations", "slug": "deprecations", - "markdown_source": "../docs/howto-guides/backward-compatibility/deprecations.md", + "markdown_source": "../docs/how-to-guides/backward-compatibility/deprecations.md", "parent": "backward-compatibility" }, { "title": "Meta Boxes", "slug": "meta-box", - "markdown_source": "../docs/howto-guides/backward-compatibility/meta-box.md", + "markdown_source": "../docs/how-to-guides/backward-compatibility/meta-box.md", "parent": "backward-compatibility" }, { "title": "Introduction to the Format API", "slug": "format-api", - "markdown_source": "../docs/howto-guides/format-api/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/format-api/README.md", + "parent": "how-to-guides" }, { "title": "Register a New Format", "slug": "1-register-format", - "markdown_source": "../docs/howto-guides/format-api/1-register-format.md", + "markdown_source": "../docs/how-to-guides/format-api/1-register-format.md", "parent": "format-api" }, { "title": "Add a Button to the Toolbar", "slug": "2-toolbar-button", - "markdown_source": "../docs/howto-guides/format-api/2-toolbar-button.md", + "markdown_source": "../docs/how-to-guides/format-api/2-toolbar-button.md", "parent": "format-api" }, { "title": "Apply the Format When the Button Is Clicked", "slug": "3-apply-format", - "markdown_source": "../docs/howto-guides/format-api/3-apply-format.md", + "markdown_source": "../docs/how-to-guides/format-api/3-apply-format.md", "parent": "format-api" }, { "title": "Gutenberg as a Development Platform", "slug": "platform", - "markdown_source": "../docs/howto-guides/platform/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/platform/README.md", + "parent": "how-to-guides" }, { "title": "Building a custom block editor", "slug": "custom-block-editor", - "markdown_source": "../docs/howto-guides/platform/custom-block-editor/README.md", + "markdown_source": "../docs/how-to-guides/platform/custom-block-editor/README.md", "parent": "platform" }, { "title": "Tutorial: building a custom block editor", "slug": "tutorial", - "markdown_source": "../docs/howto-guides/platform/custom-block-editor/tutorial.md", + "markdown_source": "../docs/how-to-guides/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, { "title": "Designer Documentation", "slug": "designers", - "markdown_source": "../docs/howto-guides/designers/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/designers/README.md", + "parent": "how-to-guides" }, { "title": "Block Design", "slug": "block-design", - "markdown_source": "../docs/howto-guides/designers/block-design.md", + "markdown_source": "../docs/how-to-guides/designers/block-design.md", "parent": "designers" }, { "title": "User Interface", "slug": "user-interface", - "markdown_source": "../docs/howto-guides/designers/user-interface.md", + "markdown_source": "../docs/how-to-guides/designers/user-interface.md", "parent": "designers" }, { "title": "Resources", "slug": "design-resources", - "markdown_source": "../docs/howto-guides/designers/design-resources.md", + "markdown_source": "../docs/how-to-guides/designers/design-resources.md", "parent": "designers" }, { "title": "Animation", "slug": "animation", - "markdown_source": "../docs/howto-guides/designers/animation.md", + "markdown_source": "../docs/how-to-guides/designers/animation.md", "parent": "designers" }, { "title": "Accessibility", "slug": "accessibility", - "markdown_source": "../docs/howto-guides/accessibility.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/accessibility.md", + "parent": "how-to-guides" }, { "title": "Internationalization", "slug": "internationalization", - "markdown_source": "../docs/howto-guides/internationalization.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/internationalization.md", + "parent": "how-to-guides" }, { "title": "ReferenceGuides", diff --git a/docs/reference-guides/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md index 17dbd38cbff41..0e56151c381b3 100644 --- a/docs/reference-guides/block-api/block-edit-save.md +++ b/docs/reference-guides/block-api/block-edit-save.md @@ -285,10 +285,10 @@ _Note:_ The save function should be a pure function that depends only on the att It can not have any side effect or retrieve information from another source, e.g. it is not possible to use the data module inside it `select( store ).selector( ... )`. This is because if the external information changes, the block may be flagged as invalid when the post is later edited ([read more about Validation](#validation)). If there is a need to have other information as part of the save, developers can consider one of these two alternatives: - - Use [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. + - Use [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. - Store the external value as an attribute which is dynamically updated in the block's `edit` function as changes occur. -For [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. +For [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. If left unspecified, the default implementation will save no markup in post content for the dynamic block, instead deferring this to always be calculated when the block is shown on the front of the site. @@ -328,7 +328,7 @@ When saving your block, you want to save the attributes in the same format speci ## Examples -Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. +Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. ### Saving Attributes to Child Elements diff --git a/docs/reference-guides/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md index a3c115f23773b..8ef4491e9756c 100644 --- a/docs/reference-guides/block-api/block-metadata.md +++ b/docs/reference-guides/block-api/block-metadata.md @@ -494,4 +494,4 @@ wp.blocks.registerBlockType( 'my-block/name', { } ); ``` -In the case of [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. +In the case of [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. diff --git a/docs/reference-guides/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md index 0a2e36c36cf17..5b01f69086bfa 100644 --- a/docs/reference-guides/block-api/block-supports.md +++ b/docs/reference-guides/block-api/block-supports.md @@ -57,7 +57,7 @@ attributes: { - Type: `boolean` - Default value: `true` -This property allows to enable [wide alignment](/docs/howto-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. +This property allows to enable [wide alignment](/docs/how-to-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. ```js supports: { @@ -271,7 +271,7 @@ supports: { - Type: `boolean` - Default value: `false` -This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/howto-guides/themes/theme-support.md#supporting-custom-line-heights). +This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/how-to-guides/themes/theme-support.md#supporting-custom-line-heights). ```js supports: { @@ -330,7 +330,7 @@ supports: { - Subproperties: - `padding`: type `boolean`, default value `false` -This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/howto-guides/themes/theme-support.md##cover-block-padding). +This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/how-to-guides/themes/theme-support.md##cover-block-padding). ```js supports: { diff --git a/docs/reference-guides/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md index 1ebd48e76bf50..d64e80028bc0b 100644 --- a/docs/reference-guides/block-api/block-templates.md +++ b/docs/reference-guides/block-api/block-templates.md @@ -59,7 +59,7 @@ registerBlockType( 'myplugin/template', { }); ``` -See the [Meta Block Tutorial](/docs/howto-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. +See the [Meta Block Tutorial](/docs/how-to-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. ## Custom Post types diff --git a/docs/reference-guides/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md index 05390c7a816a2..963f7937734c1 100644 --- a/docs/reference-guides/filters/block-filters.md +++ b/docs/reference-guides/filters/block-filters.md @@ -4,7 +4,7 @@ To modify the behavior of existing blocks, WordPress exposes several APIs: ### Block Style Variations -Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/) for a full example. +Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/how-to-guides/javascript/) for a full example. _Example:_ diff --git a/docs/toc.json b/docs/toc.json index 35ac7d3b29f72..a76aa93d03210 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,175 +1,221 @@ -[ - { "docs/getting-started/README.md": [ - { "docs/getting-started/tutorials/README.md": [ - { "docs/getting-started/tutorials/devenv/README.md": [ - { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/getting-started/tutorials/create-block/README.md": [ - { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, - { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, - { "docs/getting-started/tutorials/create-block/attributes.md": [] }, - { "docs/getting-started/tutorials/create-block/block-code.md": [] }, - { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } - ] } - ] }, - { "docs/getting-started/glossary.md": [] }, - { "docs/getting-started/faq.md": [] }, - { "docs/getting-started/history.md": [] }, - { "docs/getting-started/outreach.md": [] } - ] }, - { "docs/howto-guides/README.md": [ - { "docs/howto-guides/javascript/README.md": [ - { "docs/howto-guides/javascript/plugins-background.md": [] }, - { "docs/howto-guides/javascript/loading-javascript.md": [] }, - { "docs/howto-guides/javascript/extending-the-block-editor.md": [] }, - { "docs/howto-guides/javascript/troubleshooting.md": [] }, - { "docs/howto-guides/javascript/versions-and-building.md": [] }, - { "docs/howto-guides/javascript/scope-your-code.md": [] }, - { "docs/howto-guides/javascript/js-build-setup.md": [] }, - { "docs/howto-guides/javascript/esnext-js.md": [] } - ] }, - { "docs/howto-guides/metabox/README.md": [ - { "docs/howto-guides/metabox/meta-block-1-intro.md": [] }, - { "docs/howto-guides/metabox/meta-block-2-register-meta.md": [] }, - { "docs/howto-guides/metabox/meta-block-3-add.md": [] }, - { "docs/howto-guides/metabox/meta-block-4-use-data.md": [] }, - { "docs/howto-guides/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/howto-guides/notices/README.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/howto-guides/block-tutorial/README.md": [ - { "docs/howto-guides/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/howto-guides/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/howto-guides/feature-flags.md": [] }, - { "docs/howto-guides/themes/README.md": [ - { "docs/howto-guides/themes/theme-support.md": [] }, - { "docs/howto-guides/themes/theme-json.md": [] } - ] }, - { "docs/howto-guides/block-based-themes/README.md": [ - { "docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } - ] }, - { "docs/howto-guides/backward-compatibility/README.md": [ - { "docs/howto-guides/backward-compatibility/deprecations.md": [] }, - { "docs/howto-guides/backward-compatibility/meta-box.md": [] } - ] }, +[{ + "docs/getting-started/README.md": [{ + "docs/getting-started/tutorials/README.md": [{ + "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] + }, + { + "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] + } + ] + }, + { "docs/getting-started/glossary.md": [] }, + { "docs/getting-started/faq.md": [] }, + { "docs/getting-started/history.md": [] }, + { "docs/getting-started/outreach.md": [] } + ] + }, + { + "docs/how-to-guides/README.md": [{ + "docs/how-to-guides/javascript/README.md": [ + { "docs/how-to-guides/javascript/plugins-background.md": [] }, + { "docs/how-to-guides/javascript/loading-javascript.md": [] }, + { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/how-to-guides/javascript/troubleshooting.md": [] }, + { "docs/how-to-guides/javascript/versions-and-building.md": [] }, + { "docs/how-to-guides/javascript/scope-your-code.md": [] }, + { "docs/how-to-guides/javascript/js-build-setup.md": [] }, + { "docs/how-to-guides/javascript/esnext-js.md": [] } + ] + }, + { + "docs/how-to-guides/metabox/README.md": [ + { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, + { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } + ] + }, + { "docs/how-to-guides/notices/README.md": [] }, + { + "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] + }, + { + "docs/how-to-guides/block-tutorial/README.md": [ + { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] + }, + { "docs/how-to-guides/feature-flags.md": [] }, + { + "docs/how-to-guides/themes/README.md": [ + { "docs/how-to-guides/themes/theme-support.md": [] }, + { "docs/how-to-guides/themes/theme-json.md": [] } + ] + }, + { + "docs/how-to-guides/block-based-themes/README.md": [ + { "docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] + }, + { + "docs/how-to-guides/backward-compatibility/README.md": [ + { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, + { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } + ] + }, - { "docs/howto-guides/format-api/README.md": [ - { "docs/howto-guides/format-api/1-register-format.md": [] }, - { "docs/howto-guides/format-api/2-toolbar-button.md": [] }, - { "docs/howto-guides/format-api/3-apply-format.md": [] } - ] }, - { "docs/howto-guides/platform/README.md": [ - { "docs/howto-guides/platform/custom-block-editor/README.md": [ - { "docs/howto-guides/platform/custom-block-editor/tutorial.md": [] } - ] } - ] }, - { "docs/howto-guides/designers/README.md": [ - { "docs/howto-guides/designers/block-design.md": [] }, - { "docs/howto-guides/designers/user-interface.md": [] }, - { "docs/howto-guides/designers/design-resources.md": [] }, - { "docs/howto-guides/designers/animation.md": [] } - ] }, - { "docs/howto-guides/accessibility.md": [] }, - { "docs/howto-guides/internationalization.md": [] } - ] }, - { "docs/reference-guides/README.md": [ - { "docs/reference-guides/block-api/README.md": [ - { "docs/reference-guides/block-api/block-registration.md": [] }, - { "docs/reference-guides/block-api/block-edit-save.md": [] }, - { "docs/reference-guides/block-api/block-attributes.md": [] }, - { "docs/reference-guides/block-api/block-context.md": [] }, - { "docs/reference-guides/block-api/block-deprecation.md": [] }, - { "docs/reference-guides/block-api/block-supports.md": [] }, - { "docs/reference-guides/block-api/block-transforms.md": [] }, - { "docs/reference-guides/block-api/block-templates.md": [] }, - { "docs/reference-guides/block-api/block-metadata.md": [] }, - { "docs/reference-guides/block-api/block-patterns.md": [] }, - { "docs/reference-guides/block-api/block-annotations.md": [] }, - { "docs/reference-guides/block-api/versions.md": [] } - ] }, - { "docs/reference-guides/filters/README.md": [ - { "docs/reference-guides/filters/block-filters.md": [] }, - { "docs/reference-guides/filters/editor-filters.md": [] }, - { "docs/reference-guides/filters/parser-filters.md": [] }, - { "docs/reference-guides/filters/autocomplete-filters.md": [] } - ] }, - {"docs/reference-guides/slotfills/README.md": [ - { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, - { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, - { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/reference-guides/richtext.md": [] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/reference-guides/packages.md": "{{packages}}" }, - { "docs/reference-guides/data/README.md": [ - { "docs/reference-guides/data/data-core.md": []}, - { "docs/reference-guides/data/data-core-annotations.md": [] }, - { "docs/reference-guides/data/data-core-blocks.md": [] }, - { "docs/reference-guides/data/data-core-block-editor.md": [] }, - { "docs/reference-guides/data/data-core-editor.md": [] }, - { "docs/reference-guides/data/data-core-edit-post.md": [] }, - { "docs/reference-guides/data/data-core-notices.md": [] }, - { "docs/reference-guides/data/data-core-nux.md": [] }, - { "docs/reference-guides/data/data-core-viewport.md": [] } - ] } - ] }, - { "docs/explanations/README.md": [ + { + "docs/how-to-guides/format-api/README.md": [ + { "docs/how-to-guides/format-api/1-register-format.md": [] }, + { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, + { "docs/how-to-guides/format-api/3-apply-format.md": [] } + ] + }, + { + "docs/how-to-guides/platform/README.md": [{ + "docs/how-to-guides/platform/custom-block-editor/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } + ] + }] + }, + { + "docs/how-to-guides/designers/README.md": [ + { "docs/how-to-guides/designers/block-design.md": [] }, + { "docs/how-to-guides/designers/user-interface.md": [] }, + { "docs/how-to-guides/designers/design-resources.md": [] }, + { "docs/how-to-guides/designers/animation.md": [] } + ] + }, + { "docs/how-to-guides/accessibility.md": [] }, + { "docs/how-to-guides/internationalization.md": [] } + ] + }, + { + "docs/reference-guides/README.md": [{ + "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] + }, + { + "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] + }, + { + "docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ] + }, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { + "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": [] }, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } + ] + } + ] + }, + { + "docs/explanations/README.md": [ - { "docs/explanations/architecture/README.md": [ - { "docs/explanations/architecture/key-concepts.md": [] }, - { "docs/explanations/architecture/data-flow.md": [] }, - { "docs/explanations/architecture/modularity.md": [] }, - { "docs/explanations/architecture/performance.md": [] }, - { "docs/explanations/architecture/automated-testing.md": [] }, - { "docs/explanations/architecture/full-site-editing-templates.md": [] } - ] } - ] }, - { "docs/contributors/README.md": [ - { "docs/contributors/code/develop.md": [ - { "docs/contributors/code/getting-started.md": [] }, - { "docs/contributors/code/git-workflow.md": [] }, - { "docs/contributors/code/coding-guidelines.md": [] }, - { "docs/contributors/code/testing-overview.md": [] }, - { "docs/contributors/code/grammar.md": [] }, - { "docs/contributors/code/scripts.md": [] }, - { "docs/contributors/code/managing-packages.md": [] }, - { "docs/contributors/code/release.md": [] }, - { "docs/contributors/code/native-mobile.md": [] }, - { "docs/contributors/code/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design/design.md": [ - { "docs/contributors/design/the-block.md": [] }, - { "docs/contributors/design/reference.md": [] } - ] }, - { "docs/contributors/documentation/document.md": [ - { "docs/contributors/documentation/copy-guide.md": [] } - ] }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/accessibility-testing.md": [] }, - { "docs/contributors/repository-management.md": [] }, - { "docs/contributors/folder-structure.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/roadmap.md": [] } - ] } -] + { + "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] + } + ] + }, + { + "docs/contributors/README.md": [{ + "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] + }, + { + "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] + }, + { + "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } + ] + }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] + } +] \ No newline at end of file From d953969de2f6a14d87bde4d6df63e6b7bfc4b3f3 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:31:17 +0100 Subject: [PATCH 17/68] Use relative link for slotfills README --- docs/how-to-guides/platform/custom-block-editor/tutorial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/platform/custom-block-editor/tutorial.md b/docs/how-to-guides/platform/custom-block-editor/tutorial.md index eef731317b1cf..62702baab2e2c 100644 --- a/docs/how-to-guides/platform/custom-block-editor/tutorial.md +++ b/docs/how-to-guides/platform/custom-block-editor/tutorial.md @@ -279,7 +279,7 @@ Here we are scaffolding the core of the editor's layout alongside a few speciali Let's examine these in more detail: * `` - enables the use of the ["Slot/Fill" - pattern](https://github.com/WordPress/gutenberg/blob/e38dbe958c04d8089695eb686d4f5caff2707505/docs/designers-developers/developers/slotfills/README.md) through our component tree. + pattern](/docs/reference-guides/slotfills/README.md) through our component tree. * `` - enables the use of [dropzones for drag and drop functionality](https://github.com/WordPress/gutenberg/tree/e38dbe958c04d8089695eb686d4f5caff2707505/packages/components/src/drop-zone). * `` - custom component. Provides a "snack bar" Notice that will be rendered if any messages are dispatched to `core/notices` store. * `
` - renders the static title "Standalone Block Editor" at the top of the From 5a5d731acf9a3199f6d66ad5ec274e681ccb7007 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:33:31 +0100 Subject: [PATCH 18/68] Move assets folder to /docs directory --- .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin docs/{how-to-guides => }/assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../assets/js-tutorial-console-log-success.png | Bin .../assets/js-tutorial-error-blocks-undefined.png | Bin .../plugin-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../assets/plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin docs/{how-to-guides => }/assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin 18 files changed, 0 insertions(+), 0 deletions(-) rename docs/{how-to-guides => }/assets/fancy-quote-in-inspector.png (100%) rename docs/{how-to-guides => }/assets/fancy-quote-with-style.png (100%) rename docs/{how-to-guides => }/assets/inspector.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-console-log-error.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-console-log-success.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{how-to-guides => }/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{how-to-guides => }/assets/plugin-more-menu-item.png (100%) rename docs/{how-to-guides => }/assets/plugin-post-publish-panel.png (100%) rename docs/{how-to-guides => }/assets/plugin-post-status-info-location.png (100%) rename docs/{how-to-guides => }/assets/plugin-pre-publish-panel.png (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-closed-state.png (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-open-state.png (100%) rename docs/{how-to-guides => }/assets/sidebar-style-and-controls.png (100%) rename docs/{how-to-guides => }/assets/sidebar-up-and-running.png (100%) rename docs/{how-to-guides => }/assets/toolbar-text.png (100%) rename docs/{how-to-guides => }/assets/toolbar-with-custom-button.png (100%) diff --git a/docs/how-to-guides/assets/fancy-quote-in-inspector.png b/docs/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/how-to-guides/assets/fancy-quote-in-inspector.png rename to docs/assets/fancy-quote-in-inspector.png diff --git a/docs/how-to-guides/assets/fancy-quote-with-style.png b/docs/assets/fancy-quote-with-style.png similarity index 100% rename from docs/how-to-guides/assets/fancy-quote-with-style.png rename to docs/assets/fancy-quote-with-style.png diff --git a/docs/how-to-guides/assets/inspector.png b/docs/assets/inspector.png similarity index 100% rename from docs/how-to-guides/assets/inspector.png rename to docs/assets/inspector.png diff --git a/docs/how-to-guides/assets/js-tutorial-console-log-error.png b/docs/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-console-log-error.png rename to docs/assets/js-tutorial-console-log-error.png diff --git a/docs/how-to-guides/assets/js-tutorial-console-log-success.png b/docs/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-console-log-success.png rename to docs/assets/js-tutorial-console-log-success.png diff --git a/docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png b/docs/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png rename to docs/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png b/docs/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/how-to-guides/assets/plugin-more-menu-item.png b/docs/assets/plugin-more-menu-item.png similarity index 100% rename from docs/how-to-guides/assets/plugin-more-menu-item.png rename to docs/assets/plugin-more-menu-item.png diff --git a/docs/how-to-guides/assets/plugin-post-publish-panel.png b/docs/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/how-to-guides/assets/plugin-post-publish-panel.png rename to docs/assets/plugin-post-publish-panel.png diff --git a/docs/how-to-guides/assets/plugin-post-status-info-location.png b/docs/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/how-to-guides/assets/plugin-post-status-info-location.png rename to docs/assets/plugin-post-status-info-location.png diff --git a/docs/how-to-guides/assets/plugin-pre-publish-panel.png b/docs/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/how-to-guides/assets/plugin-pre-publish-panel.png rename to docs/assets/plugin-pre-publish-panel.png diff --git a/docs/how-to-guides/assets/plugin-sidebar-closed-state.png b/docs/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-closed-state.png rename to docs/assets/plugin-sidebar-closed-state.png diff --git a/docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif b/docs/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif rename to docs/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/how-to-guides/assets/plugin-sidebar-open-state.png b/docs/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-open-state.png rename to docs/assets/plugin-sidebar-open-state.png diff --git a/docs/how-to-guides/assets/sidebar-style-and-controls.png b/docs/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/how-to-guides/assets/sidebar-style-and-controls.png rename to docs/assets/sidebar-style-and-controls.png diff --git a/docs/how-to-guides/assets/sidebar-up-and-running.png b/docs/assets/sidebar-up-and-running.png similarity index 100% rename from docs/how-to-guides/assets/sidebar-up-and-running.png rename to docs/assets/sidebar-up-and-running.png diff --git a/docs/how-to-guides/assets/toolbar-text.png b/docs/assets/toolbar-text.png similarity index 100% rename from docs/how-to-guides/assets/toolbar-text.png rename to docs/assets/toolbar-text.png diff --git a/docs/how-to-guides/assets/toolbar-with-custom-button.png b/docs/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/how-to-guides/assets/toolbar-with-custom-button.png rename to docs/assets/toolbar-with-custom-button.png From 216848c2c420ce42bc0bdf03095f1ab4d23b38e5 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:34:52 +0100 Subject: [PATCH 19/68] Update links to general assets --- .../block-tutorial/block-controls-toolbar-and-sidebar.md | 4 ++-- docs/how-to-guides/format-api/2-toolbar-button.md | 2 +- docs/how-to-guides/javascript/extending-the-block-editor.md | 4 ++-- docs/how-to-guides/javascript/loading-javascript.md | 2 +- docs/how-to-guides/javascript/troubleshooting.md | 4 ++-- .../sidebar-tutorial/plugin-sidebar-1-up-and-running.md | 2 +- .../sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md | 2 +- .../slotfills/plugin-block-settings-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-more-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-post-publish-panel.md | 2 +- docs/reference-guides/slotfills/plugin-post-status-info.md | 2 +- docs/reference-guides/slotfills/plugin-pre-publish-panel.md | 2 +- .../slotfills/plugin-sidebar-more-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-sidebar.md | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md index fc049da2f65fe..957104508fdd2 100644 --- a/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md +++ b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md @@ -4,7 +4,7 @@ To simplify block customization and ensure a consistent experience for users, th ## Block Toolbar -![Screenshot of the rich text toolbar applied to a Paragraph block inside the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/toolbar-text.png) +![Screenshot of the rich text toolbar applied to a Paragraph block inside the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/toolbar-text.png) When the user selects a block, a number of control buttons may be shown in a toolbar above the selected block. Some of these block-level controls are included automatically if the editor is able to transform the block to another type, or if the focused element is a RichText component. @@ -194,7 +194,7 @@ Note that `BlockControls` is only visible when the block is currently selected a ## Inspector -![Screenshot of the inspector panel focused on the settings for a Paragraph block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/inspector.png) +![Screenshot of the inspector panel focused on the settings for a Paragraph block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/inspector.png) The Settings Sidebar is used to display less-often-used settings or settings that require more screen space. The Settings Sidebar should be used for **block-level settings only**. diff --git a/docs/how-to-guides/format-api/2-toolbar-button.md b/docs/how-to-guides/format-api/2-toolbar-button.md index 4c669ed1da1ef..4d64c1e7dcee3 100644 --- a/docs/how-to-guides/format-api/2-toolbar-button.md +++ b/docs/how-to-guides/format-api/2-toolbar-button.md @@ -59,7 +59,7 @@ registerFormatType( Let's check that everything is working as expected. Reload the post/page and select a text block. Make sure that the new button was added to the format toolbar, it uses the [editor-code dashicon](https://developer.wordpress.org/resource/dashicons/#editor-code), and the hover text is what you set in the title: -![Toolbar with custom button](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/toolbar-with-custom-button.png) +![Toolbar with custom button](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/toolbar-with-custom-button.png) You may also want to check that upon clicking the button the `toggle format` message is shown in your browser's console. diff --git a/docs/how-to-guides/javascript/extending-the-block-editor.md b/docs/how-to-guides/javascript/extending-the-block-editor.md index 0609d78aa958e..0a32b380318a8 100644 --- a/docs/how-to-guides/javascript/extending-the-block-editor.md +++ b/docs/how-to-guides/javascript/extending-the-block-editor.md @@ -39,7 +39,7 @@ Add a quote block, and in the right sidebar under Styles, you will see your new Click the Fancy Quote to select and apply that style to your quote block: -![Fancy Quote Style in Inspector](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/fancy-quote-in-inspector.png) +![Fancy Quote Style in Inspector](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/fancy-quote-in-inspector.png) Even if you Preview or Publish the post you will not see a visible change. However, if you look at the source, you will see the `is-style-fancy-quote` class name is now attached to your quote block. @@ -63,4 +63,4 @@ add_action( 'enqueue_block_assets', 'myguten_stylesheet' ); Now when you view in the editor and publish, you will see your Fancy Quote style, a delicious tomato color text: -![Fancy Quote with Style](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/fancy-quote-with-style.png) +![Fancy Quote with Style](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/fancy-quote-with-style.png) diff --git a/docs/how-to-guides/javascript/loading-javascript.md b/docs/how-to-guides/javascript/loading-javascript.md index e89c359fee820..c029d198c08f2 100644 --- a/docs/how-to-guides/javascript/loading-javascript.md +++ b/docs/how-to-guides/javascript/loading-javascript.md @@ -28,7 +28,7 @@ We'll check the JavaScript console in your browser's Developer Tools, to see if If your code is registered and enqueued correctly, you should see a message in your console: -![Console Log Message Success](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/js-tutorial-console-log-success.png) +![Console Log Message Success](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/js-tutorial-console-log-success.png) **Note for Theme Developers:** The above method of enqueuing is used for plugins. If you are extending the block editor for your theme there is a minor difference, you will use the `get_template_directory_uri()` function instead of `plugins_url()`. So for a theme, the enqueue example is: diff --git a/docs/how-to-guides/javascript/troubleshooting.md b/docs/how-to-guides/javascript/troubleshooting.md index 30179342bc5ac..7fe4784bf30ab 100644 --- a/docs/how-to-guides/javascript/troubleshooting.md +++ b/docs/how-to-guides/javascript/troubleshooting.md @@ -19,7 +19,7 @@ To open the JavaScript console, find the correct key combination for your broswe Your first step in debugging should be to check the JavaScript console for any errors. Here is an example, which shows a syntax error on line 6: -![console error](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/js-tutorial-console-log-error.png) +![console error](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/js-tutorial-console-log-error.png) ### Display your message in console log @@ -61,7 +61,7 @@ Add a test message to confirm your JavaScript is loading, add a `console.log("He The console log will show an error if a dependency your JavaScript code uses has not been declared and loaded in the browser. In the JavaScript tutorial example, if `myguten.js` script is enqueued without declaring the `wp-blocks` dependency, the console log will show: - + You can correct by checking your `wp_enqueue_script` function includes all packages listed that are used: diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md index 17fdc3cad62de..0f7a9410b7859 100644 --- a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md @@ -53,4 +53,4 @@ add_action( 'enqueue_block_editor_assets', 'sidebar_plugin_script_enqueue' ); After installing and activating this plugin, there is a new icon resembling a tack in the top-right of the editor. Upon clicking it, the plugin's sidebar will be opened: -![Sidebar Up and Running](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/sidebar-up-and-running.png) +![Sidebar Up and Running](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/sidebar-up-and-running.png) diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md index 18016e37f0337..841c9f1153446 100644 --- a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md @@ -92,6 +92,6 @@ add_action( 'enqueue_block_assets', 'sidebar_plugin_style_enqueue' ); Reload the editor and open the sidebar: -![Sidebar with style and controls](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/sidebar-style-and-controls.png) +![Sidebar with style and controls](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/sidebar-style-and-controls.png) With the input control and the styling the sidebar looks nicer. This code doesn't let users to store or retrieve data just yet, so the next steps will focus on how to connect it to the meta block field. diff --git a/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md index 302730dfd74a5..0c1e490f60ef1 100644 --- a/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md @@ -27,4 +27,4 @@ registerPlugin( 'block-settings-menu-group-test', { ## Location -![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png?raw=true "PluginBlockSettingsMenuItem Location") +![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-block-settings-menu-item-screenshot.png?raw=true "PluginBlockSettingsMenuItem Location") diff --git a/docs/reference-guides/slotfills/plugin-more-menu-item.md b/docs/reference-guides/slotfills/plugin-more-menu-item.md index 4656dbde9af93..6a53c029b10dd 100644 --- a/docs/reference-guides/slotfills/plugin-more-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-more-menu-item.md @@ -25,4 +25,4 @@ registerPlugin( 'more-menu-item-test', { render: MyButtonMoreMenuItemTest } ); ## Location -![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-more-menu-item.png?raw=true) +![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-more-menu-item.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-post-publish-panel.md b/docs/reference-guides/slotfills/plugin-post-publish-panel.md index 8dd63661ad448..bc05328f4f554 100644 --- a/docs/reference-guides/slotfills/plugin-post-publish-panel.md +++ b/docs/reference-guides/slotfills/plugin-post-publish-panel.md @@ -21,5 +21,5 @@ registerPlugin( 'post-publish-panel-test', { ## Location -![post publish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-post-publish-panel.png?raw=true) +![post publish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-post-publish-panel.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-post-status-info.md b/docs/reference-guides/slotfills/plugin-post-status-info.md index f1acf64cd7cc5..3cf62b772350c 100644 --- a/docs/reference-guides/slotfills/plugin-post-status-info.md +++ b/docs/reference-guides/slotfills/plugin-post-status-info.md @@ -19,5 +19,5 @@ registerPlugin( 'post-status-info-test', { render: PluginPostStatusInfoTest } ); ## Location -![Location in the Status & visibility panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-post-status-info-location.png?raw=true) +![Location in the Status & visibility panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-post-status-info-location.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-pre-publish-panel.md b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md index 8cd6908adb87d..5c71d43161f61 100644 --- a/docs/reference-guides/slotfills/plugin-pre-publish-panel.md +++ b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md @@ -21,5 +21,5 @@ registerPlugin( 'pre-publish-panel-test', { ## Location -![Prepublish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-pre-publish-panel.png?raw=true) +![Prepublish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-pre-publish-panel.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md index 57419296b30e9..8ede72e782b02 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md @@ -29,4 +29,4 @@ registerPlugin( 'plugin-sidebar-expanded-test', { ## Location -![Interaction](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif?raw=true) +![Interaction](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-more-menu-item.gif?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md index 71bbead0a3bbf..b557712fda74d 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar.md +++ b/docs/reference-guides/slotfills/plugin-sidebar.md @@ -23,7 +23,7 @@ registerPlugin( 'plugin-sidebar-test', { render: PluginSidebarTest } ); ### Closed State -![Closed State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-sidebar-closed-state.png?raw=true) +![Closed State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-closed-state.png?raw=true) ### Open State From d504dc46f90e0ed9278036113caaa374d9648bc2 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:36:12 +0100 Subject: [PATCH 20/68] Update links to designers assets --- docs/how-to-guides/designers/block-design.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/how-to-guides/designers/block-design.md b/docs/how-to-guides/designers/block-design.md index 818dd4436962d..256516b77215a 100644 --- a/docs/how-to-guides/designers/block-design.md +++ b/docs/how-to-guides/designers/block-design.md @@ -64,11 +64,11 @@ When referring to a block in documentation or UI, use title case for the block t Blocks should have an identifying icon, ideally using a single color. Try to avoid using the same icon used by an existing block. The core block icons are based on [Material Design Icons](https://material.io/tools/icons/). Look to that icon set, or to [Dashicons](https://developer.wordpress.org/resource/dashicons/) for style inspiration. -![A screenshot of the block library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/blocks-do.png) +![A screenshot of the block library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-do.png) **Do:** Use concise block names. -![A screenshot of the block library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/blocks-dont.png) +![A screenshot of the block library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-dont.png) **Don't:** Avoid long, multi-line block names. @@ -84,11 +84,11 @@ Stick to a single imperative sentence with an action + subject format. Examples: - Introduce new sections and organize content to help visitors (and search engines) understand the structure of your content. - Create a bulleted or numbered list. -![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-descriptions-do.png) +![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-do.png) **Do:** Use a short, simple block description. -![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-descriptions-dont.png) +![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-dont.png) **Don't:** Avoid long descriptions and branding. @@ -96,11 +96,11 @@ Avoid long descriptions and branding. If your block requires a user to configure some options before you can display it, you should provide an instructive placeholder state. -![A screenshot of the Gallery block's placeholder](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/placeholder-do.png) +![A screenshot of the Gallery block's placeholder](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-do.png) **Do:** Provide an instructive placeholder state. -![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/placeholder-dont.png) +![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-dont.png) **Don't:** Avoid branding and relying on the title alone to convey instructions. @@ -110,11 +110,11 @@ When unselected, your block should preview its content as closely to the front-e When selected, your block may surface additional options like input fields or buttons to configure the block directly, especially when they are necessary for basic operation. -![A Google Maps block with inline, always-accessible controls required for the block to function](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-controls-do.png) +![A Google Maps block with inline, always-accessible controls required for the block to function](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-do.png) **Do:** For controls that are essential for the operation of the block, provide them directly inside the block edit view. -![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-controls-dont.png) +![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-dont.png) **Don't:** Do not put controls that are essential to the block in the sidebar, otherwise the block will appear non-functional to mobile users or desktop users who have dismissed the sidebar. @@ -122,7 +122,7 @@ Do not put controls that are essential to the block in the sidebar, otherwise th The “Block” tab of the Settings Sidebar can contain additional block options and configuration. Keep in mind that a user can dismiss the sidebar and never use it. You should not put critical options in the Sidebar. -![A screenshot of the Paragraph block's advanced settings in the sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/advanced-settings-do.png) +![A screenshot of the Paragraph block's advanced settings in the sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/advanced-settings-do.png) **Do:** Because the Drop Cap feature is not necessary for the basic operation of the block, you can put it to the Block tab as optional configuration. From b8bdf8dcb6b21c5069a050fe022bbe184aef711b Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:41:51 +0100 Subject: [PATCH 21/68] Update assets links --- docs/how-to-guides/metabox/meta-block-3-add.md | 2 +- docs/how-to-guides/notices/README.md | 4 ++-- docs/reference-guides/slotfills/plugin-sidebar.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to-guides/metabox/meta-block-3-add.md b/docs/how-to-guides/metabox/meta-block-3-add.md index aa138b1418d3c..6dec512aea7ab 100644 --- a/docs/how-to-guides/metabox/meta-block-3-add.md +++ b/docs/how-to-guides/metabox/meta-block-3-add.md @@ -136,6 +136,6 @@ add_action( 'enqueue_block_editor_assets', 'myguten_enqueue' ); You can now edit a draft post and add a Meta Block to the post. You will see your field that you can type a value in. When you save the post, either as a draft or published, the post meta value will be saved too. You can verify by saving and reloading your draft, the form will still be filled in on reload. -![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) +![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/metabox/meta-block.png) You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/how-to-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/how-to-guides/notices/README.md b/docs/how-to-guides/notices/README.md index 85e2aa1acc61a..de9867307b5ac 100644 --- a/docs/how-to-guides/notices/README.md +++ b/docs/how-to-guides/notices/README.md @@ -8,7 +8,7 @@ In the classic editor, notices hooked onto the `admin_notices` action can render In the classic editor, here's an example of the "Post draft updated" notice: -![Post draft updated in the classic editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png) +![Post draft updated in the classic editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/notices/classic-editor-notice.png) Producing an equivalent "Post draft updated" notice would require code like this: @@ -39,7 +39,7 @@ Importantly, the `admin_notices` hook allows a developer to render whatever HTML In the block editor, here's an example of the "Post published" notice: -![Post published in the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/notices/block-editor-notice.png) +![Post published in the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/notices/block-editor-notice.png) Producing an equivalent "Post published" notice would require code like this: diff --git a/docs/reference-guides/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md index b557712fda74d..56d87ea1fc1be 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar.md +++ b/docs/reference-guides/slotfills/plugin-sidebar.md @@ -27,4 +27,4 @@ registerPlugin( 'plugin-sidebar-test', { render: PluginSidebarTest } ); ### Open State -![Open State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers//assets/plugin-sidebar-open-state.png?raw=true) +![Open State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-open-state.png?raw=true) From 5b06965bc98c8bf1e83df5eb2a69b22f4b2d6077 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:55:05 +0100 Subject: [PATCH 22/68] Update reference guides README --- docs/reference-guides/README.md | 53 +++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md index e69de29bb2d1d..b470e8d8ee455 100644 --- a/docs/reference-guides/README.md +++ b/docs/reference-guides/README.md @@ -0,0 +1,53 @@ +# Reference Guides + +## Block API Reference + +- [Block registration](/docs/reference-guides/block-api/block-registration.md) +- [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) +- [Attributes](/docs/reference-guides/block-api/block-attributes.md) +- [Context](/docs/reference-guides/block-api/block-context.md) +- [Deprecation](/docs/reference-guides/block-api/block-deprecation.md) +- [Supports](/docs/reference-guides/block-api/block-supports.md) +- [Transformations](/docs/reference-guides/block-api/block-transforms.md) +- [Templates](/docs/reference-guides/block-api/block-templates.md) +- [Metadata](/docs/reference-guides/block-api/block-metadata.md) +- [Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Annotations](/docs/reference-guides/block-api/block-annotations.md) +- [Versions](/docs/reference-guides/block-api/versions.md) + +## Filter Reference + +- [Block Filters](/docs/reference-guides/filters/block-filters.md) +- [Editor Filters (Experimental)](/docs/reference-guides/filters/editor-filters.md) +- [Parser Filters](/docs/reference-guides/filters/parser-filters.md) +- [Autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) + +## SlotFills Reference + +- [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) +- [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) +- [PluginDocumentSettingPanel](/docs/reference-guides/slotfills/plugin-document-setting-panel.md) +- [PluginMoreMenuItem](/docs/reference-guides/slotfills/plugin-more-menu-item.md) +- [PluginPostPublishPanel](/docs/reference-guides/slotfills/plugin-post-publish-panel.md) +- [PluginPostStatusInfo](/docs/reference-guides/slotfills/plugin-post-status-info.md) +- [PluginPrePublishPanel](/docs/reference-guides/slotfills/plugin-pre-publish-panel.md) +- [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) +- [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) + +## RichText Reference + +## Component Reference + +## Package Reference + +## Data Module Reference + +- [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) + - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) + - [**core/blocks**: Block Types Data](/docs/reference-guides/data/data-core-blocks.md) + - [**core/block-editor**: The Block Editor’s Data](/docs/reference-guides/data/data-core-block-editor.md) + - [**core/editor**: The Post Editor’s Data](/docs/reference-guides/data/data-core-editor.md) + - [**core/edit-post**: The Editor’s UI Data](/docs/reference-guides/data/data-core-edit-post.md) + - [**core/notices**: Notices Data](/docs/reference-guides/data/data-core-notices.md) + - [**core/nux**: The NUX (New User Experience) Data](/docs/reference-guides/data/data-core-nux.md) + - [**core/viewport**: The Viewport Data](/docs/reference-guides/data/data-core-viewport.md) From 330f795ce61215fd7d169a84f146bddd54e7e127 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:06:09 +0100 Subject: [PATCH 23/68] Update reference guides readme --- docs/reference-guides/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md index b470e8d8ee455..39c6733bbb4fd 100644 --- a/docs/reference-guides/README.md +++ b/docs/reference-guides/README.md @@ -1,6 +1,6 @@ # Reference Guides -## Block API Reference +## [Block API Reference](/docs/reference-guides/block-api/README.md) - [Block registration](/docs/reference-guides/block-api/block-registration.md) - [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) @@ -15,14 +15,14 @@ - [Annotations](/docs/reference-guides/block-api/block-annotations.md) - [Versions](/docs/reference-guides/block-api/versions.md) -## Filter Reference +## [Filter Reference](/docs/reference-guides/filters/README.md) - [Block Filters](/docs/reference-guides/filters/block-filters.md) - [Editor Filters (Experimental)](/docs/reference-guides/filters/editor-filters.md) - [Parser Filters](/docs/reference-guides/filters/parser-filters.md) - [Autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) -## SlotFills Reference +## [SlotFills Reference](/docs/reference-guides/slotfills/README.md) - [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) - [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) @@ -34,13 +34,13 @@ - [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) - [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) -## RichText Reference +## [RichText Reference](/docs/reference-guides/richtext.md) -## Component Reference +## [Component Reference](/packages/components/README.md) -## Package Reference +## [Package Reference](/docs/reference-guides/packages.md) -## Data Module Reference +## [Data Module Reference](/docs/reference-guides/data/README.md) - [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) From e1fc1633369458c458fa1e49ce7651269a596317 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:09:52 +0100 Subject: [PATCH 24/68] Update explanations readme --- docs/explanations/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/explanations/README.md b/docs/explanations/README.md index e69de29bb2d1d..6a0e4899560ac 100644 --- a/docs/explanations/README.md +++ b/docs/explanations/README.md @@ -0,0 +1,12 @@ +# Explanation + +## [Architecture](/docs/explanations/architecture/README.md) + +- [Key Concepts](/docs/explanations/architecture/key-concepts.md) +- [Data Format And Data Flow](/docs/explanations/architecture/data-flow.md) +- [Modularity and WordPress Packages](/docs/explanations/architecture/modularity.md). +- [Block Editor Performance](/docs/explanations/architecture/performance.md). +- What are the decision decisions behind the Data Module? +- [Why is Puppeteer the tool of choice for end-to-end tests?](/docs/explanations/architecture/automated-testing.md) +- [What’s the difference between the different editor packages? What’s the purpose of each package?](/docs/explanations/architecture/modularity.md/#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package) +- [Template and template parts flows](/docs/explanations/architecture/full-site-editing-templates.md) From 939f8ac26286b67dc5a4682c4ab8ed217406ddce Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:11:00 +0100 Subject: [PATCH 25/68] Update explanations readme --- docs/explanations/README.md | 2 +- docs/manifest.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/explanations/README.md b/docs/explanations/README.md index 6a0e4899560ac..04d9f8e9e15b5 100644 --- a/docs/explanations/README.md +++ b/docs/explanations/README.md @@ -1,4 +1,4 @@ -# Explanation +# Explanations ## [Architecture](/docs/explanations/architecture/README.md) diff --git a/docs/manifest.json b/docs/manifest.json index 4fcc8896476d7..53c8fd554bf18 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -420,7 +420,7 @@ "parent": "how-to-guides" }, { - "title": "ReferenceGuides", + "title": "Reference Guides", "slug": "reference-guides", "markdown_source": "../docs/reference-guides/README.md", "parent": null From ddc805d1b453aee93e6cdc7fa65179f4e47a84d6 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:29:34 +0100 Subject: [PATCH 26/68] Use relative links --- docs/getting-started/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 33742d31259e1..86824cca8561f 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -320,7 +320,7 @@ Blocks are able to provide base structural CSS styles, and themes can add styles Other features, like the new _wide_ and _full-wide_ alignment options, are simply CSS classes applied to blocks that offer this alignment. We are looking at how a theme can opt in to this feature, for example using `add_theme_support`. -This is currently a work in progress and we recommend reviewing the [block based theme documentation](https://developer.wordpress.org/block-editor/tutorials/block-based-themes/) to learn more. +This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-themes/README.md) to learn more. ## What are block variations? Are they the same as block styles? From 2aa06c01eb64bded190425bc3637ed668b86f7d8 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:35:04 +0100 Subject: [PATCH 27/68] Rename how-to-guides/block-based-themes to how-to-guides/block-based-theme --- docs/getting-started/faq.md | 2 +- .../README.md | 12 ++++++------ .../block-based-themes-2-adding-blocks.md | 0 docs/manifest.json | 8 ++++---- docs/toc.json | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) rename docs/how-to-guides/{block-based-themes => block-based-theme}/README.md (95%) rename docs/how-to-guides/{block-based-themes => block-based-theme}/block-based-themes-2-adding-blocks.md (100%) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 86824cca8561f..eb643f4229fac 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -320,7 +320,7 @@ Blocks are able to provide base structural CSS styles, and themes can add styles Other features, like the new _wide_ and _full-wide_ alignment options, are simply CSS classes applied to blocks that offer this alignment. We are looking at how a theme can opt in to this feature, for example using `add_theme_support`. -This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-themes/README.md) to learn more. +This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-theme/README.md) to learn more. ## What are block variations? Are they the same as block styles? diff --git a/docs/how-to-guides/block-based-themes/README.md b/docs/how-to-guides/block-based-theme/README.md similarity index 95% rename from docs/how-to-guides/block-based-themes/README.md rename to docs/how-to-guides/block-based-theme/README.md index 310ec28a3ec7a..e106ac9d71d5a 100644 --- a/docs/how-to-guides/block-based-themes/README.md +++ b/docs/how-to-guides/block-based-theme/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-theme/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-theme/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-theme/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) diff --git a/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md b/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md similarity index 100% rename from docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md rename to docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md diff --git a/docs/manifest.json b/docs/manifest.json index 53c8fd554bf18..beff69756b36c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -307,15 +307,15 @@ }, { "title": "Creating a block-based theme", - "slug": "block-based-themes", - "markdown_source": "../docs/how-to-guides/block-based-themes/README.md", + "slug": "block-based-theme", + "markdown_source": "../docs/how-to-guides/block-based-theme/README.md", "parent": "how-to-guides" }, { "title": "Adding blocks to your theme", "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md", - "parent": "block-based-themes" + "markdown_source": "../docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md", + "parent": "block-based-theme" }, { "title": "Backward Compatibility", diff --git a/docs/toc.json b/docs/toc.json index a76aa93d03210..1fcd886bc3424 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -75,8 +75,8 @@ ] }, { - "docs/how-to-guides/block-based-themes/README.md": [ - { "docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + "docs/how-to-guides/block-based-theme/README.md": [ + { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } ] }, { From eecc010a1c46c7be66982ca37f15b6c0363a99d8 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:51:13 +0100 Subject: [PATCH 28/68] Move the main readme to /docs --- docs/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000..0f91f0036e907 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,42 @@ +# Getting started + +**Gutenberg** is a codename for a whole new paradigm in WordPress site building and publishing, that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. The project is right now in the second phase of a four-phase process that will touch every piece of WordPress -- Editing, **Customization** (which includes Full Site Editing, Block Patterns, Block Directory and Block based themes), Collaboration, and Multilingual -- and is focused on a new editing experience, the block editor (which is the topic of the current documentation). + +![Quick view of the block editor](https://make.wordpress.org/core/files/2021/01/quick-view-of-the-block-editor.png) + +**Legend :** + +1. Block Inserter +2. Block editor content area +3. Settings Sidebar + +Using a system of Blocks to compose and format content, the new block-based editor is designed to create rich, flexible layouts for websites and digital products. Content is created in the unit of blocks instead of freeform text with inserted media, embeds and Shortcodes (there's a Shortcode block though). + +Blocks treat Paragraphs, Headings, Media, and Embeds all as components that, when strung together, make up the content stored in the WordPress database, replacing the traditional concept of freeform text with embedded media and shortcodes. The new editor is designed with progressive enhancement, meaning that it is back-compatible with all legacy content, and it also offers a process to try to convert and split a Classic block into equivalent blocks using client-side parsing. Finally, the blocks offer enhanced editing and format controls. + +The Editor offers rich new value to users with visual, drag-and-drop creation tools and powerful developer enhancements with modern vendor packages, reusable components, rich APIs and hooks to modify and extend the editor through Custom Blocks, Custom Block Styles and Plugins. + +[Learn to use the block editor](https://wordpress.org/support/article/wordpress-editor/) to create media-rich posts and pages. + +## Quick links + +### Create a Block Tutorial + +[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. + +### Develop for the block editor + +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. + +- [Gutenberg Architecture](/docs/architecture/readme.md) +- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) +- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) +- [Block API Reference](/docs/reference-guides/block-api/readme.md) +- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) +- [Internationalization](/docs/how-to-guides/internationalization.md) + +### Contribute to the block editor + +Everything you need to know to [start contributing to the block editor](/docs/contributors/readme.md) . Whether you are interested in the design, code, triage, documentation, support or internationalization of the block editor, you will find here guides to help you. + From 3460f07dd2098dc26eee6ac719267bf118c8939f Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:51:45 +0100 Subject: [PATCH 29/68] Update getting started readme --- docs/getting-started/README.md | 44 +++++++--------------------------- 1 file changed, 8 insertions(+), 36 deletions(-) diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 0f91f0036e907..82eb07d95d985 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -1,42 +1,14 @@ -# Getting started +# Getting Started -**Gutenberg** is a codename for a whole new paradigm in WordPress site building and publishing, that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. The project is right now in the second phase of a four-phase process that will touch every piece of WordPress -- Editing, **Customization** (which includes Full Site Editing, Block Patterns, Block Directory and Block based themes), Collaboration, and Multilingual -- and is focused on a new editing experience, the block editor (which is the topic of the current documentation). +## [Tutorials](/docs/getting-started/tutorials/README.md) -![Quick view of the block editor](https://make.wordpress.org/core/files/2021/01/quick-view-of-the-block-editor.png) +- [Development Environment](/docs/getting-started/tutorials/devenv/README.md) +- [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/README.md) -**Legend :** +## [Glossary](/docs/getting-started/glossary.md) -1. Block Inserter -2. Block editor content area -3. Settings Sidebar +## [FAQ](/docs/getting-started/faq.md) -Using a system of Blocks to compose and format content, the new block-based editor is designed to create rich, flexible layouts for websites and digital products. Content is created in the unit of blocks instead of freeform text with inserted media, embeds and Shortcodes (there's a Shortcode block though). - -Blocks treat Paragraphs, Headings, Media, and Embeds all as components that, when strung together, make up the content stored in the WordPress database, replacing the traditional concept of freeform text with embedded media and shortcodes. The new editor is designed with progressive enhancement, meaning that it is back-compatible with all legacy content, and it also offers a process to try to convert and split a Classic block into equivalent blocks using client-side parsing. Finally, the blocks offer enhanced editing and format controls. - -The Editor offers rich new value to users with visual, drag-and-drop creation tools and powerful developer enhancements with modern vendor packages, reusable components, rich APIs and hooks to modify and extend the editor through Custom Blocks, Custom Block Styles and Plugins. - -[Learn to use the block editor](https://wordpress.org/support/article/wordpress-editor/) to create media-rich posts and pages. - -## Quick links - -### Create a Block Tutorial - -[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. - -### Develop for the block editor - -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - -- [Gutenberg Architecture](/docs/architecture/readme.md) -- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) -- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) -- [Block API Reference](/docs/reference-guides/block-api/readme.md) -- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) -- [Internationalization](/docs/how-to-guides/internationalization.md) - -### Contribute to the block editor - -Everything you need to know to [start contributing to the block editor](/docs/contributors/readme.md) . Whether you are interested in the design, code, triage, documentation, support or internationalization of the block editor, you will find here guides to help you. +## [History](/docs/getting-started/history.md) +## [Outreach](/docs/getting-started/outreach.md) From c2d7ebcfaaf21e2c11123c2858c1437c5b0605da Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:55:12 +0100 Subject: [PATCH 30/68] Update manifest.json --- docs/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index beff69756b36c..d1d1c611fdf2f 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ [ { - "title": "Getting started", + "title": "Getting Started", "slug": "getting-started", "markdown_source": "../docs/getting-started/README.md", "parent": null From 1bdb7e4202b0f89074ca92af0fb843c2518c1031 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 12:24:01 +0100 Subject: [PATCH 31/68] CS updates on toc.json --- docs/manifest.json | 8 +- docs/toc.json | 386 ++++++++++++++++++++------------------------- 2 files changed, 177 insertions(+), 217 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index d1d1c611fdf2f..099e0bdcc92d3 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,9 +1,15 @@ [ + { + "title": "Getting started", + "slug": "handbook", + "markdown_source": "../docs/readme.md", + "parent": null + }, { "title": "Getting Started", "slug": "getting-started", "markdown_source": "../docs/getting-started/README.md", - "parent": null + "parent": "handbook" }, { "title": "Tutorials", diff --git a/docs/toc.json b/docs/toc.json index 1fcd886bc3424..11045fd3cdb1e 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,221 +1,175 @@ -[{ - "docs/getting-started/README.md": [{ - "docs/getting-started/tutorials/README.md": [{ - "docs/getting-started/tutorials/devenv/README.md": [ - { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } - ] - }, - { - "docs/getting-started/tutorials/create-block/README.md": [ - { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, - { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, - { "docs/getting-started/tutorials/create-block/attributes.md": [] }, - { "docs/getting-started/tutorials/create-block/block-code.md": [] }, - { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } - ] - } - ] - }, +[ + { "docs/readme.md": [ + { "docs/getting-started/README.md": [ + { "docs/getting-started/tutorials/README.md": [ + { "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] } + ] }, { "docs/getting-started/glossary.md": [] }, { "docs/getting-started/faq.md": [] }, { "docs/getting-started/history.md": [] }, { "docs/getting-started/outreach.md": [] } - ] - }, - { - "docs/how-to-guides/README.md": [{ - "docs/how-to-guides/javascript/README.md": [ - { "docs/how-to-guides/javascript/plugins-background.md": [] }, - { "docs/how-to-guides/javascript/loading-javascript.md": [] }, - { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, - { "docs/how-to-guides/javascript/troubleshooting.md": [] }, - { "docs/how-to-guides/javascript/versions-and-building.md": [] }, - { "docs/how-to-guides/javascript/scope-your-code.md": [] }, - { "docs/how-to-guides/javascript/js-build-setup.md": [] }, - { "docs/how-to-guides/javascript/esnext-js.md": [] } - ] - }, - { - "docs/how-to-guides/metabox/README.md": [ - { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, - { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, - { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, - { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, - { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } - ] - }, - { "docs/how-to-guides/notices/README.md": [] }, - { - "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] - }, - { - "docs/how-to-guides/block-tutorial/README.md": [ - { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] - }, - { "docs/how-to-guides/feature-flags.md": [] }, - { - "docs/how-to-guides/themes/README.md": [ - { "docs/how-to-guides/themes/theme-support.md": [] }, - { "docs/how-to-guides/themes/theme-json.md": [] } - ] - }, - { - "docs/how-to-guides/block-based-theme/README.md": [ - { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } - ] - }, - { - "docs/how-to-guides/backward-compatibility/README.md": [ - { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, - { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } - ] - }, - - { - "docs/how-to-guides/format-api/README.md": [ - { "docs/how-to-guides/format-api/1-register-format.md": [] }, - { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, - { "docs/how-to-guides/format-api/3-apply-format.md": [] } - ] - }, - { - "docs/how-to-guides/platform/README.md": [{ - "docs/how-to-guides/platform/custom-block-editor/README.md": [ - { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } - ] - }] - }, - { - "docs/how-to-guides/designers/README.md": [ - { "docs/how-to-guides/designers/block-design.md": [] }, - { "docs/how-to-guides/designers/user-interface.md": [] }, - { "docs/how-to-guides/designers/design-resources.md": [] }, - { "docs/how-to-guides/designers/animation.md": [] } - ] - }, - { "docs/how-to-guides/accessibility.md": [] }, - { "docs/how-to-guides/internationalization.md": [] } - ] - }, - { - "docs/reference-guides/README.md": [{ - "docs/reference-guides/block-api/README.md": [ - { "docs/reference-guides/block-api/block-registration.md": [] }, - { "docs/reference-guides/block-api/block-edit-save.md": [] }, - { "docs/reference-guides/block-api/block-attributes.md": [] }, - { "docs/reference-guides/block-api/block-context.md": [] }, - { "docs/reference-guides/block-api/block-deprecation.md": [] }, - { "docs/reference-guides/block-api/block-supports.md": [] }, - { "docs/reference-guides/block-api/block-transforms.md": [] }, - { "docs/reference-guides/block-api/block-templates.md": [] }, - { "docs/reference-guides/block-api/block-metadata.md": [] }, - { "docs/reference-guides/block-api/block-patterns.md": [] }, - { "docs/reference-guides/block-api/block-annotations.md": [] }, - { "docs/reference-guides/block-api/versions.md": [] } - ] - }, - { - "docs/reference-guides/filters/README.md": [ - { "docs/reference-guides/filters/block-filters.md": [] }, - { "docs/reference-guides/filters/editor-filters.md": [] }, - { "docs/reference-guides/filters/parser-filters.md": [] }, - { "docs/reference-guides/filters/autocomplete-filters.md": [] } - ] - }, - { - "docs/reference-guides/slotfills/README.md": [ - { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, - { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, - { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } - ] - }, - { "docs/reference-guides/richtext.md": [] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/reference-guides/packages.md": "{{packages}}" }, - { - "docs/reference-guides/data/README.md": [ - { "docs/reference-guides/data/data-core.md": [] }, - { "docs/reference-guides/data/data-core-annotations.md": [] }, - { "docs/reference-guides/data/data-core-blocks.md": [] }, - { "docs/reference-guides/data/data-core-block-editor.md": [] }, - { "docs/reference-guides/data/data-core-editor.md": [] }, - { "docs/reference-guides/data/data-core-edit-post.md": [] }, - { "docs/reference-guides/data/data-core-notices.md": [] }, - { "docs/reference-guides/data/data-core-nux.md": [] }, - { "docs/reference-guides/data/data-core-viewport.md": [] } - ] - } - ] - }, - { - "docs/explanations/README.md": [ - - { - "docs/explanations/architecture/README.md": [ - { "docs/explanations/architecture/key-concepts.md": [] }, - { "docs/explanations/architecture/data-flow.md": [] }, - { "docs/explanations/architecture/modularity.md": [] }, - { "docs/explanations/architecture/performance.md": [] }, - { "docs/explanations/architecture/automated-testing.md": [] }, - { "docs/explanations/architecture/full-site-editing-templates.md": [] } - ] - } - ] - }, - { - "docs/contributors/README.md": [{ - "docs/contributors/code/develop.md": [ - { "docs/contributors/code/getting-started.md": [] }, - { "docs/contributors/code/git-workflow.md": [] }, - { "docs/contributors/code/coding-guidelines.md": [] }, - { "docs/contributors/code/testing-overview.md": [] }, - { "docs/contributors/code/grammar.md": [] }, - { "docs/contributors/code/scripts.md": [] }, - { "docs/contributors/code/managing-packages.md": [] }, - { "docs/contributors/code/release.md": [] }, - { "docs/contributors/code/native-mobile.md": [] }, - { "docs/contributors/code/getting-started-native-mobile.md": [] } - ] - }, - { - "docs/contributors/design/design.md": [ - { "docs/contributors/design/the-block.md": [] }, - { "docs/contributors/design/reference.md": [] } - ] - }, - { - "docs/contributors/documentation/document.md": [ - { "docs/contributors/documentation/copy-guide.md": [] } - ] - }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/accessibility-testing.md": [] }, - { "docs/contributors/repository-management.md": [] }, - { "docs/contributors/folder-structure.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/roadmap.md": [] } - ] - } + ] } + ] }, + { "docs/how-to-guides/README.md": [ + { "docs/how-to-guides/javascript/README.md": [ + { "docs/how-to-guides/javascript/plugins-background.md": [] }, + { "docs/how-to-guides/javascript/loading-javascript.md": [] }, + { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/how-to-guides/javascript/troubleshooting.md": [] }, + { "docs/how-to-guides/javascript/versions-and-building.md": [] }, + { "docs/how-to-guides/javascript/scope-your-code.md": [] }, + { "docs/how-to-guides/javascript/js-build-setup.md": [] }, + { "docs/how-to-guides/javascript/esnext-js.md": [] } + ] }, + { "docs/how-to-guides/metabox/README.md": [ + { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, + { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/how-to-guides/notices/README.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/how-to-guides/block-tutorial/README.md": [ + { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/how-to-guides/feature-flags.md": [] }, + { "docs/how-to-guides/themes/README.md": [ + { "docs/how-to-guides/themes/theme-support.md": [] }, + { "docs/how-to-guides/themes/theme-json.md": [] } + ]}, + { "docs/how-to-guides/block-based-theme/README.md": [ + { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/how-to-guides/backward-compatibility/README.md": [ + { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, + { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } + ] }, + { "docs/how-to-guides/format-api/README.md": [ + { "docs/how-to-guides/format-api/1-register-format.md": [] }, + { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, + { "docs/how-to-guides/format-api/3-apply-format.md": [] } + ] }, + { "docs/how-to-guides/platform/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } + ] } + ] }, + { "docs/how-to-guides/designers/README.md": [ + { "docs/how-to-guides/designers/block-design.md": [] }, + { "docs/how-to-guides/designers/user-interface.md": [] }, + { "docs/how-to-guides/designers/design-resources.md": [] }, + { "docs/how-to-guides/designers/animation.md": [] } + ] }, + { "docs/how-to-guides/accessibility.md": [] }, + { "docs/how-to-guides/internationalization.md": [] } + ] }, + { "docs/reference-guides/README.md": [ + { "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] }, + { "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] }, + { "docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ] }, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": [] }, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } + ] } + ] }, + { "docs/explanations/README.md": [ + { "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] } + ] }, + { "docs/contributors/README.md": [ + { "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] }, + { "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } + ] }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] } ] \ No newline at end of file From d77eb489b1558f5532efc1dd02d246848d16302e Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 13:09:51 +0100 Subject: [PATCH 32/68] Update toc.json --- docs/manifest.json | 2 +- docs/toc.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 099e0bdcc92d3..5b9ef0fe93df1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -2,7 +2,7 @@ { "title": "Getting started", "slug": "handbook", - "markdown_source": "../docs/readme.md", + "markdown_source": "../docs/README.md", "parent": null }, { diff --git a/docs/toc.json b/docs/toc.json index 2a1683cb5e9f5..bd840a40c06f3 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,5 +1,5 @@ [ - { "docs/readme.md": [ + { "docs/README.md": [ { "docs/getting-started/README.md": [ { "docs/getting-started/tutorials/README.md": [ { "docs/getting-started/tutorials/devenv/README.md": [ From 1d0f49bf2967c2a055bf474e9a342df142d44a06 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 4 Mar 2021 08:03:18 +0100 Subject: [PATCH 33/68] Add new line to the create-block tutorial --- docs/manifest.json | 6 ++++++ docs/toc.json | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index 5b9ef0fe93df1..267fbef45b017 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -71,6 +71,12 @@ "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", "parent": "create-block" }, + { + "title": "Share your Block with the World", + "slug": "submitting-to-block-directory", + "markdown_source": "../docs/getting-started/tutorials/create-block/submitting-to-block-directory.md", + "parent": "create-block" + }, { "title": "Glossary", "slug": "glossary", diff --git a/docs/toc.json b/docs/toc.json index bd840a40c06f3..c1d037c560500 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -11,7 +11,8 @@ { "docs/getting-started/tutorials/create-block/attributes.md": [] }, { "docs/getting-started/tutorials/create-block/block-code.md": [] }, { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } + { "docs/getting-started/tutorials/create-block/finishing.md": [] }, + { "docs/getting-started/tutorials/create-block/submitting-to-block-directory.md": [] } ] } ] }, { "docs/getting-started/glossary.md": [] }, From a0ff55fd80faf781549a48522eda9ced885422d7 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:43:21 +0100 Subject: [PATCH 34/68] Create an appendix folder and add its files --- docs/appendix/README.md | 0 .../developers => appendix}/backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../developers => appendix}/backward-compatibility/meta-box.md | 0 docs/{designers-developers/developers => appendix}/data/README.md | 0 .../developers => appendix}/data/data-core-annotations.md | 0 .../developers => appendix}/data/data-core-block-editor.md | 0 .../developers => appendix}/data/data-core-blocks.md | 0 .../developers => appendix}/data/data-core-edit-post.md | 0 .../developers => appendix}/data/data-core-editor.md | 0 .../developers => appendix}/data/data-core-keyboard-shortcuts.md | 0 .../developers => appendix}/data/data-core-notices.md | 0 .../developers => appendix}/data/data-core-nux.md | 0 .../developers => appendix}/data/data-core-viewport.md | 0 .../developers => appendix}/data/data-core.md | 0 docs/{designers-developers => appendix}/faq.md | 0 docs/{designers-developers => appendix}/glossary.md | 0 docs/{contributors => appendix}/history.md | 0 docs/{contributors => appendix}/outreach.md | 0 docs/{designers-developers/developers => appendix}/packages.md | 0 docs/{contributors => appendix}/versions-in-wordpress.md | 0 21 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/appendix/README.md rename docs/{designers-developers/developers => appendix}/backward-compatibility/README.md (100%) rename docs/{designers-developers/developers => appendix}/backward-compatibility/deprecations.md (100%) rename docs/{designers-developers/developers => appendix}/backward-compatibility/meta-box.md (100%) rename docs/{designers-developers/developers => appendix}/data/README.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-annotations.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-block-editor.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-blocks.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-edit-post.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-editor.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-keyboard-shortcuts.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-notices.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-nux.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core-viewport.md (100%) rename docs/{designers-developers/developers => appendix}/data/data-core.md (100%) rename docs/{designers-developers => appendix}/faq.md (100%) rename docs/{designers-developers => appendix}/glossary.md (100%) rename docs/{contributors => appendix}/history.md (100%) rename docs/{contributors => appendix}/outreach.md (100%) rename docs/{designers-developers/developers => appendix}/packages.md (100%) rename docs/{contributors => appendix}/versions-in-wordpress.md (100%) diff --git a/docs/appendix/README.md b/docs/appendix/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/backward-compatibility/README.md b/docs/appendix/backward-compatibility/README.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/README.md rename to docs/appendix/backward-compatibility/README.md diff --git a/docs/designers-developers/developers/backward-compatibility/deprecations.md b/docs/appendix/backward-compatibility/deprecations.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/deprecations.md rename to docs/appendix/backward-compatibility/deprecations.md diff --git a/docs/designers-developers/developers/backward-compatibility/meta-box.md b/docs/appendix/backward-compatibility/meta-box.md similarity index 100% rename from docs/designers-developers/developers/backward-compatibility/meta-box.md rename to docs/appendix/backward-compatibility/meta-box.md diff --git a/docs/designers-developers/developers/data/README.md b/docs/appendix/data/README.md similarity index 100% rename from docs/designers-developers/developers/data/README.md rename to docs/appendix/data/README.md diff --git a/docs/designers-developers/developers/data/data-core-annotations.md b/docs/appendix/data/data-core-annotations.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-annotations.md rename to docs/appendix/data/data-core-annotations.md diff --git a/docs/designers-developers/developers/data/data-core-block-editor.md b/docs/appendix/data/data-core-block-editor.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-block-editor.md rename to docs/appendix/data/data-core-block-editor.md diff --git a/docs/designers-developers/developers/data/data-core-blocks.md b/docs/appendix/data/data-core-blocks.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-blocks.md rename to docs/appendix/data/data-core-blocks.md diff --git a/docs/designers-developers/developers/data/data-core-edit-post.md b/docs/appendix/data/data-core-edit-post.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-edit-post.md rename to docs/appendix/data/data-core-edit-post.md diff --git a/docs/designers-developers/developers/data/data-core-editor.md b/docs/appendix/data/data-core-editor.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-editor.md rename to docs/appendix/data/data-core-editor.md diff --git a/docs/designers-developers/developers/data/data-core-keyboard-shortcuts.md b/docs/appendix/data/data-core-keyboard-shortcuts.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-keyboard-shortcuts.md rename to docs/appendix/data/data-core-keyboard-shortcuts.md diff --git a/docs/designers-developers/developers/data/data-core-notices.md b/docs/appendix/data/data-core-notices.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-notices.md rename to docs/appendix/data/data-core-notices.md diff --git a/docs/designers-developers/developers/data/data-core-nux.md b/docs/appendix/data/data-core-nux.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-nux.md rename to docs/appendix/data/data-core-nux.md diff --git a/docs/designers-developers/developers/data/data-core-viewport.md b/docs/appendix/data/data-core-viewport.md similarity index 100% rename from docs/designers-developers/developers/data/data-core-viewport.md rename to docs/appendix/data/data-core-viewport.md diff --git a/docs/designers-developers/developers/data/data-core.md b/docs/appendix/data/data-core.md similarity index 100% rename from docs/designers-developers/developers/data/data-core.md rename to docs/appendix/data/data-core.md diff --git a/docs/designers-developers/faq.md b/docs/appendix/faq.md similarity index 100% rename from docs/designers-developers/faq.md rename to docs/appendix/faq.md diff --git a/docs/designers-developers/glossary.md b/docs/appendix/glossary.md similarity index 100% rename from docs/designers-developers/glossary.md rename to docs/appendix/glossary.md diff --git a/docs/contributors/history.md b/docs/appendix/history.md similarity index 100% rename from docs/contributors/history.md rename to docs/appendix/history.md diff --git a/docs/contributors/outreach.md b/docs/appendix/outreach.md similarity index 100% rename from docs/contributors/outreach.md rename to docs/appendix/outreach.md diff --git a/docs/designers-developers/developers/packages.md b/docs/appendix/packages.md similarity index 100% rename from docs/designers-developers/developers/packages.md rename to docs/appendix/packages.md diff --git a/docs/contributors/versions-in-wordpress.md b/docs/appendix/versions-in-wordpress.md similarity index 100% rename from docs/contributors/versions-in-wordpress.md rename to docs/appendix/versions-in-wordpress.md From 107b6d5fbfdb0512d39b198aae469a9106dcac5b Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:47:10 +0100 Subject: [PATCH 35/68] Move full site editing templates under developer chapter --- .../developers/full-site-editing-templates.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{architecture/fse-templates.md => designers-developers/developers/full-site-editing-templates.md} (100%) diff --git a/docs/architecture/fse-templates.md b/docs/designers-developers/developers/full-site-editing-templates.md similarity index 100% rename from docs/architecture/fse-templates.md rename to docs/designers-developers/developers/full-site-editing-templates.md From 715494896c93ed7cf855ab3fd92f9f8ed0cc4baa Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 15:47:34 +0100 Subject: [PATCH 36/68] Move platform folder under tutorials chapter --- .../developers/{ => tutorials}/platform/README.md | 0 .../{ => tutorials}/platform/custom-block-editor/README.md | 0 .../{ => tutorials}/platform/custom-block-editor/tutorial.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/designers-developers/developers/{ => tutorials}/platform/README.md (100%) rename docs/designers-developers/developers/{ => tutorials}/platform/custom-block-editor/README.md (100%) rename docs/designers-developers/developers/{ => tutorials}/platform/custom-block-editor/tutorial.md (100%) diff --git a/docs/designers-developers/developers/platform/README.md b/docs/designers-developers/developers/tutorials/platform/README.md similarity index 100% rename from docs/designers-developers/developers/platform/README.md rename to docs/designers-developers/developers/tutorials/platform/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/README.md b/docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/README.md rename to docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md b/docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/tutorial.md rename to docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md From 1e9cd43137b8d15a3319169b220a2a8bd0127720 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Tue, 2 Feb 2021 16:04:00 +0100 Subject: [PATCH 37/68] Update the appendix folder readme --- docs/appendix/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/appendix/README.md b/docs/appendix/README.md index e69de29bb2d1d..e52bc7073548d 100644 --- a/docs/appendix/README.md +++ b/docs/appendix/README.md @@ -0,0 +1,10 @@ +# Appendix + +- [Package Reference](/docs/appendix/packages.md) +- [Data Module Reference](/docs/appendix/data/README.md) +- [Backward Compatibility](/docs/appendix/backward-compatibility/README.md) +- [Glossary](/docs/appendix/glossary.md) +- [Frequently Asked Questions](/docs/appendix/faq.md) +- [Versions in WordPress](/docs/appendix/versions-in-wordpress.md) +- [History](/docs/appendix/history.md) +- [Outreach](/docs/appendix/outreach) \ No newline at end of file From f3965f77a0296d57cbc316508b44b4ecb7542b97 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 08:13:58 +0100 Subject: [PATCH 38/68] Move plateform folder to developers folder --- .../developers/{tutorials => }/platform/README.md | 0 .../{tutorials => }/platform/custom-block-editor/README.md | 0 .../{tutorials => }/platform/custom-block-editor/tutorial.md | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/designers-developers/developers/{tutorials => }/platform/README.md (100%) rename docs/designers-developers/developers/{tutorials => }/platform/custom-block-editor/README.md (100%) rename docs/designers-developers/developers/{tutorials => }/platform/custom-block-editor/tutorial.md (100%) diff --git a/docs/designers-developers/developers/tutorials/platform/README.md b/docs/designers-developers/developers/platform/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/README.md rename to docs/designers-developers/developers/platform/README.md diff --git a/docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md b/docs/designers-developers/developers/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/custom-block-editor/README.md rename to docs/designers-developers/developers/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md b/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/tutorials/platform/custom-block-editor/tutorial.md rename to docs/designers-developers/developers/platform/custom-block-editor/tutorial.md From 63b36d7e8cab717b16e48753be6eb2dcca4c92b6 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 08:14:17 +0100 Subject: [PATCH 39/68] Update packages reference paths --- docs/manifest.json | 744 +++++++++++++++++++++++---------------------- docs/toc.json | 272 ++++++++--------- 2 files changed, 511 insertions(+), 505 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index bd9b9b01b8943..69dc087724f1a 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -2,92 +2,50 @@ { "title": "Getting started", "slug": "handbook", - "markdown_source": "../docs/readme.md", + "markdown_source": "../docs/README.md", "parent": null }, { - "title": "Glossary", - "slug": "glossary", - "markdown_source": "../docs/designers-developers/glossary.md", - "parent": "handbook" - }, - { - "title": "Frequently Asked Questions", - "slug": "faq", - "markdown_source": "../docs/designers-developers/faq.md", - "parent": "handbook" - }, - { - "title": "Versions in WordPress", - "slug": "versions-in-wordpress", - "markdown_source": "../docs/contributors/versions-in-wordpress.md", - "parent": "handbook" - }, - { - "title": "History", - "slug": "history", - "markdown_source": "../docs/contributors/history.md", - "parent": "handbook" - }, - { - "title": "Outreach", - "slug": "outreach", - "markdown_source": "../docs/contributors/outreach.md", - "parent": "handbook" - }, - { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/architecture/readme.md", + "title": "Developer Documentation", + "slug": "developers", + "markdown_source": "../docs/designers-developers/developers/README.md", "parent": null }, { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/architecture/key-concepts.md", - "parent": "architecture" - }, - { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/architecture/data-flow.md", - "parent": "architecture" - }, - { - "title": "Folder Structure", - "slug": "folder-structure", - "markdown_source": "../docs/architecture/folder-structure.md", - "parent": "architecture" + "title": "FullSiteEditingTemplates", + "slug": "full-site-editing-templates", + "markdown_source": "../docs/designers-developers/developers/full-site-editing-templates.md", + "parent": "developers" }, { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/architecture/modularity.md", - "parent": "architecture" + "title": "Filter Reference", + "slug": "filters", + "markdown_source": "../docs/designers-developers/developers/filters/README.md", + "parent": "developers" }, { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/architecture/performance.md", - "parent": "architecture" + "title": "Block Filters", + "slug": "block-filters", + "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", + "parent": "filters" }, { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/architecture/automated-testing.md", - "parent": "architecture" + "title": "Editor Filters", + "slug": "editor-filters", + "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", + "parent": "filters" }, { - "title": "FseTemplates", - "slug": "fse-templates", - "markdown_source": "../docs/architecture/fse-templates.md", - "parent": "architecture" + "title": "Parser Filters", + "slug": "parser-filters", + "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", + "parent": "filters" }, { - "title": "Developer Documentation", - "slug": "developers", - "markdown_source": "../docs/designers-developers/developers/README.md", - "parent": null + "title": "Autocomplete", + "slug": "autocomplete-filters", + "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", + "parent": "filters" }, { "title": "Block API Reference", @@ -167,36 +125,6 @@ "markdown_source": "../docs/designers-developers/developers/block-api/versions.md", "parent": "block-api" }, - { - "title": "Filter Reference", - "slug": "filters", - "markdown_source": "../docs/designers-developers/developers/filters/README.md", - "parent": "developers" - }, - { - "title": "Block Filters", - "slug": "block-filters", - "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", - "parent": "filters" - }, - { - "title": "Editor Filters", - "slug": "editor-filters", - "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", - "parent": "filters" - }, - { - "title": "Parser Filters", - "slug": "parser-filters", - "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", - "parent": "filters" - }, - { - "title": "Autocomplete", - "slug": "autocomplete-filters", - "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", - "parent": "filters" - }, { "title": "SlotFills Reference", "slug": "slotfills", @@ -263,18 +191,6 @@ "markdown_source": "../docs/designers-developers/developers/richtext.md", "parent": "developers" }, - { - "title": "Internationalization", - "slug": "internationalization", - "markdown_source": "../docs/designers-developers/developers/internationalization.md", - "parent": "developers" - }, - { - "title": "Accessibility", - "slug": "accessibility", - "markdown_source": "../docs/designers-developers/developers/accessibility.md", - "parent": "developers" - }, { "title": "Feature Flags", "slug": "feature-flags", @@ -306,196 +222,22 @@ "parent": "themes" }, { - "title": "Backward Compatibility", - "slug": "backward-compatibility", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/README.md", + "title": "Accessibility", + "slug": "accessibility", + "markdown_source": "../docs/designers-developers/developers/accessibility.md", "parent": "developers" }, { - "title": "Deprecations", - "slug": "deprecations", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/deprecations.md", - "parent": "backward-compatibility" - }, - { - "title": "Meta Boxes", - "slug": "meta-box", - "markdown_source": "../docs/designers-developers/developers/backward-compatibility/meta-box.md", - "parent": "backward-compatibility" - }, - { - "title": "Gutenberg as a Development Platform", - "slug": "platform", - "markdown_source": "../docs/designers-developers/developers/platform/README.md", + "title": "Internationalization", + "slug": "internationalization", + "markdown_source": "../docs/designers-developers/developers/internationalization.md", "parent": "developers" }, - { - "title": "Building a custom block editor", - "slug": "custom-block-editor", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", - "parent": "platform" - }, - { - "title": "Tutorial: building a custom block editor", - "slug": "tutorial", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", - "parent": "custom-block-editor" - }, - { - "title": "Designer Documentation", - "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null - }, - { - "title": "Block Design", - "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", - "parent": "designers" - }, - { - "title": "User Interface", - "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", - "parent": "designers" - }, - { - "title": "Resources", - "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", - "parent": "designers" - }, - { - "title": "Animation", - "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", - "parent": "designers" - }, - { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", - "parent": null - }, - { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" - }, - { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" - }, - { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" - }, - { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" - }, - { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" - }, - { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" - }, - { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" - }, - { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" - }, - { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" - }, - { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" - }, - { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" - }, - { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" - }, - { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" - }, - { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" - }, - { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" - }, - { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" - }, - { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" - }, - { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" - }, - { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" - }, { "title": "Tutorials", "slug": "tutorials", "markdown_source": "../docs/designers-developers/developers/tutorials/readme.md", - "parent": null + "parent": "developers" }, { "title": "Development Environment", @@ -779,11 +521,77 @@ "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md", "parent": "block-based-theme" }, + { + "title": "Gutenberg as a Development Platform", + "slug": "platform", + "markdown_source": "../docs/designers-developers/developers/platform/README.md", + "parent": "tutorials" + }, + { + "title": "Building a custom block editor", + "slug": "custom-block-editor", + "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", + "parent": "platform" + }, + { + "title": "Tutorial: building a custom block editor", + "slug": "tutorial", + "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", + "parent": "custom-block-editor" + }, + { + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/architecture/readme.md", + "parent": null + }, + { + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/architecture/key-concepts.md", + "parent": "architecture" + }, + { + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/architecture/data-flow.md", + "parent": "architecture" + }, + { + "title": "Folder Structure", + "slug": "folder-structure", + "markdown_source": "../docs/architecture/folder-structure.md", + "parent": "architecture" + }, + { + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/architecture/modularity.md", + "parent": "architecture" + }, + { + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/architecture/performance.md", + "parent": "architecture" + }, + { + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/architecture/automated-testing.md", + "parent": "architecture" + }, + { + "title": "Appendix", + "slug": "appendix", + "markdown_source": "../docs/appendix/readme.md", + "parent": null + }, { "title": "Component Reference", "slug": "components", "markdown_source": "../packages/components/README.md", - "parent": null + "parent": "appendix" }, { "title": "AlignmentMatrixControl", @@ -1275,91 +1083,31 @@ "title": "TreeGrid", "slug": "tree-grid", "markdown_source": "../packages/components/src/tree-grid/README.md", - "parent": "components" - }, - { - "title": "TreeSelect", - "slug": "tree-select", - "markdown_source": "../packages/components/src/tree-select/README.md", - "parent": "components" - }, - { - "title": "UnitControl", - "slug": "unit-control", - "markdown_source": "../packages/components/src/unit-control/README.md", - "parent": "components" - }, - { - "title": "VisuallyHidden", - "slug": "visually-hidden", - "markdown_source": "../packages/components/src/visually-hidden/README.md", - "parent": "components" - }, - { - "title": "Data Module Reference", - "slug": "data", - "markdown_source": "../docs/designers-developers/developers/data/README.md", - "parent": null - }, - { - "title": "WordPress Core Data", - "slug": "data-core", - "markdown_source": "../docs/designers-developers/developers/data/data-core.md", - "parent": "data" - }, - { - "title": "Annotations", - "slug": "data-core-annotations", - "markdown_source": "../docs/designers-developers/developers/data/data-core-annotations.md", - "parent": "data" - }, - { - "title": "Block Types Data", - "slug": "data-core-blocks", - "markdown_source": "../docs/designers-developers/developers/data/data-core-blocks.md", - "parent": "data" - }, - { - "title": "The Block Editor’s Data", - "slug": "data-core-block-editor", - "markdown_source": "../docs/designers-developers/developers/data/data-core-block-editor.md", - "parent": "data" - }, - { - "title": "The Post Editor’s Data", - "slug": "data-core-editor", - "markdown_source": "../docs/designers-developers/developers/data/data-core-editor.md", - "parent": "data" - }, - { - "title": "The Editor’s UI Data", - "slug": "data-core-edit-post", - "markdown_source": "../docs/designers-developers/developers/data/data-core-edit-post.md", - "parent": "data" + "parent": "components" }, { - "title": "Notices Data", - "slug": "data-core-notices", - "markdown_source": "../docs/designers-developers/developers/data/data-core-notices.md", - "parent": "data" + "title": "TreeSelect", + "slug": "tree-select", + "markdown_source": "../packages/components/src/tree-select/README.md", + "parent": "components" }, { - "title": "The NUX (New User Experience) Data", - "slug": "data-core-nux", - "markdown_source": "../docs/designers-developers/developers/data/data-core-nux.md", - "parent": "data" + "title": "UnitControl", + "slug": "unit-control", + "markdown_source": "../packages/components/src/unit-control/README.md", + "parent": "components" }, { - "title": "The Viewport Data", - "slug": "data-core-viewport", - "markdown_source": "../docs/designers-developers/developers/data/data-core-viewport.md", - "parent": "data" + "title": "VisuallyHidden", + "slug": "visually-hidden", + "markdown_source": "../packages/components/src/visually-hidden/README.md", + "parent": "components" }, { "title": "Package Reference", "slug": "packages", - "markdown_source": "../docs/designers-developers/developers/packages.md", - "parent": null + "markdown_source": "../docs/appendix/packages.md", + "parent": "appendix" }, { "title": "@wordpress/a11y", @@ -1864,5 +1612,263 @@ "slug": "packages-wordcount", "markdown_source": "../packages/wordcount/README.md", "parent": "packages" + }, + { + "title": "Data Module Reference", + "slug": "data", + "markdown_source": "../docs/appendix/data/README.md", + "parent": "appendix" + }, + { + "title": "WordPress Core Data", + "slug": "data-core", + "markdown_source": "../docs/appendix/data/data-core.md", + "parent": "data" + }, + { + "title": "Annotations", + "slug": "data-core-annotations", + "markdown_source": "../docs/appendix/data/data-core-annotations.md", + "parent": "data" + }, + { + "title": "Block Types Data", + "slug": "data-core-blocks", + "markdown_source": "../docs/appendix/data/data-core-blocks.md", + "parent": "data" + }, + { + "title": "The Block Editor’s Data", + "slug": "data-core-block-editor", + "markdown_source": "../docs/appendix/data/data-core-block-editor.md", + "parent": "data" + }, + { + "title": "The Post Editor’s Data", + "slug": "data-core-editor", + "markdown_source": "../docs/appendix/data/data-core-editor.md", + "parent": "data" + }, + { + "title": "The Editor’s UI Data", + "slug": "data-core-edit-post", + "markdown_source": "../docs/appendix/data/data-core-edit-post.md", + "parent": "data" + }, + { + "title": "Notices Data", + "slug": "data-core-notices", + "markdown_source": "../docs/appendix/data/data-core-notices.md", + "parent": "data" + }, + { + "title": "The NUX (New User Experience) Data", + "slug": "data-core-nux", + "markdown_source": "../docs/appendix/data/data-core-nux.md", + "parent": "data" + }, + { + "title": "The Viewport Data", + "slug": "data-core-viewport", + "markdown_source": "../docs/appendix/data/data-core-viewport.md", + "parent": "data" + }, + { + "title": "Backward Compatibility", + "slug": "backward-compatibility", + "markdown_source": "../docs/appendix/backward-compatibility/README.md", + "parent": "appendix" + }, + { + "title": "Deprecations", + "slug": "deprecations", + "markdown_source": "../docs/appendix/backward-compatibility/deprecations.md", + "parent": "backward-compatibility" + }, + { + "title": "Meta Boxes", + "slug": "meta-box", + "markdown_source": "../docs/appendix/backward-compatibility/meta-box.md", + "parent": "backward-compatibility" + }, + { + "title": "Glossary", + "slug": "glossary", + "markdown_source": "../docs/appendix/glossary.md", + "parent": "appendix" + }, + { + "title": "Frequently Asked Questions", + "slug": "faq", + "markdown_source": "../docs/appendix/faq.md", + "parent": "appendix" + }, + { + "title": "Versions in WordPress", + "slug": "versions-in-wordpress", + "markdown_source": "../docs/appendix/versions-in-wordpress.md", + "parent": "appendix" + }, + { + "title": "History", + "slug": "history", + "markdown_source": "../docs/appendix/history.md", + "parent": "appendix" + }, + { + "title": "Outreach", + "slug": "outreach", + "markdown_source": "../docs/appendix/outreach.md", + "parent": "appendix" + }, + { + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/readme.md", + "parent": null + }, + { + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/develop.md", + "parent": "contributors" + }, + { + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/getting-started.md", + "parent": "develop" + }, + { + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/git-workflow.md", + "parent": "develop" + }, + { + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/coding-guidelines.md", + "parent": "develop" + }, + { + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, + { + "title": "Designer Documentation", + "slug": "designers", + "markdown_source": "../docs/designers-developers/designers/README.md", + "parent": null + }, + { + "title": "Block Design", + "slug": "block-design", + "markdown_source": "../docs/designers-developers/designers/block-design.md", + "parent": "designers" + }, + { + "title": "User Interface", + "slug": "user-interface", + "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "parent": "designers" + }, + { + "title": "Resources", + "slug": "design-resources", + "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "parent": "designers" + }, + { + "title": "Animation", + "slug": "animation", + "markdown_source": "../docs/designers-developers/designers/animation.md", + "parent": "designers" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 3ccdbd3cd0c38..40ae9c326dce2 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,42 +1,27 @@ [ - { "docs/readme.md": [ - { "docs/designers-developers/glossary.md": [] }, - { "docs/designers-developers/faq.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/history.md": [] }, - { "docs/contributors/outreach.md": [] } - ] }, - { "docs/architecture/readme.md": [ - { "docs/architecture/key-concepts.md": [] }, - { "docs/architecture/data-flow.md": [] }, - { "docs/architecture/folder-structure.md": [] }, - { "docs/architecture/modularity.md": [] }, - { "docs/architecture/performance.md": [] }, - { "docs/architecture/automated-testing.md": [] }, - { "docs/architecture/fse-templates.md": [] } - ] }, - { "docs/designers-developers/developers/README.md": [ - { "docs/designers-developers/developers/block-api/README.md": [ - { "docs/designers-developers/developers/block-api/block-registration.md": [] }, - { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, - { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, - { "docs/designers-developers/developers/block-api/block-context.md": [] }, - { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, - { "docs/designers-developers/developers/block-api/block-supports.md": [] }, - { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, - { "docs/designers-developers/developers/block-api/block-templates.md": [] }, - { "docs/designers-developers/developers/block-api/block-metadata.md": [] }, - { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, - { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, - { "docs/designers-developers/developers/block-api/versions.md": [] } - ] }, - { "docs/designers-developers/developers/filters/README.md": [ - { "docs/designers-developers/developers/filters/block-filters.md": [] }, - { "docs/designers-developers/developers/filters/editor-filters.md": [] }, - { "docs/designers-developers/developers/filters/parser-filters.md": [] }, - { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } - ] }, - {"docs/designers-developers/developers/slotfills/README.md": [ + { "docs/README.md": [] }, + { "docs/designers-developers/developers/README.md": [ + { "docs/designers-developers/developers/full-site-editing-templates.md": [] }, + { "docs/designers-developers/developers/filters/README.md": [ + { "docs/designers-developers/developers/filters/block-filters.md": [] }, + { "docs/designers-developers/developers/filters/editor-filters.md": [] }, + { "docs/designers-developers/developers/filters/parser-filters.md": [] }, + { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } + ] }, + { "docs/designers-developers/developers/block-api/README.md": [ + { "docs/designers-developers/developers/block-api/block-registration.md": [] }, + { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, + { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, + { "docs/designers-developers/developers/block-api/block-context.md": [] }, + { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, + { "docs/designers-developers/developers/block-api/block-supports.md": [] }, + { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, + { "docs/designers-developers/developers/block-api/block-templates.md": [] }, + { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, + { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, + { "docs/designers-developers/developers/block-api/versions.md": [] } + ] }, + {"docs/designers-developers/developers/slotfills/README.md": [ { "docs/designers-developers/developers/slotfills/main-dashboard-button.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md": [] }, @@ -46,33 +31,112 @@ { "docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-sidebar.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/designers-developers/developers/richtext.md": [] }, - { "docs/designers-developers/developers/internationalization.md": [] }, - { "docs/designers-developers/developers/accessibility.md": [] }, - { "docs/designers-developers/developers/feature-flags.md": [] }, - { "docs/designers-developers/developers/themes/README.md": [ - { "docs/designers-developers/developers/themes/theme-support.md": [] }, - { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, - { "docs/designers-developers/developers/themes/theme-json.md": [] } - ] }, - { "docs/designers-developers/developers/backward-compatibility/README.md": [ - { "docs/designers-developers/developers/backward-compatibility/deprecations.md": [] }, - { "docs/designers-developers/developers/backward-compatibility/meta-box.md": [] } - ] }, - { "docs/designers-developers/developers/platform/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } - ] } - ] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] }, - { "docs/contributors/readme.md": [ + ]}, + { "docs/designers-developers/developers/richtext.md": [] }, + { "docs/designers-developers/developers/feature-flags.md": [] }, + + { "docs/designers-developers/developers/themes/README.md": [ + { "docs/designers-developers/developers/themes/theme-support.md": [] }, + { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, + { "docs/designers-developers/developers/themes/theme-json.md": [] } + ] }, + { "docs/designers-developers/developers/accessibility.md": [] }, + { "docs/designers-developers/developers/internationalization.md": [] }, + { "docs/designers-developers/developers/tutorials/readme.md": [ + { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ + { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ + { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, + { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ + { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, + { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ + { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ + { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, + { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/format-api/README.md": [ + { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, + { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, + { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } + ] }, + { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ + { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/designers-developers/developers/platform/README.md": [ + { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ + { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } + ] } + ] } + ] } + ] }, + { "docs/architecture/readme.md": [ + { "docs/architecture/key-concepts.md": [] }, + { "docs/architecture/data-flow.md": [] }, + { "docs/architecture/folder-structure.md": [] }, + { "docs/architecture/modularity.md": [] }, + { "docs/architecture/performance.md": [] }, + { "docs/architecture/automated-testing.md": [] } + ] }, + { "docs/appendix/readme.md": [ + { "packages/components/README.md": "{{components}}" }, + { "docs/appendix/packages.md": "{{packages}}" }, + { "docs/appendix/data/README.md": [ + { "docs/appendix/data/data-core.md": []}, + { "docs/appendix/data/data-core-annotations.md": [] }, + { "docs/appendix/data/data-core-blocks.md": [] }, + { "docs/appendix/data/data-core-block-editor.md": [] }, + { "docs/appendix/data/data-core-editor.md": [] }, + { "docs/appendix/data/data-core-edit-post.md": [] }, + { "docs/appendix/data/data-core-notices.md": [] }, + { "docs/appendix/data/data-core-nux.md": [] }, + { "docs/appendix/data/data-core-viewport.md": [] } + ] }, + { "docs/appendix/backward-compatibility/README.md": [ + { "docs/appendix/backward-compatibility/deprecations.md": [] }, + { "docs/appendix/backward-compatibility/meta-box.md": [] } + ] }, + { "docs/appendix/glossary.md": [] }, + { "docs/appendix/faq.md": [] }, + { "docs/appendix/versions-in-wordpress.md": [] }, + { "docs/appendix/history.md": [] }, + { "docs/appendix/outreach.md": [] } + ] }, + { "docs/contributors/readme.md": [ { "docs/contributors/develop.md": [ { "docs/contributors/getting-started.md": [] }, { "docs/contributors/git-workflow.md": [] }, @@ -95,75 +159,11 @@ { "docs/contributors/triage.md": [] }, { "docs/contributors/localizing.md": [] }, { "docs/contributors/repository-management.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ - { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ - { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ - { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ - { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/format-api/README.md": [ - { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-based-theme/README.md": [ - { "docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md": [] } - ] } - ] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/designers-developers/developers/data/README.md": [ - { "docs/designers-developers/developers/data/data-core.md": []}, - { "docs/designers-developers/developers/data/data-core-annotations.md": [] }, - { "docs/designers-developers/developers/data/data-core-blocks.md": [] }, - { "docs/designers-developers/developers/data/data-core-block-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-editor.md": [] }, - { "docs/designers-developers/developers/data/data-core-edit-post.md": [] }, - { "docs/designers-developers/developers/data/data-core-notices.md": [] }, - { "docs/designers-developers/developers/data/data-core-nux.md": [] }, - { "docs/designers-developers/developers/data/data-core-viewport.md": [] } - ] }, - { "docs/designers-developers/developers/packages.md": "{{packages}}" } + ] }, + { "docs/designers-developers/designers/README.md": [ + { "docs/designers-developers/designers/block-design.md": [] }, + { "docs/designers-developers/designers/user-interface.md": [] }, + { "docs/designers-developers/designers/design-resources.md": [] }, + { "docs/designers-developers/designers/animation.md": [] } + ] } ] From 487a3cbab1e466366721a0cb03ce62773805cc38 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 09:35:42 +0100 Subject: [PATCH 40/68] Update toc.json --- docs/toc.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/toc.json b/docs/toc.json index 40ae9c326dce2..99b53b77e362d 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -167,3 +167,4 @@ { "docs/designers-developers/designers/animation.md": [] } ] } ] + From c324cae57d90f8adb616c07f5ac0756349aaaf93 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 09:53:45 +0100 Subject: [PATCH 41/68] Update toc.json --- docs/toc.json | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/toc.json b/docs/toc.json index 99b53b77e362d..40ae9c326dce2 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -167,4 +167,3 @@ { "docs/designers-developers/designers/animation.md": [] } ] } ] - From 366028498e6f811a1e66f29f8f6acade8c3c8906 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Mon, 8 Feb 2021 10:10:52 +0100 Subject: [PATCH 42/68] Update toc structure --- docs/manifest.json | 300 ++++++++++++++++++++++----------------------- docs/toc.json | 62 +++++----- 2 files changed, 181 insertions(+), 181 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 69dc087724f1a..2dc8b309f642e 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -539,6 +539,156 @@ "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, + { + "title": "Designer Documentation", + "slug": "designers", + "markdown_source": "../docs/designers-developers/designers/README.md", + "parent": null + }, + { + "title": "Block Design", + "slug": "block-design", + "markdown_source": "../docs/designers-developers/designers/block-design.md", + "parent": "designers" + }, + { + "title": "User Interface", + "slug": "user-interface", + "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "parent": "designers" + }, + { + "title": "Resources", + "slug": "design-resources", + "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "parent": "designers" + }, + { + "title": "Animation", + "slug": "animation", + "markdown_source": "../docs/designers-developers/designers/animation.md", + "parent": "designers" + }, + { + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/readme.md", + "parent": null + }, + { + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/develop.md", + "parent": "contributors" + }, + { + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/getting-started.md", + "parent": "develop" + }, + { + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/git-workflow.md", + "parent": "develop" + }, + { + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/coding-guidelines.md", + "parent": "develop" + }, + { + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, { "title": "Architecture", "slug": "architecture", @@ -1720,155 +1870,5 @@ "slug": "outreach", "markdown_source": "../docs/appendix/outreach.md", "parent": "appendix" - }, - { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", - "parent": null - }, - { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" - }, - { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" - }, - { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" - }, - { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" - }, - { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" - }, - { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" - }, - { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" - }, - { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" - }, - { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" - }, - { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" - }, - { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" - }, - { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" - }, - { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" - }, - { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" - }, - { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" - }, - { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" - }, - { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" - }, - { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" - }, - { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" - }, - { - "title": "Designer Documentation", - "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null - }, - { - "title": "Block Design", - "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", - "parent": "designers" - }, - { - "title": "User Interface", - "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", - "parent": "designers" - }, - { - "title": "Resources", - "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", - "parent": "designers" - }, - { - "title": "Animation", - "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", - "parent": "designers" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 40ae9c326dce2..12217ff913c81 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -104,6 +104,36 @@ ] } ] } ] }, + { "docs/designers-developers/designers/README.md": [ + { "docs/designers-developers/designers/block-design.md": [] }, + { "docs/designers-developers/designers/user-interface.md": [] }, + { "docs/designers-developers/designers/design-resources.md": [] }, + { "docs/designers-developers/designers/animation.md": [] } + ] }, + { "docs/contributors/readme.md": [ + { "docs/contributors/develop.md": [ + { "docs/contributors/getting-started.md": [] }, + { "docs/contributors/git-workflow.md": [] }, + { "docs/contributors/coding-guidelines.md": [] }, + { "docs/contributors/testing-overview.md": [] }, + { "docs/contributors/grammar.md": [] }, + { "docs/contributors/scripts.md": [] }, + { "docs/contributors/managing-packages.md": [] }, + { "docs/contributors/release.md": [] }, + { "docs/contributors/native-mobile.md": [] }, + { "docs/contributors/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design.md": [ + { "docs/contributors/the-block.md": [] }, + { "docs/contributors/reference.md": [] } + ] }, + { "docs/contributors/document.md": [ + { "docs/contributors/copy-guide.md": [] } + ] }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/repository-management.md": [] } + ] }, { "docs/architecture/readme.md": [ { "docs/architecture/key-concepts.md": [] }, { "docs/architecture/data-flow.md": [] }, @@ -135,35 +165,5 @@ { "docs/appendix/versions-in-wordpress.md": [] }, { "docs/appendix/history.md": [] }, { "docs/appendix/outreach.md": [] } - ] }, - { "docs/contributors/readme.md": [ - { "docs/contributors/develop.md": [ - { "docs/contributors/getting-started.md": [] }, - { "docs/contributors/git-workflow.md": [] }, - { "docs/contributors/coding-guidelines.md": [] }, - { "docs/contributors/testing-overview.md": [] }, - { "docs/contributors/grammar.md": [] }, - { "docs/contributors/scripts.md": [] }, - { "docs/contributors/managing-packages.md": [] }, - { "docs/contributors/release.md": [] }, - { "docs/contributors/native-mobile.md": [] }, - { "docs/contributors/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design.md": [ - { "docs/contributors/the-block.md": [] }, - { "docs/contributors/reference.md": [] } - ] }, - { "docs/contributors/document.md": [ - { "docs/contributors/copy-guide.md": [] } - ] }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/repository-management.md": [] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] } + ] } ] From 48a960014a5dc859682d0b708aaf73e326a55cb1 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 12:09:07 +0100 Subject: [PATCH 43/68] Update manifest.json and toc.json --- docs/manifest.json | 1014 ++++++++++++++++++++++---------------------- docs/toc.json | 330 +++++++------- 2 files changed, 674 insertions(+), 670 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 2dc8b309f642e..d929c5c1f0771 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,747 +1,645 @@ [ { "title": "Getting started", - "slug": "handbook", - "markdown_source": "../docs/README.md", - "parent": null - }, - { - "title": "Developer Documentation", - "slug": "developers", - "markdown_source": "../docs/designers-developers/developers/README.md", + "slug": "getting-started", + "markdown_source": "../docs/getting-started/README.md", "parent": null }, { - "title": "FullSiteEditingTemplates", - "slug": "full-site-editing-templates", - "markdown_source": "../docs/designers-developers/developers/full-site-editing-templates.md", - "parent": "developers" - }, - { - "title": "Filter Reference", - "slug": "filters", - "markdown_source": "../docs/designers-developers/developers/filters/README.md", - "parent": "developers" - }, - { - "title": "Block Filters", - "slug": "block-filters", - "markdown_source": "../docs/designers-developers/developers/filters/block-filters.md", - "parent": "filters" - }, - { - "title": "Editor Filters", - "slug": "editor-filters", - "markdown_source": "../docs/designers-developers/developers/filters/editor-filters.md", - "parent": "filters" - }, - { - "title": "Parser Filters", - "slug": "parser-filters", - "markdown_source": "../docs/designers-developers/developers/filters/parser-filters.md", - "parent": "filters" - }, - { - "title": "Autocomplete", - "slug": "autocomplete-filters", - "markdown_source": "../docs/designers-developers/developers/filters/autocomplete-filters.md", - "parent": "filters" - }, - { - "title": "Block API Reference", - "slug": "block-api", - "markdown_source": "../docs/designers-developers/developers/block-api/README.md", - "parent": "developers" - }, - { - "title": "Block Registration", - "slug": "block-registration", - "markdown_source": "../docs/designers-developers/developers/block-api/block-registration.md", - "parent": "block-api" - }, - { - "title": "Edit and Save", - "slug": "block-edit-save", - "markdown_source": "../docs/designers-developers/developers/block-api/block-edit-save.md", - "parent": "block-api" - }, - { - "title": "Attributes", - "slug": "block-attributes", - "markdown_source": "../docs/designers-developers/developers/block-api/block-attributes.md", - "parent": "block-api" - }, - { - "title": "Block Context", - "slug": "block-context", - "markdown_source": "../docs/designers-developers/developers/block-api/block-context.md", - "parent": "block-api" - }, - { - "title": "Deprecated Blocks", - "slug": "block-deprecation", - "markdown_source": "../docs/designers-developers/developers/block-api/block-deprecation.md", - "parent": "block-api" - }, - { - "title": "Block Supports", - "slug": "block-supports", - "markdown_source": "../docs/designers-developers/developers/block-api/block-supports.md", - "parent": "block-api" - }, - { - "title": "Block Transforms", - "slug": "block-transforms", - "markdown_source": "../docs/designers-developers/developers/block-api/block-transforms.md", - "parent": "block-api" - }, - { - "title": "Templates", - "slug": "block-templates", - "markdown_source": "../docs/designers-developers/developers/block-api/block-templates.md", - "parent": "block-api" - }, - { - "title": "Block Type Metadata", - "slug": "block-metadata", - "markdown_source": "../docs/designers-developers/developers/block-api/block-metadata.md", - "parent": "block-api" - }, - { - "title": "Block Patterns", - "slug": "block-patterns", - "markdown_source": "../docs/designers-developers/developers/block-api/block-patterns.md", - "parent": "block-api" - }, - { - "title": "Annotations", - "slug": "block-annotations", - "markdown_source": "../docs/designers-developers/developers/block-api/block-annotations.md", - "parent": "block-api" - }, - { - "title": "Block API Versions", - "slug": "versions", - "markdown_source": "../docs/designers-developers/developers/block-api/versions.md", - "parent": "block-api" - }, - { - "title": "SlotFills Reference", - "slug": "slotfills", - "markdown_source": "../docs/designers-developers/developers/slotfills/README.md", - "parent": "developers" + "title": "Tutorials", + "slug": "tutorials", + "markdown_source": "../docs/getting-started/tutorials/README.md", + "parent": "getting-started" }, { - "title": "MainDashboardButton", - "slug": "main-dashboard-button", - "markdown_source": "../docs/designers-developers/developers/slotfills/main-dashboard-button.md", - "parent": "slotfills" + "title": "Development Environment", + "slug": "devenv", + "markdown_source": "../docs/getting-started/tutorials/devenv/README.md", + "parent": "tutorials" }, { - "title": "PluginBlockSettingsMenuItem", - "slug": "plugin-block-settings-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md", - "parent": "slotfills" + "title": "How to setup local WordPress environment on Ubuntu", + "slug": "docker-ubuntu", + "markdown_source": "../docs/getting-started/tutorials/devenv/docker-ubuntu.md", + "parent": "devenv" }, { - "title": "PluginDocumentSettingPanel", - "slug": "plugin-document-setting-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md", - "parent": "slotfills" + "title": "Create a Block Tutorial", + "slug": "create-block", + "markdown_source": "../docs/getting-started/tutorials/create-block/README.md", + "parent": "tutorials" }, { - "title": "PluginMoreMenuItem", - "slug": "plugin-more-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-more-menu-item.md", - "parent": "slotfills" + "title": "WordPress Plugin", + "slug": "wp-plugin", + "markdown_source": "../docs/getting-started/tutorials/create-block/wp-plugin.md", + "parent": "create-block" }, { - "title": "PluginPostPublishPanel", - "slug": "plugin-post-publish-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md", - "parent": "slotfills" + "title": "Anatomy of a Block", + "slug": "block-anatomy", + "markdown_source": "../docs/getting-started/tutorials/create-block/block-anatomy.md", + "parent": "create-block" }, { - "title": "PluginPostStatusInfo", - "slug": "plugin-post-status-info", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-post-status-info.md", - "parent": "slotfills" + "title": "Block Attributes", + "slug": "attributes", + "markdown_source": "../docs/getting-started/tutorials/create-block/attributes.md", + "parent": "create-block" }, { - "title": "PluginPrePublishPanel", - "slug": "plugin-pre-publish-panel", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md", - "parent": "slotfills" + "title": "Code Implementation", + "slug": "block-code", + "markdown_source": "../docs/getting-started/tutorials/create-block/block-code.md", + "parent": "create-block" }, { - "title": "PluginSidebar", - "slug": "plugin-sidebar", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-sidebar.md", - "parent": "slotfills" + "title": "Authoring Experience", + "slug": "author-experience", + "markdown_source": "../docs/getting-started/tutorials/create-block/author-experience.md", + "parent": "create-block" }, { - "title": "PluginSidebarMoreMenuItem", - "slug": "plugin-sidebar-more-menu-item", - "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md", - "parent": "slotfills" + "title": "Finishing Touches", + "slug": "finishing", + "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", + "parent": "create-block" }, { - "title": "RichText Reference", - "slug": "richtext", - "markdown_source": "../docs/designers-developers/developers/richtext.md", - "parent": "developers" + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/getting-started/architecture/README.md", + "parent": "getting-started" }, { - "title": "Feature Flags", - "slug": "feature-flags", - "markdown_source": "../docs/designers-developers/developers/feature-flags.md", - "parent": "developers" + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/getting-started/architecture/key-concepts.md", + "parent": "architecture" }, { - "title": "Theming for the Block Editor", - "slug": "themes", - "markdown_source": "../docs/designers-developers/developers/themes/README.md", - "parent": "developers" + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/getting-started/architecture/data-flow.md", + "parent": "architecture" }, { - "title": "Theme Support", - "slug": "theme-support", - "markdown_source": "../docs/designers-developers/developers/themes/theme-support.md", - "parent": "themes" + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/getting-started/architecture/modularity.md", + "parent": "architecture" }, { - "title": "Block-based Themes (Experimental)", - "slug": "block-based-themes", - "markdown_source": "../docs/designers-developers/developers/themes/block-based-themes.md", - "parent": "themes" + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/getting-started/architecture/performance.md", + "parent": "architecture" }, { - "title": "Themes & Block Editor: experimental theme.json", - "slug": "theme-json", - "markdown_source": "../docs/designers-developers/developers/themes/theme-json.md", - "parent": "themes" + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/getting-started/architecture/automated-testing.md", + "parent": "architecture" }, { - "title": "Accessibility", - "slug": "accessibility", - "markdown_source": "../docs/designers-developers/developers/accessibility.md", - "parent": "developers" + "title": "Glossary", + "slug": "glossary", + "markdown_source": "../docs/getting-started/glossary.md", + "parent": "getting-started" }, { - "title": "Internationalization", - "slug": "internationalization", - "markdown_source": "../docs/designers-developers/developers/internationalization.md", - "parent": "developers" + "title": "Frequently Asked Questions", + "slug": "faq", + "markdown_source": "../docs/getting-started/faq.md", + "parent": "getting-started" }, { - "title": "Tutorials", - "slug": "tutorials", - "markdown_source": "../docs/designers-developers/developers/tutorials/readme.md", - "parent": "developers" + "title": "History", + "slug": "history", + "markdown_source": "../docs/getting-started/history.md", + "parent": "getting-started" }, { - "title": "Development Environment", - "slug": "devenv", - "markdown_source": "../docs/designers-developers/developers/tutorials/devenv/readme.md", - "parent": "tutorials" + "title": "Outreach", + "slug": "outreach", + "markdown_source": "../docs/getting-started/outreach.md", + "parent": "getting-started" }, { - "title": "How to setup local WordPress environment on Ubuntu", - "slug": "docker-ubuntu", - "markdown_source": "../docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md", - "parent": "devenv" + "title": "Developer Documentation", + "slug": "howto-guides", + "markdown_source": "../docs/howto-guides/README.md", + "parent": null }, { "title": "Getting Started with JavaScript", "slug": "javascript", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/readme.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/javascript/README.md", + "parent": "howto-guides" }, { "title": "Plugins Background", "slug": "plugins-background", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/plugins-background.md", + "markdown_source": "../docs/howto-guides/javascript/plugins-background.md", "parent": "javascript" }, { "title": "Loading JavaScript", "slug": "loading-javascript", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/loading-javascript.md", + "markdown_source": "../docs/howto-guides/javascript/loading-javascript.md", "parent": "javascript" }, { "title": "Extending the Block Editor", "slug": "extending-the-block-editor", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md", + "markdown_source": "../docs/howto-guides/javascript/extending-the-block-editor.md", "parent": "javascript" }, { "title": "Troubleshooting", "slug": "troubleshooting", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/troubleshooting.md", + "markdown_source": "../docs/howto-guides/javascript/troubleshooting.md", "parent": "javascript" }, { "title": "JavaScript Versions and Build Step", "slug": "versions-and-building", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/versions-and-building.md", + "markdown_source": "../docs/howto-guides/javascript/versions-and-building.md", "parent": "javascript" }, { "title": "Scope Your Code", "slug": "scope-your-code", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/scope-your-code.md", + "markdown_source": "../docs/howto-guides/javascript/scope-your-code.md", "parent": "javascript" }, { "title": "JavaScript Build Setup", "slug": "js-build-setup", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/js-build-setup.md", + "markdown_source": "../docs/howto-guides/javascript/js-build-setup.md", "parent": "javascript" }, { "title": "ESNext Syntax", "slug": "esnext-js", - "markdown_source": "../docs/designers-developers/developers/tutorials/javascript/esnext-js.md", + "markdown_source": "../docs/howto-guides/javascript/esnext-js.md", "parent": "javascript" }, { - "title": "Create a Block Tutorial", - "slug": "create-block", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/readme.md", - "parent": "tutorials" + "title": "Meta Boxes", + "slug": "metabox", + "markdown_source": "../docs/howto-guides/metabox/README.md", + "parent": "howto-guides" }, { - "title": "WordPress Plugin", - "slug": "wp-plugin", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/wp-plugin.md", - "parent": "create-block" + "title": "Store Post Meta with a Block", + "slug": "meta-block-1-intro", + "markdown_source": "../docs/howto-guides/metabox/meta-block-1-intro.md", + "parent": "metabox" }, { - "title": "Anatomy of a Block", - "slug": "block-anatomy", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/block-anatomy.md", - "parent": "create-block" + "title": "Register Meta Field", + "slug": "meta-block-2-register-meta", + "markdown_source": "../docs/howto-guides/metabox/meta-block-2-register-meta.md", + "parent": "metabox" }, { - "title": "Block Attributes", - "slug": "attributes", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/attributes.md", - "parent": "create-block" + "title": "Create Meta Block", + "slug": "meta-block-3-add", + "markdown_source": "../docs/howto-guides/metabox/meta-block-3-add.md", + "parent": "metabox" }, { - "title": "Code Implementation", - "slug": "block-code", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/block-code.md", - "parent": "create-block" + "title": "Use Post Meta Data", + "slug": "meta-block-4-use-data", + "markdown_source": "../docs/howto-guides/metabox/meta-block-4-use-data.md", + "parent": "metabox" }, { - "title": "Authoring Experience", - "slug": "author-experience", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/author-experience.md", - "parent": "create-block" + "title": "Finishing Touches", + "slug": "meta-block-5-finishing", + "markdown_source": "../docs/howto-guides/metabox/meta-block-5-finishing.md", + "parent": "metabox" }, { - "title": "Finishing Touches", - "slug": "finishing", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/finishing.md", - "parent": "create-block" + "title": "Displaying Notices from Your Plugin or Theme", + "slug": "notices", + "markdown_source": "../docs/howto-guides/notices/README.md", + "parent": "howto-guides" }, { - "title": "Share your Block with the World", - "slug": "submitting-to-block-directory", - "markdown_source": "../docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md", - "parent": "create-block" + "title": "Creating a Sidebar for Your Plugin", + "slug": "plugin-sidebar-0", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md", + "parent": "howto-guides" + }, + { + "title": "Get a Sidebar up and Running", + "slug": "plugin-sidebar-1-up-and-running", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Tweak the sidebar style and add controls", + "slug": "plugin-sidebar-2-styles-and-controls", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Register the Meta Field", + "slug": "plugin-sidebar-3-register-meta", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Initialize the Input Control", + "slug": "plugin-sidebar-4-initialize-input", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Update the Meta Field When the Input's Content Changes", + "slug": "plugin-sidebar-5-update-meta", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", + "parent": "plugin-sidebar-0" + }, + { + "title": "Finishing Touches", + "slug": "plugin-sidebar-6-finishing-touches", + "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", + "parent": "plugin-sidebar-0" }, { "title": "Blocks", "slug": "block-tutorial", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/readme.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/block-tutorial/README.md", + "parent": "howto-guides" }, { "title": "Writing Your First Block Type", "slug": "writing-your-first-block-type", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md", + "markdown_source": "../docs/howto-guides/block-tutorial/writing-your-first-block-type.md", "parent": "block-tutorial" }, { "title": "Applying Styles From a Stylesheet", "slug": "applying-styles-with-stylesheets", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md", + "markdown_source": "../docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md", "parent": "block-tutorial" }, { "title": "Introducing Attributes and Editable Fields", "slug": "introducing-attributes-and-editable-fields", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md", + "markdown_source": "../docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md", "parent": "block-tutorial" }, { "title": "Block Controls: Block Toolbar and Settings Sidebar", "slug": "block-controls-toolbar-and-sidebar", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md", + "markdown_source": "../docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", "parent": "block-tutorial" }, { "title": "Creating dynamic blocks", "slug": "creating-dynamic-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md", + "markdown_source": "../docs/howto-guides/block-tutorial/creating-dynamic-blocks.md", "parent": "block-tutorial" }, { "title": "Generate Blocks with WP-CLI", "slug": "generate-blocks-with-wp-cli", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md", + "markdown_source": "../docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md", "parent": "block-tutorial" }, { "title": "Nested Blocks: Using InnerBlocks", "slug": "nested-blocks-inner-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md", + "markdown_source": "../docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md", "parent": "block-tutorial" }, { - "title": "Meta Boxes", - "slug": "metabox", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/readme.md", - "parent": "tutorials" - }, - { - "title": "Store Post Meta with a Block", - "slug": "meta-block-1-intro", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md", - "parent": "metabox" - }, - { - "title": "Register Meta Field", - "slug": "meta-block-2-register-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md", - "parent": "metabox" - }, - { - "title": "Create Meta Block", - "slug": "meta-block-3-add", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md", - "parent": "metabox" - }, - { - "title": "Use Post Meta Data", - "slug": "meta-block-4-use-data", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md", - "parent": "metabox" - }, - { - "title": "Finishing Touches", - "slug": "meta-block-5-finishing", - "markdown_source": "../docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md", - "parent": "metabox" + "title": "Feature Flags", + "slug": "feature-flags", + "markdown_source": "../docs/howto-guides/feature-flags.md", + "parent": "howto-guides" }, { - "title": "Displaying Notices from Your Plugin or Theme", - "slug": "notices", - "markdown_source": "../docs/designers-developers/developers/tutorials/notices/README.md", - "parent": "tutorials" + "title": "Theming for the Block Editor", + "slug": "themes", + "markdown_source": "../docs/howto-guides/themes/README.md", + "parent": "howto-guides" }, { - "title": "Creating a Sidebar for Your Plugin", - "slug": "plugin-sidebar-0", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md", - "parent": "tutorials" + "title": "Theme Support", + "slug": "theme-support", + "markdown_source": "../docs/howto-guides/themes/theme-support.md", + "parent": "themes" }, { - "title": "Get a Sidebar up and Running", - "slug": "plugin-sidebar-1-up-and-running", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", - "parent": "plugin-sidebar-0" + "title": "Themes & Block Editor: experimental theme.json", + "slug": "theme-json", + "markdown_source": "../docs/howto-guides/themes/theme-json.md", + "parent": "themes" }, { - "title": "Tweak the sidebar style and add controls", - "slug": "plugin-sidebar-2-styles-and-controls", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", - "parent": "plugin-sidebar-0" + "title": "Creating a block-based theme", + "slug": "block-based-themes", + "markdown_source": "../docs/howto-guides/block-based-themes/README.md", + "parent": "howto-guides" }, { - "title": "Register the Meta Field", - "slug": "plugin-sidebar-3-register-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md", - "parent": "plugin-sidebar-0" + "title": "Adding blocks to your theme", + "slug": "block-based-themes-2-adding-blocks", + "markdown_source": "../docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md", + "parent": "block-based-themes" }, { - "title": "Initialize the Input Control", - "slug": "plugin-sidebar-4-initialize-input", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", - "parent": "plugin-sidebar-0" + "title": "Backward Compatibility", + "slug": "backward-compatibility", + "markdown_source": "../docs/howto-guides/backward-compatibility/README.md", + "parent": "howto-guides" }, { - "title": "Update the Meta Field When the Input's Content Changes", - "slug": "plugin-sidebar-5-update-meta", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md", - "parent": "plugin-sidebar-0" + "title": "Deprecations", + "slug": "deprecations", + "markdown_source": "../docs/howto-guides/backward-compatibility/deprecations.md", + "parent": "backward-compatibility" }, { - "title": "Finishing Touches", - "slug": "plugin-sidebar-6-finishing-touches", - "markdown_source": "../docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", - "parent": "plugin-sidebar-0" + "title": "Meta Boxes", + "slug": "meta-box", + "markdown_source": "../docs/howto-guides/backward-compatibility/meta-box.md", + "parent": "backward-compatibility" }, { "title": "Introduction to the Format API", "slug": "format-api", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/README.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/format-api/README.md", + "parent": "howto-guides" }, { "title": "Register a New Format", "slug": "1-register-format", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/1-register-format.md", + "markdown_source": "../docs/howto-guides/format-api/1-register-format.md", "parent": "format-api" }, { "title": "Add a Button to the Toolbar", "slug": "2-toolbar-button", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md", + "markdown_source": "../docs/howto-guides/format-api/2-toolbar-button.md", "parent": "format-api" }, { "title": "Apply the Format When the Button Is Clicked", "slug": "3-apply-format", - "markdown_source": "../docs/designers-developers/developers/tutorials/format-api/3-apply-format.md", + "markdown_source": "../docs/howto-guides/format-api/3-apply-format.md", "parent": "format-api" }, - { - "title": "Creating a block-based theme", - "slug": "block-based-theme", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-theme/README.md", - "parent": "tutorials" - }, - { - "title": "Adding blocks to your theme", - "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md", - "parent": "block-based-theme" - }, { "title": "Gutenberg as a Development Platform", "slug": "platform", - "markdown_source": "../docs/designers-developers/developers/platform/README.md", - "parent": "tutorials" + "markdown_source": "../docs/howto-guides/platform/README.md", + "parent": "howto-guides" }, { "title": "Building a custom block editor", "slug": "custom-block-editor", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/README.md", + "markdown_source": "../docs/howto-guides/platform/custom-block-editor/README.md", "parent": "platform" }, { "title": "Tutorial: building a custom block editor", "slug": "tutorial", - "markdown_source": "../docs/designers-developers/developers/platform/custom-block-editor/tutorial.md", + "markdown_source": "../docs/howto-guides/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, { "title": "Designer Documentation", "slug": "designers", - "markdown_source": "../docs/designers-developers/designers/README.md", - "parent": null + "markdown_source": "../docs/howto-guides/designers/README.md", + "parent": "howto-guides" }, { "title": "Block Design", "slug": "block-design", - "markdown_source": "../docs/designers-developers/designers/block-design.md", + "markdown_source": "../docs/howto-guides/designers/block-design.md", "parent": "designers" }, { "title": "User Interface", "slug": "user-interface", - "markdown_source": "../docs/designers-developers/designers/user-interface.md", + "markdown_source": "../docs/howto-guides/designers/user-interface.md", "parent": "designers" }, { "title": "Resources", "slug": "design-resources", - "markdown_source": "../docs/designers-developers/designers/design-resources.md", + "markdown_source": "../docs/howto-guides/designers/design-resources.md", "parent": "designers" }, { "title": "Animation", "slug": "animation", - "markdown_source": "../docs/designers-developers/designers/animation.md", + "markdown_source": "../docs/howto-guides/designers/animation.md", "parent": "designers" }, { - "title": "Contributor Guide", - "slug": "contributors", - "markdown_source": "../docs/contributors/readme.md", + "title": "Accessibility", + "slug": "accessibility", + "markdown_source": "../docs/howto-guides/accessibility.md", + "parent": "howto-guides" + }, + { + "title": "Internationalization", + "slug": "internationalization", + "markdown_source": "../docs/howto-guides/internationalization.md", + "parent": "howto-guides" + }, + { + "title": "ReferenceGuides", + "slug": "reference-guides", + "markdown_source": "../docs/reference-guides/README.md", "parent": null }, { - "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/develop.md", - "parent": "contributors" + "title": "Block API Reference", + "slug": "block-api", + "markdown_source": "../docs/reference-guides/block-api/README.md", + "parent": "reference-guides" }, { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/getting-started.md", - "parent": "develop" + "title": "Block Registration", + "slug": "block-registration", + "markdown_source": "../docs/reference-guides/block-api/block-registration.md", + "parent": "block-api" }, { - "title": "Git Workflow", - "slug": "git-workflow", - "markdown_source": "../docs/contributors/git-workflow.md", - "parent": "develop" + "title": "Edit and Save", + "slug": "block-edit-save", + "markdown_source": "../docs/reference-guides/block-api/block-edit-save.md", + "parent": "block-api" }, { - "title": "Coding Guidelines", - "slug": "coding-guidelines", - "markdown_source": "../docs/contributors/coding-guidelines.md", - "parent": "develop" + "title": "Attributes", + "slug": "block-attributes", + "markdown_source": "../docs/reference-guides/block-api/block-attributes.md", + "parent": "block-api" }, { - "title": "Testing Overview", - "slug": "testing-overview", - "markdown_source": "../docs/contributors/testing-overview.md", - "parent": "develop" + "title": "Block Context", + "slug": "block-context", + "markdown_source": "../docs/reference-guides/block-api/block-context.md", + "parent": "block-api" + }, + { + "title": "Deprecated Blocks", + "slug": "block-deprecation", + "markdown_source": "../docs/reference-guides/block-api/block-deprecation.md", + "parent": "block-api" + }, + { + "title": "Block Supports", + "slug": "block-supports", + "markdown_source": "../docs/reference-guides/block-api/block-supports.md", + "parent": "block-api" }, { - "title": "Block Grammar", - "slug": "grammar", - "markdown_source": "../docs/contributors/grammar.md", - "parent": "develop" + "title": "Block Transforms", + "slug": "block-transforms", + "markdown_source": "../docs/reference-guides/block-api/block-transforms.md", + "parent": "block-api" }, { - "title": "Scripts", - "slug": "scripts", - "markdown_source": "../docs/contributors/scripts.md", - "parent": "develop" + "title": "Templates", + "slug": "block-templates", + "markdown_source": "../docs/reference-guides/block-api/block-templates.md", + "parent": "block-api" }, { - "title": "Managing Packages", - "slug": "managing-packages", - "markdown_source": "../docs/contributors/managing-packages.md", - "parent": "develop" + "title": "Block Type Metadata", + "slug": "block-metadata", + "markdown_source": "../docs/reference-guides/block-api/block-metadata.md", + "parent": "block-api" }, { - "title": "Gutenberg Release Process", - "slug": "release", - "markdown_source": "../docs/contributors/release.md", - "parent": "develop" + "title": "Block Patterns", + "slug": "block-patterns", + "markdown_source": "../docs/reference-guides/block-api/block-patterns.md", + "parent": "block-api" }, { - "title": "React Native based mobile Gutenberg", - "slug": "native-mobile", - "markdown_source": "../docs/contributors/native-mobile.md", - "parent": "develop" + "title": "Annotations", + "slug": "block-annotations", + "markdown_source": "../docs/reference-guides/block-api/block-annotations.md", + "parent": "block-api" }, { - "title": "Getting Started for the React Native based Mobile Gutenberg", - "slug": "getting-started-native-mobile", - "markdown_source": "../docs/contributors/getting-started-native-mobile.md", - "parent": "develop" + "title": "Block API Versions", + "slug": "versions", + "markdown_source": "../docs/reference-guides/block-api/versions.md", + "parent": "block-api" }, { - "title": "Design Contributions", - "slug": "design", - "markdown_source": "../docs/contributors/design.md", - "parent": "contributors" + "title": "Filter Reference", + "slug": "filters", + "markdown_source": "../docs/reference-guides/filters/README.md", + "parent": "reference-guides" }, { - "title": "Blocks are the Interface", - "slug": "the-block", - "markdown_source": "../docs/contributors/the-block.md", - "parent": "design" + "title": "Block Filters", + "slug": "block-filters", + "markdown_source": "../docs/reference-guides/filters/block-filters.md", + "parent": "filters" }, { - "title": "Reference", - "slug": "reference", - "markdown_source": "../docs/contributors/reference.md", - "parent": "design" + "title": "Editor Filters", + "slug": "editor-filters", + "markdown_source": "../docs/reference-guides/filters/editor-filters.md", + "parent": "filters" }, { - "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/document.md", - "parent": "contributors" + "title": "Parser Filters", + "slug": "parser-filters", + "markdown_source": "../docs/reference-guides/filters/parser-filters.md", + "parent": "filters" }, { - "title": "Copy Guidelines", - "slug": "copy-guide", - "markdown_source": "../docs/contributors/copy-guide.md", - "parent": "document" + "title": "Autocomplete", + "slug": "autocomplete-filters", + "markdown_source": "../docs/reference-guides/filters/autocomplete-filters.md", + "parent": "filters" }, { - "title": "Triage", - "slug": "triage", - "markdown_source": "../docs/contributors/triage.md", - "parent": "contributors" + "title": "SlotFills Reference", + "slug": "slotfills", + "markdown_source": "../docs/reference-guides/slotfills/README.md", + "parent": "reference-guides" }, { - "title": "Localizing Gutenberg Plugin", - "slug": "localizing", - "markdown_source": "../docs/contributors/localizing.md", - "parent": "contributors" + "title": "MainDashboardButton", + "slug": "main-dashboard-button", + "markdown_source": "../docs/reference-guides/slotfills/main-dashboard-button.md", + "parent": "slotfills" }, { - "title": "Repository Management", - "slug": "repository-management", - "markdown_source": "../docs/contributors/repository-management.md", - "parent": "contributors" + "title": "PluginBlockSettingsMenuItem", + "slug": "plugin-block-settings-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-block-settings-menu-item.md", + "parent": "slotfills" }, { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/architecture/readme.md", - "parent": null + "title": "PluginDocumentSettingPanel", + "slug": "plugin-document-setting-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-document-setting-panel.md", + "parent": "slotfills" }, { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/architecture/key-concepts.md", - "parent": "architecture" + "title": "PluginMoreMenuItem", + "slug": "plugin-more-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-more-menu-item.md", + "parent": "slotfills" }, { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/architecture/data-flow.md", - "parent": "architecture" + "title": "PluginPostPublishPanel", + "slug": "plugin-post-publish-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-post-publish-panel.md", + "parent": "slotfills" }, { - "title": "Folder Structure", - "slug": "folder-structure", - "markdown_source": "../docs/architecture/folder-structure.md", - "parent": "architecture" + "title": "PluginPostStatusInfo", + "slug": "plugin-post-status-info", + "markdown_source": "../docs/reference-guides/slotfills/plugin-post-status-info.md", + "parent": "slotfills" }, { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/architecture/modularity.md", - "parent": "architecture" + "title": "PluginPrePublishPanel", + "slug": "plugin-pre-publish-panel", + "markdown_source": "../docs/reference-guides/slotfills/plugin-pre-publish-panel.md", + "parent": "slotfills" }, { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/architecture/performance.md", - "parent": "architecture" + "title": "PluginSidebar", + "slug": "plugin-sidebar", + "markdown_source": "../docs/reference-guides/slotfills/plugin-sidebar.md", + "parent": "slotfills" }, { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/architecture/automated-testing.md", - "parent": "architecture" + "title": "PluginSidebarMoreMenuItem", + "slug": "plugin-sidebar-more-menu-item", + "markdown_source": "../docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md", + "parent": "slotfills" }, { - "title": "Appendix", - "slug": "appendix", - "markdown_source": "../docs/appendix/readme.md", - "parent": null + "title": "RichText Reference", + "slug": "richtext", + "markdown_source": "../docs/reference-guides/richtext.md", + "parent": "reference-guides" }, { "title": "Component Reference", "slug": "components", "markdown_source": "../packages/components/README.md", - "parent": "appendix" + "parent": "reference-guides" }, { "title": "AlignmentMatrixControl", @@ -1256,8 +1154,8 @@ { "title": "Package Reference", "slug": "packages", - "markdown_source": "../docs/appendix/packages.md", - "parent": "appendix" + "markdown_source": "../docs/reference-guides/packages.md", + "parent": "reference-guides" }, { "title": "@wordpress/a11y", @@ -1766,109 +1664,211 @@ { "title": "Data Module Reference", "slug": "data", - "markdown_source": "../docs/appendix/data/README.md", - "parent": "appendix" + "markdown_source": "../docs/reference-guides/data/README.md", + "parent": "reference-guides" }, { "title": "WordPress Core Data", "slug": "data-core", - "markdown_source": "../docs/appendix/data/data-core.md", + "markdown_source": "../docs/reference-guides/data/data-core.md", "parent": "data" }, { "title": "Annotations", "slug": "data-core-annotations", - "markdown_source": "../docs/appendix/data/data-core-annotations.md", + "markdown_source": "../docs/reference-guides/data/data-core-annotations.md", "parent": "data" }, { "title": "Block Types Data", "slug": "data-core-blocks", - "markdown_source": "../docs/appendix/data/data-core-blocks.md", + "markdown_source": "../docs/reference-guides/data/data-core-blocks.md", "parent": "data" }, { "title": "The Block Editor’s Data", "slug": "data-core-block-editor", - "markdown_source": "../docs/appendix/data/data-core-block-editor.md", + "markdown_source": "../docs/reference-guides/data/data-core-block-editor.md", "parent": "data" }, { "title": "The Post Editor’s Data", "slug": "data-core-editor", - "markdown_source": "../docs/appendix/data/data-core-editor.md", + "markdown_source": "../docs/reference-guides/data/data-core-editor.md", "parent": "data" }, { "title": "The Editor’s UI Data", "slug": "data-core-edit-post", - "markdown_source": "../docs/appendix/data/data-core-edit-post.md", + "markdown_source": "../docs/reference-guides/data/data-core-edit-post.md", "parent": "data" }, { "title": "Notices Data", "slug": "data-core-notices", - "markdown_source": "../docs/appendix/data/data-core-notices.md", + "markdown_source": "../docs/reference-guides/data/data-core-notices.md", "parent": "data" }, { "title": "The NUX (New User Experience) Data", "slug": "data-core-nux", - "markdown_source": "../docs/appendix/data/data-core-nux.md", + "markdown_source": "../docs/reference-guides/data/data-core-nux.md", "parent": "data" }, { "title": "The Viewport Data", "slug": "data-core-viewport", - "markdown_source": "../docs/appendix/data/data-core-viewport.md", + "markdown_source": "../docs/reference-guides/data/data-core-viewport.md", "parent": "data" }, { - "title": "Backward Compatibility", - "slug": "backward-compatibility", - "markdown_source": "../docs/appendix/backward-compatibility/README.md", - "parent": "appendix" + "title": "Explanations", + "slug": "explanations", + "markdown_source": "../docs/explanations/README.md", + "parent": null }, { - "title": "Deprecations", - "slug": "deprecations", - "markdown_source": "../docs/appendix/backward-compatibility/deprecations.md", - "parent": "backward-compatibility" + "title": "FullSiteEditingTemplates", + "slug": "full-site-editing-templates", + "markdown_source": "../docs/explanations/full-site-editing-templates.md", + "parent": "explanations" }, { - "title": "Meta Boxes", - "slug": "meta-box", - "markdown_source": "../docs/appendix/backward-compatibility/meta-box.md", - "parent": "backward-compatibility" + "title": "Contributor Guide", + "slug": "contributors", + "markdown_source": "../docs/contributors/README.md", + "parent": null }, { - "title": "Glossary", - "slug": "glossary", - "markdown_source": "../docs/appendix/glossary.md", - "parent": "appendix" + "title": "Code Contributions", + "slug": "develop", + "markdown_source": "../docs/contributors/code/develop.md", + "parent": "contributors" }, { - "title": "Frequently Asked Questions", - "slug": "faq", - "markdown_source": "../docs/appendix/faq.md", - "parent": "appendix" + "title": "Getting Started", + "slug": "getting-started", + "markdown_source": "../docs/contributors/code/getting-started.md", + "parent": "develop" }, { - "title": "Versions in WordPress", - "slug": "versions-in-wordpress", - "markdown_source": "../docs/appendix/versions-in-wordpress.md", - "parent": "appendix" + "title": "Git Workflow", + "slug": "git-workflow", + "markdown_source": "../docs/contributors/code/git-workflow.md", + "parent": "develop" }, { - "title": "History", - "slug": "history", - "markdown_source": "../docs/appendix/history.md", - "parent": "appendix" + "title": "Coding Guidelines", + "slug": "coding-guidelines", + "markdown_source": "../docs/contributors/code/coding-guidelines.md", + "parent": "develop" }, { - "title": "Outreach", - "slug": "outreach", - "markdown_source": "../docs/appendix/outreach.md", - "parent": "appendix" + "title": "Testing Overview", + "slug": "testing-overview", + "markdown_source": "../docs/contributors/code/testing-overview.md", + "parent": "develop" + }, + { + "title": "Block Grammar", + "slug": "grammar", + "markdown_source": "../docs/contributors/code/grammar.md", + "parent": "develop" + }, + { + "title": "Scripts", + "slug": "scripts", + "markdown_source": "../docs/contributors/code/scripts.md", + "parent": "develop" + }, + { + "title": "Managing Packages", + "slug": "managing-packages", + "markdown_source": "../docs/contributors/code/managing-packages.md", + "parent": "develop" + }, + { + "title": "Gutenberg Release Process", + "slug": "release", + "markdown_source": "../docs/contributors/code/release.md", + "parent": "develop" + }, + { + "title": "React Native based mobile Gutenberg", + "slug": "native-mobile", + "markdown_source": "../docs/contributors/code/native-mobile.md", + "parent": "develop" + }, + { + "title": "Getting Started for the React Native based Mobile Gutenberg", + "slug": "getting-started-native-mobile", + "markdown_source": "../docs/contributors/code/getting-started-native-mobile.md", + "parent": "develop" + }, + { + "title": "Design Contributions", + "slug": "design", + "markdown_source": "../docs/contributors/design/design.md", + "parent": "contributors" + }, + { + "title": "Blocks are the Interface", + "slug": "the-block", + "markdown_source": "../docs/contributors/design/the-block.md", + "parent": "design" + }, + { + "title": "Reference", + "slug": "reference", + "markdown_source": "../docs/contributors/design/reference.md", + "parent": "design" + }, + { + "title": "Documentation Contributions", + "slug": "document", + "markdown_source": "../docs/contributors/documentation/document.md", + "parent": "contributors" + }, + { + "title": "Copy Guidelines", + "slug": "copy-guide", + "markdown_source": "../docs/contributors/documentation/copy-guide.md", + "parent": "document" + }, + { + "title": "Triage", + "slug": "triage", + "markdown_source": "../docs/contributors/triage.md", + "parent": "contributors" + }, + { + "title": "Localizing Gutenberg Plugin", + "slug": "localizing", + "markdown_source": "../docs/contributors/localizing.md", + "parent": "contributors" + }, + { + "title": "Repository Management", + "slug": "repository-management", + "markdown_source": "../docs/contributors/repository-management.md", + "parent": "contributors" + }, + { + "title": "Folder Structure", + "slug": "folder-structure", + "markdown_source": "../docs/contributors/folder-structure.md", + "parent": "contributors" + }, + { + "title": "Versions in WordPress", + "slug": "versions-in-wordpress", + "markdown_source": "../docs/contributors/versions-in-wordpress.md", + "parent": "contributors" + }, + { + "title": "Upcoming Projects & Roadmap", + "slug": "roadmap", + "markdown_source": "../docs/contributors/roadmap.md", + "parent": "contributors" } ] \ No newline at end of file diff --git a/docs/toc.json b/docs/toc.json index 12217ff913c81..8dc2de711652a 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,169 +1,173 @@ [ - { "docs/README.md": [] }, - { "docs/designers-developers/developers/README.md": [ - { "docs/designers-developers/developers/full-site-editing-templates.md": [] }, - { "docs/designers-developers/developers/filters/README.md": [ - { "docs/designers-developers/developers/filters/block-filters.md": [] }, - { "docs/designers-developers/developers/filters/editor-filters.md": [] }, - { "docs/designers-developers/developers/filters/parser-filters.md": [] }, - { "docs/designers-developers/developers/filters/autocomplete-filters.md": [] } - ] }, - { "docs/designers-developers/developers/block-api/README.md": [ - { "docs/designers-developers/developers/block-api/block-registration.md": [] }, - { "docs/designers-developers/developers/block-api/block-edit-save.md": [] }, - { "docs/designers-developers/developers/block-api/block-attributes.md": [] }, - { "docs/designers-developers/developers/block-api/block-context.md": [] }, - { "docs/designers-developers/developers/block-api/block-deprecation.md": [] }, - { "docs/designers-developers/developers/block-api/block-supports.md": [] }, - { "docs/designers-developers/developers/block-api/block-transforms.md": [] }, - { "docs/designers-developers/developers/block-api/block-templates.md": [] }, - { "docs/designers-developers/developers/block-api/block-patterns.md": [] }, - { "docs/designers-developers/developers/block-api/block-annotations.md": [] }, - { "docs/designers-developers/developers/block-api/versions.md": [] } - ] }, - {"docs/designers-developers/developers/slotfills/README.md": [ - { "docs/designers-developers/developers/slotfills/main-dashboard-button.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-more-menu-item.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-post-status-info.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-sidebar.md": [] }, - { "docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/designers-developers/developers/richtext.md": [] }, - { "docs/designers-developers/developers/feature-flags.md": [] }, + { "docs/getting-started/README.md": [ + { "docs/getting-started/tutorials/README.md": [ + { "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] } + ] }, + { "docs/getting-started/architecture/README.md": [ + { "docs/getting-started/architecture/key-concepts.md": [] }, + { "docs/getting-started/architecture/data-flow.md": [] }, + { "docs/getting-started/architecture/modularity.md": [] }, + { "docs/getting-started/architecture/performance.md": [] }, + { "docs/getting-started/architecture/automated-testing.md": [] } + ] }, + { "docs/getting-started/glossary.md": [] }, + { "docs/getting-started/faq.md": [] }, + { "docs/getting-started/history.md": [] }, + { "docs/getting-started/outreach.md": [] } + ] }, + { "docs/howto-guides/README.md": [ + { "docs/howto-guides/javascript/README.md": [ + { "docs/howto-guides/javascript/plugins-background.md": [] }, + { "docs/howto-guides/javascript/loading-javascript.md": [] }, + { "docs/howto-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/howto-guides/javascript/troubleshooting.md": [] }, + { "docs/howto-guides/javascript/versions-and-building.md": [] }, + { "docs/howto-guides/javascript/scope-your-code.md": [] }, + { "docs/howto-guides/javascript/js-build-setup.md": [] }, + { "docs/howto-guides/javascript/esnext-js.md": [] } + ] }, + { "docs/howto-guides/metabox/README.md": [ + { "docs/howto-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/howto-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/howto-guides/metabox/meta-block-3-add.md": [] }, + { "docs/howto-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/howto-guides/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/howto-guides/notices/README.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/howto-guides/block-tutorial/README.md": [ + { "docs/howto-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/howto-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/howto-guides/feature-flags.md": [] }, + { "docs/howto-guides/themes/README.md": [ + { "docs/howto-guides/themes/theme-support.md": [] }, + { "docs/howto-guides/themes/theme-json.md": [] } + ] }, + { "docs/howto-guides/block-based-themes/README.md": [ + { "docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/howto-guides/backward-compatibility/README.md": [ + { "docs/howto-guides/backward-compatibility/deprecations.md": [] }, + { "docs/howto-guides/backward-compatibility/meta-box.md": [] } + ] }, - { "docs/designers-developers/developers/themes/README.md": [ - { "docs/designers-developers/developers/themes/theme-support.md": [] }, - { "docs/designers-developers/developers/themes/block-based-themes.md": [] }, - { "docs/designers-developers/developers/themes/theme-json.md": [] } - ] }, - { "docs/designers-developers/developers/accessibility.md": [] }, - { "docs/designers-developers/developers/internationalization.md": [] }, - { "docs/designers-developers/developers/tutorials/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/readme.md": [ - { "docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/javascript/readme.md": [ - { "docs/designers-developers/developers/tutorials/javascript/plugins-background.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/loading-javascript.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/troubleshooting.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/versions-and-building.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/scope-your-code.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/js-build-setup.md": [] }, - { "docs/designers-developers/developers/tutorials/javascript/esnext-js.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/create-block/readme.md": [ - { "docs/designers-developers/developers/tutorials/create-block/wp-plugin.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-anatomy.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/attributes.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/block-code.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/author-experience.md": [] }, - { "docs/designers-developers/developers/tutorials/create-block/finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/readme.md": [ - { "docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/metabox/readme.md": [ - { "docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md": [] }, - { "docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/notices/README.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/format-api/README.md": [ - { "docs/designers-developers/developers/tutorials/format-api/1-register-format.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md": [] }, - { "docs/designers-developers/developers/tutorials/format-api/3-apply-format.md": [] } - ] }, - { "docs/designers-developers/developers/tutorials/block-based-themes/README.md": [ - { "docs/designers-developers/developers/tutorials/block-based-themes/block-based-themes-2-adding-blocks.md": [] } - ] }, - { "docs/designers-developers/developers/platform/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/README.md": [ - { "docs/designers-developers/developers/platform/custom-block-editor/tutorial.md": [] } - ] } - ] } - ] } - ] }, - { "docs/designers-developers/designers/README.md": [ - { "docs/designers-developers/designers/block-design.md": [] }, - { "docs/designers-developers/designers/user-interface.md": [] }, - { "docs/designers-developers/designers/design-resources.md": [] }, - { "docs/designers-developers/designers/animation.md": [] } - ] }, - { "docs/contributors/readme.md": [ - { "docs/contributors/develop.md": [ - { "docs/contributors/getting-started.md": [] }, - { "docs/contributors/git-workflow.md": [] }, - { "docs/contributors/coding-guidelines.md": [] }, - { "docs/contributors/testing-overview.md": [] }, - { "docs/contributors/grammar.md": [] }, - { "docs/contributors/scripts.md": [] }, - { "docs/contributors/managing-packages.md": [] }, - { "docs/contributors/release.md": [] }, - { "docs/contributors/native-mobile.md": [] }, - { "docs/contributors/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design.md": [ - { "docs/contributors/the-block.md": [] }, - { "docs/contributors/reference.md": [] } - ] }, - { "docs/contributors/document.md": [ - { "docs/contributors/copy-guide.md": [] } + { "docs/howto-guides/format-api/README.md": [ + { "docs/howto-guides/format-api/1-register-format.md": [] }, + { "docs/howto-guides/format-api/2-toolbar-button.md": [] }, + { "docs/howto-guides/format-api/3-apply-format.md": [] } + ] }, + { "docs/howto-guides/platform/README.md": [ + { "docs/howto-guides/platform/custom-block-editor/README.md": [ + { "docs/howto-guides/platform/custom-block-editor/tutorial.md": [] } + ] } + ] }, + { "docs/howto-guides/designers/README.md": [ + { "docs/howto-guides/designers/block-design.md": [] }, + { "docs/howto-guides/designers/user-interface.md": [] }, + { "docs/howto-guides/designers/design-resources.md": [] }, + { "docs/howto-guides/designers/animation.md": [] } + ] }, + { "docs/howto-guides/accessibility.md": [] }, + { "docs/howto-guides/internationalization.md": [] } + ] }, + { "docs/reference-guides/README.md": [ + { "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] }, + { "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] }, + {"docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ]}, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": []}, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } + ] } + ] }, + { "docs/explanations/README.md": [ + { "docs/explanations/full-site-editing-templates.md": [] } + ] }, + { "docs/contributors/README.md": [ + { "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] }, + { "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } ] }, { "docs/contributors/triage.md": [] }, { "docs/contributors/localizing.md": [] }, - { "docs/contributors/repository-management.md": [] } - ] }, - { "docs/architecture/readme.md": [ - { "docs/architecture/key-concepts.md": [] }, - { "docs/architecture/data-flow.md": [] }, - { "docs/architecture/folder-structure.md": [] }, - { "docs/architecture/modularity.md": [] }, - { "docs/architecture/performance.md": [] }, - { "docs/architecture/automated-testing.md": [] } - ] }, - { "docs/appendix/readme.md": [ - { "packages/components/README.md": "{{components}}" }, - { "docs/appendix/packages.md": "{{packages}}" }, - { "docs/appendix/data/README.md": [ - { "docs/appendix/data/data-core.md": []}, - { "docs/appendix/data/data-core-annotations.md": [] }, - { "docs/appendix/data/data-core-blocks.md": [] }, - { "docs/appendix/data/data-core-block-editor.md": [] }, - { "docs/appendix/data/data-core-editor.md": [] }, - { "docs/appendix/data/data-core-edit-post.md": [] }, - { "docs/appendix/data/data-core-notices.md": [] }, - { "docs/appendix/data/data-core-nux.md": [] }, - { "docs/appendix/data/data-core-viewport.md": [] } - ] }, - { "docs/appendix/backward-compatibility/README.md": [ - { "docs/appendix/backward-compatibility/deprecations.md": [] }, - { "docs/appendix/backward-compatibility/meta-box.md": [] } - ] }, - { "docs/appendix/glossary.md": [] }, - { "docs/appendix/faq.md": [] }, - { "docs/appendix/versions-in-wordpress.md": [] }, - { "docs/appendix/history.md": [] }, - { "docs/appendix/outreach.md": [] } - ] } + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] } ] From 907a3caf66882e7bac647dac4744406c3d5ada3f Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 12:09:41 +0100 Subject: [PATCH 44/68] Update the folder structure of docs/ following toc.json --- docs/appendix/README.md | 10 - .../{ => code}/coding-guidelines.md | 0 docs/contributors/{ => code}/develop.md | 0 .../getting-started-native-mobile.md | 0 .../{ => code}/getting-started.md | 0 docs/contributors/{ => code}/git-workflow.md | 0 docs/contributors/{ => code}/grammar.md | 0 .../{ => code}/managing-packages.md | 0 docs/contributors/{ => code}/native-mobile.md | 0 docs/contributors/{ => code}/release.md | 0 docs/contributors/{ => code}/scripts.md | 0 .../{ => code}/testing-overview.md | 0 docs/contributors/{ => design}/design.md | 0 docs/contributors/{ => design}/reference.md | 0 docs/contributors/{ => design}/the-block.md | 0 .../{ => documentation}/copy-guide.md | 0 .../{ => documentation}/document.md | 0 .../folder-structure.md | 0 docs/{ => contributors}/roadmap.md | 0 .../versions-in-wordpress.md | 0 docs/explanations/README.md | 0 .../full-site-editing-templates.md | 0 docs/{readme.md => getting-started/README.md} | 0 .../architecture/README.md} | 0 .../architecture/automated-testing.md | 0 .../architecture/data-flow.md | 0 .../architecture/key-concepts.md | 0 .../architecture/modularity.md | 0 .../architecture/performance.md | 0 docs/{appendix => getting-started}/faq.md | 0 .../{appendix => getting-started}/glossary.md | 0 docs/{appendix => getting-started}/history.md | 0 .../{appendix => getting-started}/outreach.md | 0 .../tutorials/README.md} | 0 .../tutorials/create-block/README.md} | 0 .../tutorials/create-block/attributes.md | 0 .../create-block/author-experience.md | 0 .../tutorials/create-block/block-anatomy.md | 0 .../tutorials/create-block/block-code.md | 0 .../tutorials/create-block/finishing.md | 0 .../submitting-to-block-directory.md | 0 .../tutorials/create-block/wp-plugin.md | 0 .../tutorials/devenv/README.md} | 0 .../tutorials/devenv/docker-ubuntu.md | 0 .../developers => howto-guides}/README.md | 0 .../accessibility.md | 0 .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin .../assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../js-tutorial-console-log-success.png | Bin .../js-tutorial-error-blocks-undefined.png | Bin ...in-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin .../assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin .../backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../backward-compatibility/meta-box.md | 0 docs/howto-guides/block-based-theme/README.md | 380 ++++++++++++++++++ .../block-based-themes-2-adding-blocks.md | 55 +++ .../block-tutorial/README.md} | 0 .../applying-styles-with-stylesheets.md | 0 .../block-controls-toolbar-and-sidebar.md | 0 .../block-tutorial/creating-dynamic-blocks.md | 0 .../generate-blocks-with-wp-cli.md | 0 ...roducing-attributes-and-editable-fields.md | 0 .../nested-blocks-inner-blocks.md | 0 .../writing-your-first-block-type.md | 0 .../designers/README.md | 0 .../designers/animation.md | 0 .../designers/assets/advanced-settings-do.png | Bin .../designers/assets/block-controls-do.png | Bin .../designers/assets/block-controls-dont.png | Bin .../assets/block-descriptions-do.png | Bin .../assets/block-descriptions-dont.png | Bin .../designers/assets/blocks-do.png | Bin .../designers/assets/blocks-dont.png | Bin .../designers/assets/placeholder-do.png | Bin .../designers/assets/placeholder-dont.png | Bin .../designers/block-design.md | 0 .../designers/design-resources.md | 0 .../designers/user-interface.md | 0 .../feature-flags.md | 0 .../format-api/1-register-format.md | 0 .../format-api/2-toolbar-button.md | 0 .../format-api/3-apply-format.md | 0 .../format-api/README.md | 0 .../internationalization.md | 0 .../javascript/README.md} | 0 .../javascript/esnext-js.md | 0 .../javascript/extending-the-block-editor.md | 0 .../javascript/js-build-setup.md | 0 .../javascript/loading-javascript.md | 0 .../javascript/plugins-background.md | 0 .../javascript/scope-your-code.md | 0 .../javascript/troubleshooting.md | 0 .../javascript/versions-and-building.md | 0 .../metabox/README.md} | 0 .../metabox/meta-block-1-intro.md | 0 .../metabox/meta-block-2-register-meta.md | 0 .../metabox/meta-block-3-add.md | 0 .../metabox/meta-block-4-use-data.md | 0 .../metabox/meta-block-5-finishing.md | 0 .../metabox/meta-block.png | Bin .../notices/README.md | 0 .../notices/block-editor-notice.png | Bin .../notices/classic-editor-notice.png | Bin .../platform/README.md | 0 .../platform/custom-block-editor/README.md | 0 .../platform/custom-block-editor/tutorial.md | 0 .../sidebar-tutorial/plugin-sidebar-0.md | 0 .../plugin-sidebar-1-up-and-running.md | 0 .../plugin-sidebar-2-styles-and-controls.md | 0 .../plugin-sidebar-3-register-meta.md | 0 .../plugin-sidebar-4-initialize-input.md | 0 .../plugin-sidebar-5-update-meta.md | 0 .../plugin-sidebar-6-finishing-touches.md | 0 .../themes/README.md | 0 .../themes/block-based-themes.md | 0 .../themes/theme-json.md | 0 .../themes/theme-support.md | 0 docs/reference-guides/README.md | 0 .../block-api/README.md | 0 .../block-api/block-annotations.md | 0 .../block-api/block-attributes.md | 0 .../block-api/block-context.md | 0 .../block-api/block-deprecation.md | 0 .../block-api/block-edit-save.md | 0 .../block-api/block-metadata.md | 0 .../block-api/block-patterns.md | 0 .../block-api/block-registration.md | 0 .../block-api/block-supports.md | 0 .../block-api/block-templates.md | 0 .../block-api/block-transforms.md | 0 .../block-api/versions.md | 0 .../data/README.md | 0 .../data/data-core-annotations.md | 0 .../data/data-core-block-editor.md | 0 .../data/data-core-blocks.md | 0 .../data/data-core-edit-post.md | 0 .../data/data-core-editor.md | 0 .../data/data-core-keyboard-shortcuts.md | 0 .../data/data-core-notices.md | 0 .../data/data-core-nux.md | 0 .../data/data-core-viewport.md | 0 .../data/data-core.md | 0 .../filters/README.md | 0 .../filters/autocomplete-filters.md | 0 .../filters/block-filters.md | 0 .../filters/editor-filters.md | 0 .../filters/i18n-filters.md | 0 .../filters/parser-filters.md | 0 .../packages.md | 0 .../richtext.md | 0 .../slotfills/README.md | 0 .../slotfills/main-dashboard-button.md | 0 .../plugin-block-settings-menu-item.md | 0 .../plugin-document-setting-panel.md | 0 .../slotfills/plugin-more-menu-item.md | 0 .../slotfills/plugin-post-publish-panel.md | 0 .../slotfills/plugin-post-status-info.md | 0 .../slotfills/plugin-pre-publish-panel.md | 0 .../plugin-sidebar-more-menu-item.md | 0 .../slotfills/plugin-sidebar.md | 0 173 files changed, 435 insertions(+), 10 deletions(-) delete mode 100644 docs/appendix/README.md rename docs/contributors/{ => code}/coding-guidelines.md (100%) rename docs/contributors/{ => code}/develop.md (100%) rename docs/contributors/{ => code}/getting-started-native-mobile.md (100%) rename docs/contributors/{ => code}/getting-started.md (100%) rename docs/contributors/{ => code}/git-workflow.md (100%) rename docs/contributors/{ => code}/grammar.md (100%) rename docs/contributors/{ => code}/managing-packages.md (100%) rename docs/contributors/{ => code}/native-mobile.md (100%) rename docs/contributors/{ => code}/release.md (100%) rename docs/contributors/{ => code}/scripts.md (100%) rename docs/contributors/{ => code}/testing-overview.md (100%) rename docs/contributors/{ => design}/design.md (100%) rename docs/contributors/{ => design}/reference.md (100%) rename docs/contributors/{ => design}/the-block.md (100%) rename docs/contributors/{ => documentation}/copy-guide.md (100%) rename docs/contributors/{ => documentation}/document.md (100%) rename docs/{architecture => contributors}/folder-structure.md (100%) rename docs/{ => contributors}/roadmap.md (100%) rename docs/{appendix => contributors}/versions-in-wordpress.md (100%) create mode 100644 docs/explanations/README.md rename docs/{designers-developers/developers => explanations}/full-site-editing-templates.md (100%) rename docs/{readme.md => getting-started/README.md} (100%) rename docs/{architecture/readme.md => getting-started/architecture/README.md} (100%) rename docs/{ => getting-started}/architecture/automated-testing.md (100%) rename docs/{ => getting-started}/architecture/data-flow.md (100%) rename docs/{ => getting-started}/architecture/key-concepts.md (100%) rename docs/{ => getting-started}/architecture/modularity.md (100%) rename docs/{ => getting-started}/architecture/performance.md (100%) rename docs/{appendix => getting-started}/faq.md (100%) rename docs/{appendix => getting-started}/glossary.md (100%) rename docs/{appendix => getting-started}/history.md (100%) rename docs/{appendix => getting-started}/outreach.md (100%) rename docs/{designers-developers/developers/tutorials/readme.md => getting-started/tutorials/README.md} (100%) rename docs/{designers-developers/developers/tutorials/create-block/readme.md => getting-started/tutorials/create-block/README.md} (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/attributes.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/author-experience.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/block-anatomy.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/block-code.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/finishing.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/submitting-to-block-directory.md (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/create-block/wp-plugin.md (100%) rename docs/{designers-developers/developers/tutorials/devenv/readme.md => getting-started/tutorials/devenv/README.md} (100%) rename docs/{designers-developers/developers => getting-started}/tutorials/devenv/docker-ubuntu.md (100%) rename docs/{designers-developers/developers => howto-guides}/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/accessibility.md (100%) rename docs/{designers-developers => howto-guides}/assets/fancy-quote-in-inspector.png (100%) rename docs/{designers-developers => howto-guides}/assets/fancy-quote-with-style.png (100%) rename docs/{designers-developers => howto-guides}/assets/inspector.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-console-log-error.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-console-log-success.png (100%) rename docs/{designers-developers => howto-guides}/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-more-menu-item.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-post-publish-panel.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-post-status-info-location.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-pre-publish-panel.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-closed-state.png (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{designers-developers => howto-guides}/assets/plugin-sidebar-open-state.png (100%) rename docs/{designers-developers => howto-guides}/assets/sidebar-style-and-controls.png (100%) rename docs/{designers-developers => howto-guides}/assets/sidebar-up-and-running.png (100%) rename docs/{designers-developers => howto-guides}/assets/toolbar-text.png (100%) rename docs/{designers-developers => howto-guides}/assets/toolbar-with-custom-button.png (100%) rename docs/{appendix => howto-guides}/backward-compatibility/README.md (100%) rename docs/{appendix => howto-guides}/backward-compatibility/deprecations.md (100%) rename docs/{appendix => howto-guides}/backward-compatibility/meta-box.md (100%) create mode 100644 docs/howto-guides/block-based-theme/README.md create mode 100644 docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md rename docs/{designers-developers/developers/tutorials/block-tutorial/readme.md => howto-guides/block-tutorial/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/applying-styles-with-stylesheets.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/block-controls-toolbar-and-sidebar.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/creating-dynamic-blocks.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/generate-blocks-with-wp-cli.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/introducing-attributes-and-editable-fields.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/nested-blocks-inner-blocks.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/block-tutorial/writing-your-first-block-type.md (100%) rename docs/{designers-developers => howto-guides}/designers/README.md (100%) rename docs/{designers-developers => howto-guides}/designers/animation.md (100%) rename docs/{designers-developers => howto-guides}/designers/assets/advanced-settings-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-controls-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-controls-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-descriptions-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/block-descriptions-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/blocks-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/blocks-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/placeholder-do.png (100%) rename docs/{designers-developers => howto-guides}/designers/assets/placeholder-dont.png (100%) rename docs/{designers-developers => howto-guides}/designers/block-design.md (100%) rename docs/{designers-developers => howto-guides}/designers/design-resources.md (100%) rename docs/{designers-developers => howto-guides}/designers/user-interface.md (100%) rename docs/{designers-developers/developers => howto-guides}/feature-flags.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/1-register-format.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/2-toolbar-button.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/3-apply-format.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/format-api/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/internationalization.md (100%) rename docs/{designers-developers/developers/tutorials/javascript/readme.md => howto-guides/javascript/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/esnext-js.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/extending-the-block-editor.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/js-build-setup.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/loading-javascript.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/plugins-background.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/scope-your-code.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/troubleshooting.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/javascript/versions-and-building.md (100%) rename docs/{designers-developers/developers/tutorials/metabox/readme.md => howto-guides/metabox/README.md} (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-1-intro.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-2-register-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-3-add.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-4-use-data.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block-5-finishing.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/metabox/meta-block.png (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/README.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/block-editor-notice.png (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/notices/classic-editor-notice.png (100%) rename docs/{designers-developers/developers => howto-guides}/platform/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/platform/custom-block-editor/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/platform/custom-block-editor/tutorial.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-0.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-1-up-and-running.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-3-register-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-4-initialize-input.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-5-update-meta.md (100%) rename docs/{designers-developers/developers/tutorials => howto-guides}/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/README.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/block-based-themes.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/theme-json.md (100%) rename docs/{designers-developers/developers => howto-guides}/themes/theme-support.md (100%) create mode 100644 docs/reference-guides/README.md rename docs/{designers-developers/developers => reference-guides}/block-api/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-annotations.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-attributes.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-context.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-deprecation.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-edit-save.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-metadata.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-patterns.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-registration.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-supports.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-templates.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/block-transforms.md (100%) rename docs/{designers-developers/developers => reference-guides}/block-api/versions.md (100%) rename docs/{appendix => reference-guides}/data/README.md (100%) rename docs/{appendix => reference-guides}/data/data-core-annotations.md (100%) rename docs/{appendix => reference-guides}/data/data-core-block-editor.md (100%) rename docs/{appendix => reference-guides}/data/data-core-blocks.md (100%) rename docs/{appendix => reference-guides}/data/data-core-edit-post.md (100%) rename docs/{appendix => reference-guides}/data/data-core-editor.md (100%) rename docs/{appendix => reference-guides}/data/data-core-keyboard-shortcuts.md (100%) rename docs/{appendix => reference-guides}/data/data-core-notices.md (100%) rename docs/{appendix => reference-guides}/data/data-core-nux.md (100%) rename docs/{appendix => reference-guides}/data/data-core-viewport.md (100%) rename docs/{appendix => reference-guides}/data/data-core.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/autocomplete-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/block-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/editor-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/i18n-filters.md (100%) rename docs/{designers-developers/developers => reference-guides}/filters/parser-filters.md (100%) rename docs/{appendix => reference-guides}/packages.md (100%) rename docs/{designers-developers/developers => reference-guides}/richtext.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/README.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/main-dashboard-button.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-block-settings-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-document-setting-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-more-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-post-publish-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-post-status-info.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-pre-publish-panel.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-sidebar-more-menu-item.md (100%) rename docs/{designers-developers/developers => reference-guides}/slotfills/plugin-sidebar.md (100%) diff --git a/docs/appendix/README.md b/docs/appendix/README.md deleted file mode 100644 index e52bc7073548d..0000000000000 --- a/docs/appendix/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# Appendix - -- [Package Reference](/docs/appendix/packages.md) -- [Data Module Reference](/docs/appendix/data/README.md) -- [Backward Compatibility](/docs/appendix/backward-compatibility/README.md) -- [Glossary](/docs/appendix/glossary.md) -- [Frequently Asked Questions](/docs/appendix/faq.md) -- [Versions in WordPress](/docs/appendix/versions-in-wordpress.md) -- [History](/docs/appendix/history.md) -- [Outreach](/docs/appendix/outreach) \ No newline at end of file diff --git a/docs/contributors/coding-guidelines.md b/docs/contributors/code/coding-guidelines.md similarity index 100% rename from docs/contributors/coding-guidelines.md rename to docs/contributors/code/coding-guidelines.md diff --git a/docs/contributors/develop.md b/docs/contributors/code/develop.md similarity index 100% rename from docs/contributors/develop.md rename to docs/contributors/code/develop.md diff --git a/docs/contributors/getting-started-native-mobile.md b/docs/contributors/code/getting-started-native-mobile.md similarity index 100% rename from docs/contributors/getting-started-native-mobile.md rename to docs/contributors/code/getting-started-native-mobile.md diff --git a/docs/contributors/getting-started.md b/docs/contributors/code/getting-started.md similarity index 100% rename from docs/contributors/getting-started.md rename to docs/contributors/code/getting-started.md diff --git a/docs/contributors/git-workflow.md b/docs/contributors/code/git-workflow.md similarity index 100% rename from docs/contributors/git-workflow.md rename to docs/contributors/code/git-workflow.md diff --git a/docs/contributors/grammar.md b/docs/contributors/code/grammar.md similarity index 100% rename from docs/contributors/grammar.md rename to docs/contributors/code/grammar.md diff --git a/docs/contributors/managing-packages.md b/docs/contributors/code/managing-packages.md similarity index 100% rename from docs/contributors/managing-packages.md rename to docs/contributors/code/managing-packages.md diff --git a/docs/contributors/native-mobile.md b/docs/contributors/code/native-mobile.md similarity index 100% rename from docs/contributors/native-mobile.md rename to docs/contributors/code/native-mobile.md diff --git a/docs/contributors/release.md b/docs/contributors/code/release.md similarity index 100% rename from docs/contributors/release.md rename to docs/contributors/code/release.md diff --git a/docs/contributors/scripts.md b/docs/contributors/code/scripts.md similarity index 100% rename from docs/contributors/scripts.md rename to docs/contributors/code/scripts.md diff --git a/docs/contributors/testing-overview.md b/docs/contributors/code/testing-overview.md similarity index 100% rename from docs/contributors/testing-overview.md rename to docs/contributors/code/testing-overview.md diff --git a/docs/contributors/design.md b/docs/contributors/design/design.md similarity index 100% rename from docs/contributors/design.md rename to docs/contributors/design/design.md diff --git a/docs/contributors/reference.md b/docs/contributors/design/reference.md similarity index 100% rename from docs/contributors/reference.md rename to docs/contributors/design/reference.md diff --git a/docs/contributors/the-block.md b/docs/contributors/design/the-block.md similarity index 100% rename from docs/contributors/the-block.md rename to docs/contributors/design/the-block.md diff --git a/docs/contributors/copy-guide.md b/docs/contributors/documentation/copy-guide.md similarity index 100% rename from docs/contributors/copy-guide.md rename to docs/contributors/documentation/copy-guide.md diff --git a/docs/contributors/document.md b/docs/contributors/documentation/document.md similarity index 100% rename from docs/contributors/document.md rename to docs/contributors/documentation/document.md diff --git a/docs/architecture/folder-structure.md b/docs/contributors/folder-structure.md similarity index 100% rename from docs/architecture/folder-structure.md rename to docs/contributors/folder-structure.md diff --git a/docs/roadmap.md b/docs/contributors/roadmap.md similarity index 100% rename from docs/roadmap.md rename to docs/contributors/roadmap.md diff --git a/docs/appendix/versions-in-wordpress.md b/docs/contributors/versions-in-wordpress.md similarity index 100% rename from docs/appendix/versions-in-wordpress.md rename to docs/contributors/versions-in-wordpress.md diff --git a/docs/explanations/README.md b/docs/explanations/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/full-site-editing-templates.md b/docs/explanations/full-site-editing-templates.md similarity index 100% rename from docs/designers-developers/developers/full-site-editing-templates.md rename to docs/explanations/full-site-editing-templates.md diff --git a/docs/readme.md b/docs/getting-started/README.md similarity index 100% rename from docs/readme.md rename to docs/getting-started/README.md diff --git a/docs/architecture/readme.md b/docs/getting-started/architecture/README.md similarity index 100% rename from docs/architecture/readme.md rename to docs/getting-started/architecture/README.md diff --git a/docs/architecture/automated-testing.md b/docs/getting-started/architecture/automated-testing.md similarity index 100% rename from docs/architecture/automated-testing.md rename to docs/getting-started/architecture/automated-testing.md diff --git a/docs/architecture/data-flow.md b/docs/getting-started/architecture/data-flow.md similarity index 100% rename from docs/architecture/data-flow.md rename to docs/getting-started/architecture/data-flow.md diff --git a/docs/architecture/key-concepts.md b/docs/getting-started/architecture/key-concepts.md similarity index 100% rename from docs/architecture/key-concepts.md rename to docs/getting-started/architecture/key-concepts.md diff --git a/docs/architecture/modularity.md b/docs/getting-started/architecture/modularity.md similarity index 100% rename from docs/architecture/modularity.md rename to docs/getting-started/architecture/modularity.md diff --git a/docs/architecture/performance.md b/docs/getting-started/architecture/performance.md similarity index 100% rename from docs/architecture/performance.md rename to docs/getting-started/architecture/performance.md diff --git a/docs/appendix/faq.md b/docs/getting-started/faq.md similarity index 100% rename from docs/appendix/faq.md rename to docs/getting-started/faq.md diff --git a/docs/appendix/glossary.md b/docs/getting-started/glossary.md similarity index 100% rename from docs/appendix/glossary.md rename to docs/getting-started/glossary.md diff --git a/docs/appendix/history.md b/docs/getting-started/history.md similarity index 100% rename from docs/appendix/history.md rename to docs/getting-started/history.md diff --git a/docs/appendix/outreach.md b/docs/getting-started/outreach.md similarity index 100% rename from docs/appendix/outreach.md rename to docs/getting-started/outreach.md diff --git a/docs/designers-developers/developers/tutorials/readme.md b/docs/getting-started/tutorials/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/readme.md rename to docs/getting-started/tutorials/README.md diff --git a/docs/designers-developers/developers/tutorials/create-block/readme.md b/docs/getting-started/tutorials/create-block/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/readme.md rename to docs/getting-started/tutorials/create-block/README.md diff --git a/docs/designers-developers/developers/tutorials/create-block/attributes.md b/docs/getting-started/tutorials/create-block/attributes.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/attributes.md rename to docs/getting-started/tutorials/create-block/attributes.md diff --git a/docs/designers-developers/developers/tutorials/create-block/author-experience.md b/docs/getting-started/tutorials/create-block/author-experience.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/author-experience.md rename to docs/getting-started/tutorials/create-block/author-experience.md diff --git a/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/block-anatomy.md rename to docs/getting-started/tutorials/create-block/block-anatomy.md diff --git a/docs/designers-developers/developers/tutorials/create-block/block-code.md b/docs/getting-started/tutorials/create-block/block-code.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/block-code.md rename to docs/getting-started/tutorials/create-block/block-code.md diff --git a/docs/designers-developers/developers/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/finishing.md rename to docs/getting-started/tutorials/create-block/finishing.md diff --git a/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md rename to docs/getting-started/tutorials/create-block/submitting-to-block-directory.md diff --git a/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md similarity index 100% rename from docs/designers-developers/developers/tutorials/create-block/wp-plugin.md rename to docs/getting-started/tutorials/create-block/wp-plugin.md diff --git a/docs/designers-developers/developers/tutorials/devenv/readme.md b/docs/getting-started/tutorials/devenv/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/devenv/readme.md rename to docs/getting-started/tutorials/devenv/README.md diff --git a/docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md b/docs/getting-started/tutorials/devenv/docker-ubuntu.md similarity index 100% rename from docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md rename to docs/getting-started/tutorials/devenv/docker-ubuntu.md diff --git a/docs/designers-developers/developers/README.md b/docs/howto-guides/README.md similarity index 100% rename from docs/designers-developers/developers/README.md rename to docs/howto-guides/README.md diff --git a/docs/designers-developers/developers/accessibility.md b/docs/howto-guides/accessibility.md similarity index 100% rename from docs/designers-developers/developers/accessibility.md rename to docs/howto-guides/accessibility.md diff --git a/docs/designers-developers/assets/fancy-quote-in-inspector.png b/docs/howto-guides/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/designers-developers/assets/fancy-quote-in-inspector.png rename to docs/howto-guides/assets/fancy-quote-in-inspector.png diff --git a/docs/designers-developers/assets/fancy-quote-with-style.png b/docs/howto-guides/assets/fancy-quote-with-style.png similarity index 100% rename from docs/designers-developers/assets/fancy-quote-with-style.png rename to docs/howto-guides/assets/fancy-quote-with-style.png diff --git a/docs/designers-developers/assets/inspector.png b/docs/howto-guides/assets/inspector.png similarity index 100% rename from docs/designers-developers/assets/inspector.png rename to docs/howto-guides/assets/inspector.png diff --git a/docs/designers-developers/assets/js-tutorial-console-log-error.png b/docs/howto-guides/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-console-log-error.png rename to docs/howto-guides/assets/js-tutorial-console-log-error.png diff --git a/docs/designers-developers/assets/js-tutorial-console-log-success.png b/docs/howto-guides/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-console-log-success.png rename to docs/howto-guides/assets/js-tutorial-console-log-success.png diff --git a/docs/designers-developers/assets/js-tutorial-error-blocks-undefined.png b/docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/designers-developers/assets/js-tutorial-error-blocks-undefined.png rename to docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png b/docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/designers-developers/assets/plugin-more-menu-item.png b/docs/howto-guides/assets/plugin-more-menu-item.png similarity index 100% rename from docs/designers-developers/assets/plugin-more-menu-item.png rename to docs/howto-guides/assets/plugin-more-menu-item.png diff --git a/docs/designers-developers/assets/plugin-post-publish-panel.png b/docs/howto-guides/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/designers-developers/assets/plugin-post-publish-panel.png rename to docs/howto-guides/assets/plugin-post-publish-panel.png diff --git a/docs/designers-developers/assets/plugin-post-status-info-location.png b/docs/howto-guides/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/designers-developers/assets/plugin-post-status-info-location.png rename to docs/howto-guides/assets/plugin-post-status-info-location.png diff --git a/docs/designers-developers/assets/plugin-pre-publish-panel.png b/docs/howto-guides/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/designers-developers/assets/plugin-pre-publish-panel.png rename to docs/howto-guides/assets/plugin-pre-publish-panel.png diff --git a/docs/designers-developers/assets/plugin-sidebar-closed-state.png b/docs/howto-guides/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-closed-state.png rename to docs/howto-guides/assets/plugin-sidebar-closed-state.png diff --git a/docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif b/docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif rename to docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/designers-developers/assets/plugin-sidebar-open-state.png b/docs/howto-guides/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/designers-developers/assets/plugin-sidebar-open-state.png rename to docs/howto-guides/assets/plugin-sidebar-open-state.png diff --git a/docs/designers-developers/assets/sidebar-style-and-controls.png b/docs/howto-guides/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/designers-developers/assets/sidebar-style-and-controls.png rename to docs/howto-guides/assets/sidebar-style-and-controls.png diff --git a/docs/designers-developers/assets/sidebar-up-and-running.png b/docs/howto-guides/assets/sidebar-up-and-running.png similarity index 100% rename from docs/designers-developers/assets/sidebar-up-and-running.png rename to docs/howto-guides/assets/sidebar-up-and-running.png diff --git a/docs/designers-developers/assets/toolbar-text.png b/docs/howto-guides/assets/toolbar-text.png similarity index 100% rename from docs/designers-developers/assets/toolbar-text.png rename to docs/howto-guides/assets/toolbar-text.png diff --git a/docs/designers-developers/assets/toolbar-with-custom-button.png b/docs/howto-guides/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/designers-developers/assets/toolbar-with-custom-button.png rename to docs/howto-guides/assets/toolbar-with-custom-button.png diff --git a/docs/appendix/backward-compatibility/README.md b/docs/howto-guides/backward-compatibility/README.md similarity index 100% rename from docs/appendix/backward-compatibility/README.md rename to docs/howto-guides/backward-compatibility/README.md diff --git a/docs/appendix/backward-compatibility/deprecations.md b/docs/howto-guides/backward-compatibility/deprecations.md similarity index 100% rename from docs/appendix/backward-compatibility/deprecations.md rename to docs/howto-guides/backward-compatibility/deprecations.md diff --git a/docs/appendix/backward-compatibility/meta-box.md b/docs/howto-guides/backward-compatibility/meta-box.md similarity index 100% rename from docs/appendix/backward-compatibility/meta-box.md rename to docs/howto-guides/backward-compatibility/meta-box.md diff --git a/docs/howto-guides/block-based-theme/README.md b/docs/howto-guides/block-based-theme/README.md new file mode 100644 index 0000000000000..2e0c8402d3761 --- /dev/null +++ b/docs/howto-guides/block-based-theme/README.md @@ -0,0 +1,380 @@ +# Creating a block-based theme + +The purpose of this tutorial is to show how to create a basic block based theme +and help theme developers transition to full site editing. + +You will learn about the required files, how to combine templates and template parts, +how to add presets for global styles, and how to add blocks and export the templates in the site editor. + +Full site editing is an experimental feature and the workflow in this tutorial is likely to change. + +This tutorial is up to date as of Gutenberg version 9.1. + +## Table of Contents + + 1. [What is needed to create a block-based theme?](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) + +## What is needed to create a block-based theme? + +To use a block based theme you need to have Gutenberg installed and full site editing must be enabled. + +Full site editing can be enabled from the Gutenberg experiments menu in the WordPress admin area. + +A block-based theme is built using HTML templates and template parts. Templates are the main files used in the [template hierarchy](https://developer.wordpress.org/themes/basics/template-hierarchy/), for example index, single or archive. Templates can optionally include structural template parts, for example a header, footer or sidebar. + +Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. The block HTML is generated in and exported from the **site editor**. It can also be added to the theme's HTML files manually. + +### Required files and file structure + +A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. + +The theme may optionally include an [experimental-theme.json file](/docs/designers-developers/developers/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. + +Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: + +``` +theme +|__ style.css +|__ functions.php +|__ index.php +|__ experimental-theme.json +|__ block-templates + |__ index.html + |__ single.html + |__ archive.html + |__ ... +|__ block-template-parts + |__ header.html + |__ footer.html + |__ sidebar.html + |__ ... +``` + +## Creating the theme + +Create a new folder for your theme in `/wp-content/themes/`. +Inside this folder, create the `block-templates` and `block-template-parts` folders. + +Create a `style.css` file. The file header in the `style.css` file has [the same items that you would use in a traditional theme](https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/#explanations). + +``` +/* +Theme Name: My first theme +Theme URI: +Author: The WordPress team +Author URI: https://wordpress.org/ +Description: +Tags: +Version: 1.0.0 +Requires at least: 5.0 +Tested up to: 5.4 +Requires PHP: 7.0 +License: GNU General Public License v2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html +Text Domain: myfirsttheme + +This theme, like WordPress, is licensed under the GPL. +Use it to make something cool, have fun, and share what you've learned with others. +*/ +``` + +Create a `functions.php` file. + +In this file, you will enqueue the `style.css` file and add any theme support that you want to use. For example colors, wide blocks and featured images. + +_You no longer need to add theme support for the title tag. It is already enabled with full site editing._ + +https://developer.wordpress.org/themes/basics/theme-functions/#what-is-functions-php + +https://developer.wordpress.org/block-editor/developers/themes/theme-support/ + +```php +. + */ + add_theme_support( 'automatic-feed-links' ); + + /** + * Enable support for post thumbnails and featured images. + */ + add_theme_support( 'post-thumbnails' ); + + add_theme_support( 'editor-color-palette', array( + array( + 'name' => __( 'strong magenta', 'myfirsttheme' ), + 'slug' => 'strong-magenta', + 'color' => '#a156b4', + ), + array( + 'name' => __( 'very dark gray', 'myfirsttheme' ), + 'slug' => 'very-dark-gray', + 'color' => '#444', + ), + ) ); + + add_theme_support( 'wp-block-styles' ); + + add_theme_support( 'align-wide' ); +} +endif; // myfirsttheme_setup +add_action( 'after_setup_theme', 'myfirsttheme_setup' ); + +/** + * Enqueue theme scripts and styles. + */ +function myfirsttheme_scripts() { + wp_enqueue_style( 'myfirsttheme-style', get_stylesheet_uri() ); + + if ( is_singular() && comments_open() && get_option( 'thread_comments' ) ) { + wp_enqueue_script( 'comment-reply' ); + } +} +add_action( 'wp_enqueue_scripts', 'myfirsttheme_scripts' ); +``` + +Create an `index.php` file. +This file is used as a fallback if the theme is activated when full site editing is not enabled. +You may leave the file empty for this tutorial. + +Your theme should now include the following files and folders: + +``` +theme + |__ style.css + |__ functions.php + |__ index.php + |__ block-templates + |__ (empty folder) + |__ block-template-parts + |__ (empty folder) +``` + +### Creating the templates and template parts + +Create two template parts called `footer.html` and `header.html` and place them inside the `block-template-parts` folder. You can leave the files empty for now. + +Inside the block-templates folder, create an `index.html` file. + +In `index.html`, include the template parts by adding two HTML comments. + +The HTML comments starts with `wp:template-part` which is the name of the template-part block type. Inside the curly brackets are two keys and their values: The slug of the template part, and the theme name. + +``` + + + +``` + +If you used a different theme name, adjust the value for the theme key. + +Eventually, you will be able to create and combine templates and template parts directly in the site editor. + +### Experimental-theme.json - Global styles + +The purpose of the `experimental-theme.json` file is to make it easier to style blocks by setting defaults. + +It is used to: + * Create CSS variables (also called CSS custom properties) that can be used to style blocks both on the front and in the editor. + * Set global styles. + * Set styles for individual block types. + +[The documentation for global styles contains a list of available block and style combinations.](https://developer.wordpress.org/block-editor/developers/themes/theme-json/) + +Create a file called `experimental-theme.json` and save it inside the main folder. + +CSS variables are generated using **Global presets**. The variables are added to the `:root` on the front, and to the `.editor-styles-wrapper` class in the editor. + +Styles that are added to the themes `style.css` file or an editor style sheet are loaded after global styles. + +Add the following global presets to the `experimental-theme.json` file: + +``` +{ + "global": { + "settings": { + "color": { + "palette": [ + { + "slug": "strong-magenta", + "color": "#a156b4" + }, + { + "slug": "very-dark-gray", + "color": "#444" + }, + ] + }, + "custom": { + "line-height": [ + { + "small": "1.3" + }, + { + "medium": "2" + }, + { + "large": "2.5" + } + ] + } + } + } +} +``` + +This code generates the following variables: +``` + --wp--preset--color--strong-magenta: #a156b4; + --wp--preset--color--very-dark-gray: #444; + + --wp--custom--line-height--small: 1.3; + --wp--custom--line-height--medium: 2; + --wp--custom--line-height--large: 2.5; +``` + +**Global styles** are used to set default values for the website and for the blocks. + +This example will add the dark grey color as the website background color. +Add the code inside the globals, after the presets: +``` + "styles": { + "color": { + "background": "var(--wp--preset--color--very-dark-gray)" + } + } +``` + +**Block styles** sets default values for all blocks of a specific type. + +This example uses the CSS variables to add text color and line height to the H2 heading block, +in combination with a custom font size. + +When adding styles for the headings block, include the heading level, h1 to h6. + +Block styles are separate from global styles. Add the code after the globals, but before the closing brace. + +``` +"core/heading/h2": { + "styles": { + "color": { + "text": "var( --wp--preset--color--strong-magenta )" + }, + "typography": { + "fontSize": "2.5rem", + "lineHeight": "var(--wp--custom--line-height--medium)" + } + } +}, +``` + +CSS variables for font sizes are generated using the `editor-font-sizes` theme support or by adding a global preset. + +https://developer.wordpress.org/block-editor/developers/themes/theme-support/#block-font-sizes + +If the theme does not add any custom font sizes, variables are created using the default sizes. +This example adds the default medium font size to the paragraph block. + +The font sizes are unitless, which is why calc is used: https://developer.mozilla.org/en-US/docs/Web/CSS/calc + +``` +"core/paragraph": { + "styles": { + "typography": { + "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" + } + } +}, +``` + +Using the CSS variables is optional. In this example, the default background color for the group block is changed to white using a color code: + +``` +"core/group": { + "styles": { + "color": { + "background": "#ffffff" + } + } +} +``` + +Below are the presets and styles combined: + +``` +{ + "global": { + "settings": { + "color": { + "palette": [ + { + "slug": "strong-magenta", + "color": "#a156b4" + }, + { + "slug": "very-dark-gray", + "color": "#444" + }, + ] + }, + "custom": { + "line-height": [ + { + "small": "1.3" + }, + { + "medium": "2" + }, + { + "large": "2.5" + } + ] + } + } + }, + + "core/heading/h2": { + "styles": { + "color": { + "text": "var( --wp--preset--color--strong-magenta )" + }, + "typography": { + "fontSize": "2.5rem", + "lineHeight": "var(--wp--custom--line-height--medium)" + } + } + }, + + "core/paragraph": { + "styles": { + "typography": { + "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" + } + } + }, + + "core/group": { + "styles": { + "color": { + "background": "#ffffff" + } + } + } +} +``` + +## [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) diff --git a/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md b/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md new file mode 100644 index 0000000000000..c1e5a2d6a4658 --- /dev/null +++ b/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md @@ -0,0 +1,55 @@ +# Adding blocks to your theme + +Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. + +There is more than one way to add blocks to the theme files: + +- Adding and editing blocks in the site editor and exporting the theme. +- Adding block HTML and comments to the HTML files manually. + +## Working with blocks and templates in the site editor + +The beta site editor is available from the WordPress admin area when full site editing is enabled. To use the site editor, a full site editing theme must be installed and active. + +The site editor is similar to the block editor, but is used for the site layout instead of the post and page content. + +Two new menus have been added to the top toolbar of the editor: + +One that shows a list of posts, pages and categories, and indicates the item that is used as the front page. + +![Site editor toolbar page menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-page-menu.png) + +And a list of templates and template parts, that indicates the item that is being edited. Hovering over the parts will show a preview. + +![Site editor toolbar template menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-template-menu.png) + +Template parts can be selected and edited directly in the site editor, like other blocks: + +![A selected template part is highlighted. When selected, the template part has a limited set of alignment controls in the block toolbar](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-editor-template-part.png) + +Select the header template part in the menu to view and edit it individually. Add the blocks that you would like in your header, for example a site title block, a navigation block, and an image. + +Next, select the footer template part and add some content, for example widget blocks. + +Select the index template again to view the template parts together in the page context. + +To add a post loop to the index template, add a **query** block. The query block includes the query loop and the query pagination. The default loop displays the post title and post content. The query loop and query pagination are also available as individual blocks. + + +## Saving templates and template parts + +When you have made your changes, click on the **update design** button in the upper right corner, +where you normally publish and update your content. + +Select the templates and template parts that you want to save: + +![The save menu displays a list of templates and template parts with checkboxes](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-save.png) + +When you save changes in the site editor, the files in the active theme are not updated. Instead, the templates and template parts are saved as custom post types, that are accessed via the appearance menu. + +![The template parts view in the admin area displays a list of all saved template parts](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-appearance-template-parts.png) + + +## Exporting changes + +Saved templates and template parts can be exported as a partial theme from the Tools menu in the site editor. The block HTML code can then be copied to the theme that you are editing. diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/readme.md b/docs/howto-guides/block-tutorial/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/readme.md rename to docs/howto-guides/block-tutorial/README.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md b/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md rename to docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md rename to docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md rename to docs/howto-guides/block-tutorial/creating-dynamic-blocks.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/generate-blocks-with-wp-cli.md rename to docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md rename to docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md b/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md rename to docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md diff --git a/docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md similarity index 100% rename from docs/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type.md rename to docs/howto-guides/block-tutorial/writing-your-first-block-type.md diff --git a/docs/designers-developers/designers/README.md b/docs/howto-guides/designers/README.md similarity index 100% rename from docs/designers-developers/designers/README.md rename to docs/howto-guides/designers/README.md diff --git a/docs/designers-developers/designers/animation.md b/docs/howto-guides/designers/animation.md similarity index 100% rename from docs/designers-developers/designers/animation.md rename to docs/howto-guides/designers/animation.md diff --git a/docs/designers-developers/designers/assets/advanced-settings-do.png b/docs/howto-guides/designers/assets/advanced-settings-do.png similarity index 100% rename from docs/designers-developers/designers/assets/advanced-settings-do.png rename to docs/howto-guides/designers/assets/advanced-settings-do.png diff --git a/docs/designers-developers/designers/assets/block-controls-do.png b/docs/howto-guides/designers/assets/block-controls-do.png similarity index 100% rename from docs/designers-developers/designers/assets/block-controls-do.png rename to docs/howto-guides/designers/assets/block-controls-do.png diff --git a/docs/designers-developers/designers/assets/block-controls-dont.png b/docs/howto-guides/designers/assets/block-controls-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/block-controls-dont.png rename to docs/howto-guides/designers/assets/block-controls-dont.png diff --git a/docs/designers-developers/designers/assets/block-descriptions-do.png b/docs/howto-guides/designers/assets/block-descriptions-do.png similarity index 100% rename from docs/designers-developers/designers/assets/block-descriptions-do.png rename to docs/howto-guides/designers/assets/block-descriptions-do.png diff --git a/docs/designers-developers/designers/assets/block-descriptions-dont.png b/docs/howto-guides/designers/assets/block-descriptions-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/block-descriptions-dont.png rename to docs/howto-guides/designers/assets/block-descriptions-dont.png diff --git a/docs/designers-developers/designers/assets/blocks-do.png b/docs/howto-guides/designers/assets/blocks-do.png similarity index 100% rename from docs/designers-developers/designers/assets/blocks-do.png rename to docs/howto-guides/designers/assets/blocks-do.png diff --git a/docs/designers-developers/designers/assets/blocks-dont.png b/docs/howto-guides/designers/assets/blocks-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/blocks-dont.png rename to docs/howto-guides/designers/assets/blocks-dont.png diff --git a/docs/designers-developers/designers/assets/placeholder-do.png b/docs/howto-guides/designers/assets/placeholder-do.png similarity index 100% rename from docs/designers-developers/designers/assets/placeholder-do.png rename to docs/howto-guides/designers/assets/placeholder-do.png diff --git a/docs/designers-developers/designers/assets/placeholder-dont.png b/docs/howto-guides/designers/assets/placeholder-dont.png similarity index 100% rename from docs/designers-developers/designers/assets/placeholder-dont.png rename to docs/howto-guides/designers/assets/placeholder-dont.png diff --git a/docs/designers-developers/designers/block-design.md b/docs/howto-guides/designers/block-design.md similarity index 100% rename from docs/designers-developers/designers/block-design.md rename to docs/howto-guides/designers/block-design.md diff --git a/docs/designers-developers/designers/design-resources.md b/docs/howto-guides/designers/design-resources.md similarity index 100% rename from docs/designers-developers/designers/design-resources.md rename to docs/howto-guides/designers/design-resources.md diff --git a/docs/designers-developers/designers/user-interface.md b/docs/howto-guides/designers/user-interface.md similarity index 100% rename from docs/designers-developers/designers/user-interface.md rename to docs/howto-guides/designers/user-interface.md diff --git a/docs/designers-developers/developers/feature-flags.md b/docs/howto-guides/feature-flags.md similarity index 100% rename from docs/designers-developers/developers/feature-flags.md rename to docs/howto-guides/feature-flags.md diff --git a/docs/designers-developers/developers/tutorials/format-api/1-register-format.md b/docs/howto-guides/format-api/1-register-format.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/1-register-format.md rename to docs/howto-guides/format-api/1-register-format.md diff --git a/docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md b/docs/howto-guides/format-api/2-toolbar-button.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md rename to docs/howto-guides/format-api/2-toolbar-button.md diff --git a/docs/designers-developers/developers/tutorials/format-api/3-apply-format.md b/docs/howto-guides/format-api/3-apply-format.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/3-apply-format.md rename to docs/howto-guides/format-api/3-apply-format.md diff --git a/docs/designers-developers/developers/tutorials/format-api/README.md b/docs/howto-guides/format-api/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/format-api/README.md rename to docs/howto-guides/format-api/README.md diff --git a/docs/designers-developers/developers/internationalization.md b/docs/howto-guides/internationalization.md similarity index 100% rename from docs/designers-developers/developers/internationalization.md rename to docs/howto-guides/internationalization.md diff --git a/docs/designers-developers/developers/tutorials/javascript/readme.md b/docs/howto-guides/javascript/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/readme.md rename to docs/howto-guides/javascript/README.md diff --git a/docs/designers-developers/developers/tutorials/javascript/esnext-js.md b/docs/howto-guides/javascript/esnext-js.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/esnext-js.md rename to docs/howto-guides/javascript/esnext-js.md diff --git a/docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md b/docs/howto-guides/javascript/extending-the-block-editor.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md rename to docs/howto-guides/javascript/extending-the-block-editor.md diff --git a/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/js-build-setup.md rename to docs/howto-guides/javascript/js-build-setup.md diff --git a/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md b/docs/howto-guides/javascript/loading-javascript.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/loading-javascript.md rename to docs/howto-guides/javascript/loading-javascript.md diff --git a/docs/designers-developers/developers/tutorials/javascript/plugins-background.md b/docs/howto-guides/javascript/plugins-background.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/plugins-background.md rename to docs/howto-guides/javascript/plugins-background.md diff --git a/docs/designers-developers/developers/tutorials/javascript/scope-your-code.md b/docs/howto-guides/javascript/scope-your-code.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/scope-your-code.md rename to docs/howto-guides/javascript/scope-your-code.md diff --git a/docs/designers-developers/developers/tutorials/javascript/troubleshooting.md b/docs/howto-guides/javascript/troubleshooting.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/troubleshooting.md rename to docs/howto-guides/javascript/troubleshooting.md diff --git a/docs/designers-developers/developers/tutorials/javascript/versions-and-building.md b/docs/howto-guides/javascript/versions-and-building.md similarity index 100% rename from docs/designers-developers/developers/tutorials/javascript/versions-and-building.md rename to docs/howto-guides/javascript/versions-and-building.md diff --git a/docs/designers-developers/developers/tutorials/metabox/readme.md b/docs/howto-guides/metabox/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/readme.md rename to docs/howto-guides/metabox/README.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md b/docs/howto-guides/metabox/meta-block-1-intro.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md rename to docs/howto-guides/metabox/meta-block-1-intro.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md b/docs/howto-guides/metabox/meta-block-2-register-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md rename to docs/howto-guides/metabox/meta-block-2-register-meta.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md b/docs/howto-guides/metabox/meta-block-3-add.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md rename to docs/howto-guides/metabox/meta-block-3-add.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md b/docs/howto-guides/metabox/meta-block-4-use-data.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md rename to docs/howto-guides/metabox/meta-block-4-use-data.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md b/docs/howto-guides/metabox/meta-block-5-finishing.md similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md rename to docs/howto-guides/metabox/meta-block-5-finishing.md diff --git a/docs/designers-developers/developers/tutorials/metabox/meta-block.png b/docs/howto-guides/metabox/meta-block.png similarity index 100% rename from docs/designers-developers/developers/tutorials/metabox/meta-block.png rename to docs/howto-guides/metabox/meta-block.png diff --git a/docs/designers-developers/developers/tutorials/notices/README.md b/docs/howto-guides/notices/README.md similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/README.md rename to docs/howto-guides/notices/README.md diff --git a/docs/designers-developers/developers/tutorials/notices/block-editor-notice.png b/docs/howto-guides/notices/block-editor-notice.png similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/block-editor-notice.png rename to docs/howto-guides/notices/block-editor-notice.png diff --git a/docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png b/docs/howto-guides/notices/classic-editor-notice.png similarity index 100% rename from docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png rename to docs/howto-guides/notices/classic-editor-notice.png diff --git a/docs/designers-developers/developers/platform/README.md b/docs/howto-guides/platform/README.md similarity index 100% rename from docs/designers-developers/developers/platform/README.md rename to docs/howto-guides/platform/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/README.md b/docs/howto-guides/platform/custom-block-editor/README.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/README.md rename to docs/howto-guides/platform/custom-block-editor/README.md diff --git a/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md b/docs/howto-guides/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/designers-developers/developers/platform/custom-block-editor/tutorial.md rename to docs/howto-guides/platform/custom-block-editor/tutorial.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md diff --git a/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md similarity index 100% rename from docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md rename to docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md diff --git a/docs/designers-developers/developers/themes/README.md b/docs/howto-guides/themes/README.md similarity index 100% rename from docs/designers-developers/developers/themes/README.md rename to docs/howto-guides/themes/README.md diff --git a/docs/designers-developers/developers/themes/block-based-themes.md b/docs/howto-guides/themes/block-based-themes.md similarity index 100% rename from docs/designers-developers/developers/themes/block-based-themes.md rename to docs/howto-guides/themes/block-based-themes.md diff --git a/docs/designers-developers/developers/themes/theme-json.md b/docs/howto-guides/themes/theme-json.md similarity index 100% rename from docs/designers-developers/developers/themes/theme-json.md rename to docs/howto-guides/themes/theme-json.md diff --git a/docs/designers-developers/developers/themes/theme-support.md b/docs/howto-guides/themes/theme-support.md similarity index 100% rename from docs/designers-developers/developers/themes/theme-support.md rename to docs/howto-guides/themes/theme-support.md diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/docs/designers-developers/developers/block-api/README.md b/docs/reference-guides/block-api/README.md similarity index 100% rename from docs/designers-developers/developers/block-api/README.md rename to docs/reference-guides/block-api/README.md diff --git a/docs/designers-developers/developers/block-api/block-annotations.md b/docs/reference-guides/block-api/block-annotations.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-annotations.md rename to docs/reference-guides/block-api/block-annotations.md diff --git a/docs/designers-developers/developers/block-api/block-attributes.md b/docs/reference-guides/block-api/block-attributes.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-attributes.md rename to docs/reference-guides/block-api/block-attributes.md diff --git a/docs/designers-developers/developers/block-api/block-context.md b/docs/reference-guides/block-api/block-context.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-context.md rename to docs/reference-guides/block-api/block-context.md diff --git a/docs/designers-developers/developers/block-api/block-deprecation.md b/docs/reference-guides/block-api/block-deprecation.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-deprecation.md rename to docs/reference-guides/block-api/block-deprecation.md diff --git a/docs/designers-developers/developers/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-edit-save.md rename to docs/reference-guides/block-api/block-edit-save.md diff --git a/docs/designers-developers/developers/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-metadata.md rename to docs/reference-guides/block-api/block-metadata.md diff --git a/docs/designers-developers/developers/block-api/block-patterns.md b/docs/reference-guides/block-api/block-patterns.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-patterns.md rename to docs/reference-guides/block-api/block-patterns.md diff --git a/docs/designers-developers/developers/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-registration.md rename to docs/reference-guides/block-api/block-registration.md diff --git a/docs/designers-developers/developers/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-supports.md rename to docs/reference-guides/block-api/block-supports.md diff --git a/docs/designers-developers/developers/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-templates.md rename to docs/reference-guides/block-api/block-templates.md diff --git a/docs/designers-developers/developers/block-api/block-transforms.md b/docs/reference-guides/block-api/block-transforms.md similarity index 100% rename from docs/designers-developers/developers/block-api/block-transforms.md rename to docs/reference-guides/block-api/block-transforms.md diff --git a/docs/designers-developers/developers/block-api/versions.md b/docs/reference-guides/block-api/versions.md similarity index 100% rename from docs/designers-developers/developers/block-api/versions.md rename to docs/reference-guides/block-api/versions.md diff --git a/docs/appendix/data/README.md b/docs/reference-guides/data/README.md similarity index 100% rename from docs/appendix/data/README.md rename to docs/reference-guides/data/README.md diff --git a/docs/appendix/data/data-core-annotations.md b/docs/reference-guides/data/data-core-annotations.md similarity index 100% rename from docs/appendix/data/data-core-annotations.md rename to docs/reference-guides/data/data-core-annotations.md diff --git a/docs/appendix/data/data-core-block-editor.md b/docs/reference-guides/data/data-core-block-editor.md similarity index 100% rename from docs/appendix/data/data-core-block-editor.md rename to docs/reference-guides/data/data-core-block-editor.md diff --git a/docs/appendix/data/data-core-blocks.md b/docs/reference-guides/data/data-core-blocks.md similarity index 100% rename from docs/appendix/data/data-core-blocks.md rename to docs/reference-guides/data/data-core-blocks.md diff --git a/docs/appendix/data/data-core-edit-post.md b/docs/reference-guides/data/data-core-edit-post.md similarity index 100% rename from docs/appendix/data/data-core-edit-post.md rename to docs/reference-guides/data/data-core-edit-post.md diff --git a/docs/appendix/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md similarity index 100% rename from docs/appendix/data/data-core-editor.md rename to docs/reference-guides/data/data-core-editor.md diff --git a/docs/appendix/data/data-core-keyboard-shortcuts.md b/docs/reference-guides/data/data-core-keyboard-shortcuts.md similarity index 100% rename from docs/appendix/data/data-core-keyboard-shortcuts.md rename to docs/reference-guides/data/data-core-keyboard-shortcuts.md diff --git a/docs/appendix/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md similarity index 100% rename from docs/appendix/data/data-core-notices.md rename to docs/reference-guides/data/data-core-notices.md diff --git a/docs/appendix/data/data-core-nux.md b/docs/reference-guides/data/data-core-nux.md similarity index 100% rename from docs/appendix/data/data-core-nux.md rename to docs/reference-guides/data/data-core-nux.md diff --git a/docs/appendix/data/data-core-viewport.md b/docs/reference-guides/data/data-core-viewport.md similarity index 100% rename from docs/appendix/data/data-core-viewport.md rename to docs/reference-guides/data/data-core-viewport.md diff --git a/docs/appendix/data/data-core.md b/docs/reference-guides/data/data-core.md similarity index 100% rename from docs/appendix/data/data-core.md rename to docs/reference-guides/data/data-core.md diff --git a/docs/designers-developers/developers/filters/README.md b/docs/reference-guides/filters/README.md similarity index 100% rename from docs/designers-developers/developers/filters/README.md rename to docs/reference-guides/filters/README.md diff --git a/docs/designers-developers/developers/filters/autocomplete-filters.md b/docs/reference-guides/filters/autocomplete-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/autocomplete-filters.md rename to docs/reference-guides/filters/autocomplete-filters.md diff --git a/docs/designers-developers/developers/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/block-filters.md rename to docs/reference-guides/filters/block-filters.md diff --git a/docs/designers-developers/developers/filters/editor-filters.md b/docs/reference-guides/filters/editor-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/editor-filters.md rename to docs/reference-guides/filters/editor-filters.md diff --git a/docs/designers-developers/developers/filters/i18n-filters.md b/docs/reference-guides/filters/i18n-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/i18n-filters.md rename to docs/reference-guides/filters/i18n-filters.md diff --git a/docs/designers-developers/developers/filters/parser-filters.md b/docs/reference-guides/filters/parser-filters.md similarity index 100% rename from docs/designers-developers/developers/filters/parser-filters.md rename to docs/reference-guides/filters/parser-filters.md diff --git a/docs/appendix/packages.md b/docs/reference-guides/packages.md similarity index 100% rename from docs/appendix/packages.md rename to docs/reference-guides/packages.md diff --git a/docs/designers-developers/developers/richtext.md b/docs/reference-guides/richtext.md similarity index 100% rename from docs/designers-developers/developers/richtext.md rename to docs/reference-guides/richtext.md diff --git a/docs/designers-developers/developers/slotfills/README.md b/docs/reference-guides/slotfills/README.md similarity index 100% rename from docs/designers-developers/developers/slotfills/README.md rename to docs/reference-guides/slotfills/README.md diff --git a/docs/designers-developers/developers/slotfills/main-dashboard-button.md b/docs/reference-guides/slotfills/main-dashboard-button.md similarity index 100% rename from docs/designers-developers/developers/slotfills/main-dashboard-button.md rename to docs/reference-guides/slotfills/main-dashboard-button.md diff --git a/docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md rename to docs/reference-guides/slotfills/plugin-block-settings-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/reference-guides/slotfills/plugin-document-setting-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md rename to docs/reference-guides/slotfills/plugin-document-setting-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-more-menu-item.md b/docs/reference-guides/slotfills/plugin-more-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-more-menu-item.md rename to docs/reference-guides/slotfills/plugin-more-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md b/docs/reference-guides/slotfills/plugin-post-publish-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md rename to docs/reference-guides/slotfills/plugin-post-publish-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-post-status-info.md b/docs/reference-guides/slotfills/plugin-post-status-info.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-post-status-info.md rename to docs/reference-guides/slotfills/plugin-post-status-info.md diff --git a/docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md rename to docs/reference-guides/slotfills/plugin-pre-publish-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md rename to docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md diff --git a/docs/designers-developers/developers/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md similarity index 100% rename from docs/designers-developers/developers/slotfills/plugin-sidebar.md rename to docs/reference-guides/slotfills/plugin-sidebar.md From 72eefd71118ae56e173d4168ddcfe15cfb45db49 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Wed, 24 Feb 2021 16:02:07 +0100 Subject: [PATCH 45/68] Update links in the documentation after changing the folder structure --- docs/contributors/code/getting-started.md | 6 ++--- docs/contributors/design/reference.md | 6 ++--- docs/contributors/documentation/document.md | 4 +-- .../tutorials/block-based-theme/README.md | 14 +++++----- .../full-site-editing-templates.md | 2 +- docs/getting-started/README.md | 16 ++++++------ .../getting-started/architecture/data-flow.md | 2 +- .../architecture/key-concepts.md | 12 ++++----- .../architecture/modularity.md | 2 +- docs/getting-started/faq.md | 6 ++--- docs/getting-started/tutorials/README.md | 18 ++++++------- .../tutorials/create-block/README.md | 16 ++++++------ .../tutorials/create-block/attributes.md | 6 ++--- .../create-block/author-experience.md | 2 +- .../tutorials/create-block/block-anatomy.md | 8 +++--- .../tutorials/create-block/block-code.md | 2 +- .../tutorials/create-block/finishing.md | 8 +++--- .../submitting-to-block-directory.md | 8 +++--- .../tutorials/create-block/wp-plugin.md | 8 +++--- .../tutorials/devenv/README.md | 2 +- docs/howto-guides/README.md | 18 ++++++------- .../backward-compatibility/README.md | 2 +- .../backward-compatibility/deprecations.md | 8 +++--- .../backward-compatibility/meta-box.md | 2 +- docs/howto-guides/block-tutorial/README.md | 2 +- .../block-tutorial/creating-dynamic-blocks.md | 6 ++--- .../generate-blocks-with-wp-cli.md | 2 +- ...roducing-attributes-and-editable-fields.md | 4 +-- .../writing-your-first-block-type.md | 4 +-- docs/howto-guides/designers/block-design.md | 4 +-- .../howto-guides/format-api/3-apply-format.md | 2 +- docs/howto-guides/format-api/README.md | 8 +++--- docs/howto-guides/internationalization.md | 2 +- docs/howto-guides/javascript/README.md | 16 ++++++------ .../javascript/extending-the-block-editor.md | 4 +-- .../howto-guides/javascript/js-build-setup.md | 6 ++--- .../javascript/troubleshooting.md | 4 +-- .../javascript/versions-and-building.md | 4 +-- docs/howto-guides/metabox/README.md | 6 ++--- .../metabox/meta-block-1-intro.md | 10 +++---- docs/howto-guides/metabox/meta-block-3-add.md | 4 +-- .../metabox/meta-block-5-finishing.md | 2 +- docs/howto-guides/notices/README.md | 4 +-- docs/howto-guides/platform/README.md | 2 +- .../platform/custom-block-editor/README.md | 4 +-- .../sidebar-tutorial/plugin-sidebar-0.md | 14 +++++----- .../plugin-sidebar-1-up-and-running.md | 2 +- .../plugin-sidebar-3-register-meta.md | 2 +- .../plugin-sidebar-4-initialize-input.md | 2 +- .../howto-guides/themes/block-based-themes.md | 4 +-- docs/howto-guides/themes/theme-support.md | 2 +- docs/reference-guides/block-api/README.md | 24 ++++++++--------- .../block-api/block-attributes.md | 2 +- .../block-api/block-deprecation.md | 6 ++--- .../block-api/block-edit-save.md | 14 +++++----- .../block-api/block-metadata.md | 26 +++++++++---------- .../block-api/block-registration.md | 10 +++---- .../block-api/block-supports.md | 6 ++--- .../block-api/block-templates.md | 2 +- docs/reference-guides/data/README.md | 18 ++++++------- .../reference-guides/filters/block-filters.md | 4 +-- docs/reference-guides/slotfills/README.md | 18 ++++++------- 62 files changed, 217 insertions(+), 217 deletions(-) diff --git a/docs/contributors/code/getting-started.md b/docs/contributors/code/getting-started.md index 85d63dc49fd10..b8d7cd9f08780 100644 --- a/docs/contributors/code/getting-started.md +++ b/docs/contributors/code/getting-started.md @@ -1,12 +1,12 @@ # Getting Started -The following guide is for setting up your local environment to contribute to the Gutenberg project. There is significant overlap between an environment to contribute and an environment used to extend the WordPress block editor. You can review the [Development Environment tutorial](/docs/designers-developers/developers/tutorials/devenv/readme.md) for additional setup information. +The following guide is for setting up your local environment to contribute to the Gutenberg project. There is significant overlap between an environment to contribute and an environment used to extend the WordPress block editor. You can review the [Development Environment tutorial](/docs/getting-started/tutorials/devenv/readme.md) for additional setup information. ## Development Tools (Node) Gutenberg is a JavaScript project and requires [Node.js](https://nodejs.org/). The project is built using the latest active LTS release of node, and the latest version of NPM. See the [LTS release schedule](https://github.com/nodejs/Release#release-schedule) for details. -We recommend using the [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) since it is the easiest way to install and manage node for macOS, Linux, and Windows 10 using WSL2. See [our Development Tools guide](/docs/designers-developers/developers/tutorials/devenv/readme.md#development-tools) or the Nodejs site for additional installation instructions. +We recommend using the [Node Version Manager](https://github.com/nvm-sh/nvm) (nvm) since it is the easiest way to install and manage node for macOS, Linux, and Windows 10 using WSL2. See [our Development Tools guide](/docs/getting-started/tutorials/devenv/readme.md#development-tools) or the Nodejs site for additional installation instructions. After installing Node, you can build Gutenberg by running the following from within the cloned repository: @@ -34,7 +34,7 @@ The [wp-env package](/packages/env/README.md) was developed with the Gutenberg p By default, `wp-env` can run in a plugin directory to create and run a WordPress environment, mounting and activating the plugin automatically. You can also configure `wp-env` to use existing installs, multiple plugins, or themes. See the [wp-env package](/packages/env/README.md#wp-envjson) for complete documentation. -If you don't already have it, you'll need to install Docker and Docker Compose in order to use `wp-env`. See the [Development Environment tutorial for additional details](/docs/designers-developers/developers/tutorials/devenv/readme.md). +If you don't already have it, you'll need to install Docker and Docker Compose in order to use `wp-env`. See the [Development Environment tutorial for additional details](/docs/getting-started/tutorials/devenv/readme.md). Once Docker is installed and running: To install WordPress, run the following from within the cloned gutenberg directory: diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 5bdda020f1979..9a4e6944aef83 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -1,9 +1,9 @@ # Reference -- [Glossary](/docs/designers-developers/glossary.md) +- [Glossary](/docs/getting-started/glossary.md) - [Coding Guidelines](/docs/contributors/coding-guidelines.md) - [Testing Overview](/docs/contributors/testing-overview.md) -- [Frequently Asked Questions](/docs/designers-developers/faq.md) +- [Frequently Asked Questions](/docs/getting-started/faq.md) ## Logo @@ -15,4 +15,4 @@ Released under GPL license, made by [Cristel Rossignol](https://twitter.com/cris ## Mockups -Mockup Sketch files are available in [the Design section](/docs/designers-developers/designers/design-resources.md). +Mockup Sketch files are available in [the Design section](/docs/howto-guides/designers/design-resources.md). diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index a88612abeee3b..a9d85c6679daa 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -39,7 +39,7 @@ To update an existing page: ### Create a New Document -To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md): +To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/howto-guides/javascript/js-build-setup.md): 1. Create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/HEAD/docs) folder, use lower-case, no spaces, if needed a dash separator, and .md extension. 2. Add content, all documents require one and only H1 tag, using markdown notation. @@ -73,7 +73,7 @@ An example, the link to this page is: `/docs/contributors/document.md` The code example in markdown should be wrapped in three tick marks \`\`\` and should additionally include a language specifier. See this [GitHub documentation around fenced code blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). -A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). Here is an example `codetabs` section: diff --git a/docs/designers-developers/developers/tutorials/block-based-theme/README.md b/docs/designers-developers/developers/tutorials/block-based-theme/README.md index 2e0c8402d3761..faf0b054a163f 100644 --- a/docs/designers-developers/developers/tutorials/block-based-theme/README.md +++ b/docs/designers-developers/developers/tutorials/block-based-theme/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/howto-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/howto-guides/block-based-themes/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/howto-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/howto-guides/block-based-themes/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -32,7 +32,7 @@ Each template or template part contains the [block grammar](https://developer.wo A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. -The theme may optionally include an [experimental-theme.json file](/docs/designers-developers/developers/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. +The theme may optionally include an [experimental-theme.json file](/docs/howto-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) diff --git a/docs/explanations/full-site-editing-templates.md b/docs/explanations/full-site-editing-templates.md index 293b7f1f7bd30..4717eee4ecbe2 100644 --- a/docs/explanations/full-site-editing-templates.md +++ b/docs/explanations/full-site-editing-templates.md @@ -2,7 +2,7 @@ > This is the documentation for the current implementation of the block-based templates and template parts themes. This is part of the Full Site Editing project. These features are still experimental in the plugin. “Experimental” means this is just an early implementation that is subject to potential drastic and breaking changes in iterations based on feedback from users, contributors, and theme authors. -This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/designers-developers/developers/themes/block-based-themes.md). +This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/howto-guides/themes/block-based-themes.md). ## Storage diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index df67956d3e4f3..2d56c6e272d47 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -22,19 +22,19 @@ The Editor offers rich new value to users with visual, drag-and-drop creation to ### Create a Block Tutorial -[Learn how to create your first block](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. +[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. ### Develop for the block editor -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/designers-developers/developers/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/howto-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - [Gutenberg Architecture](/docs/architecture/readme.md) -- [Block Style Variations](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) -- [Creating Block Patterns](/docs/designers-developers/developers/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/designers-developers/developers/themes/readme.md) -- [Block API Reference](/docs/designers-developers/developers/block-api/readme.md) -- [Block Editor Accessibility](/docs/designers-developers/developers/accessibility.md) -- [Internationalization](/docs/designers-developers/developers/internationalization.md) +- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) +- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Theming for the Block Editor](/docs/howto-guides/themes/readme.md) +- [Block API Reference](/docs/reference-guides/block-api/readme.md) +- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) +- [Internationalization](/docs/howto-guides/internationalization.md) ### Contribute to the block editor diff --git a/docs/getting-started/architecture/data-flow.md b/docs/getting-started/architecture/data-flow.md index 3fefec3aae7e7..07957382ec1bf 100644 --- a/docs/getting-started/architecture/data-flow.md +++ b/docs/getting-started/architecture/data-flow.md @@ -104,7 +104,7 @@ After running this through the parser, we're left with a simple object we can ma This has dramatic implications for how simple and performant we can make our parser. These explicit boundaries also protect damage in a single block from bleeding into other blocks or tarnishing the entire document. It also allows the system to identify unrecognized blocks before rendering them. -_N.B.:_ The defining aspects of blocks are their semantics and the isolation mechanism they provide: in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](/docs/designers-developers/developers/block-api/block-attributes.md) for details. +_N.B.:_ The defining aspects of blocks are their semantics and the isolation mechanism they provide: in other words, their identity. On the other hand, where their data is stored is a more liberal aspect. Blocks support more than just static local data (via JSON literals inside the HTML comment or within the block's HTML), and more mechanisms (_e.g._, global blocks or otherwise resorting to storage in complementary `WP_Post` objects) are expected. See [attributes](/docs/reference-guides/block-api/block-attributes.md) for details. ### The Anatomy of a Serialized Block diff --git a/docs/getting-started/architecture/key-concepts.md b/docs/getting-started/architecture/key-concepts.md index 553a00923d267..3ec6487b63794 100644 --- a/docs/getting-started/architecture/key-concepts.md +++ b/docs/getting-started/architecture/key-concepts.md @@ -32,12 +32,12 @@ Blocks have the ability to be transformed into other block types. This allows ba ### Variations -Given a block type, a block variation is a predefined set of its initial attributes. This API allows creating a single block from which multiple configurations are possible. Variations provide different possible interfaces, including showing up as entirely new blocks in the library, or as presets when inserting a new block. Read [the API documentation](/docs/designers-developers/developers/block-api/block-registration.md#variations-optional) for more details. +Given a block type, a block variation is a predefined set of its initial attributes. This API allows creating a single block from which multiple configurations are possible. Variations provide different possible interfaces, including showing up as entirely new blocks in the library, or as presets when inserting a new block. Read [the API documentation](/docs/reference-guides/block-api/block-registration.md#variations-optional) for more details. **More on Blocks** -- **[Block API](/docs/designers-developers/developers/block-api/README.md)** -- **[Tutorial: Building A Custom Block](/docs/designers-developers/developers/tutorials/create-block/readme.md)** +- **[Block API](/docs/reference-guides/block-api/README.md)** +- **[Tutorial: Building A Custom Block](/docs/getting-started/tutorials/create-block/readme.md)** ## Reusable Blocks @@ -49,14 +49,14 @@ In technical details, reusable blocks are stored as a hidden post type (`wp_bloc ## Patterns -A [block pattern](/docs/designers-developers/developers/block-api/block-patterns.md) is a group of blocks that have been combined together creating a design pattern. These design patterns provide a starting point for building more advanced pages and layouts quickly. A block pattern can be as small as a single block or as large as a full page of content. Unlike reusable blocks, once a pattern is inserted it doesn't remain in sync with the original content as the blocks contained are meant to be edited and customized by the user. Underneath the surface, patterns are just regular blocks composed together. Themes can register patterns to offer users quick starting points with a design language familiar to that theme's aesthetics. +A [block pattern](/docs/reference-guides/block-api/block-patterns.md) is a group of blocks that have been combined together creating a design pattern. These design patterns provide a starting point for building more advanced pages and layouts quickly. A block pattern can be as small as a single block or as large as a full page of content. Unlike reusable blocks, once a pattern is inserted it doesn't remain in sync with the original content as the blocks contained are meant to be edited and customized by the user. Underneath the surface, patterns are just regular blocks composed together. Themes can register patterns to offer users quick starting points with a design language familiar to that theme's aesthetics. ## Templates (in progress) -While the post editor concentrates on the content of a post, the [template](/docs/designers-developers/developers/block-api/block-templates.md) editor allows declaring and editing an entire site using blocks, from header to footer. To support these efforts there's a collection of blocks that interact with different parts of a site (like the site title, description, logo, navigation, etc) as well as semantic areas like header, sidebar, and footer. Templates are broken down between templates (that describe a full page) and template parts (that describe reusable areas within a template). These templates and template parts can be composed together and registered by a theme. They are also entirely editable by users using the block editor. Customized templates are saved in a `wp_template` post type. Block templates include both static pages and dynamic ones, like archives, singular, home, 404, etc. +While the post editor concentrates on the content of a post, the [template](/docs/reference-guides/block-api/block-templates.md) editor allows declaring and editing an entire site using blocks, from header to footer. To support these efforts there's a collection of blocks that interact with different parts of a site (like the site title, description, logo, navigation, etc) as well as semantic areas like header, sidebar, and footer. Templates are broken down between templates (that describe a full page) and template parts (that describe reusable areas within a template). These templates and template parts can be composed together and registered by a theme. They are also entirely editable by users using the block editor. Customized templates are saved in a `wp_template` post type. Block templates include both static pages and dynamic ones, like archives, singular, home, 404, etc. Note: custom post types can also be initialized with a starting `post_content` template that should not be confused with the theme template system described above. ## Global Styles (in progress) -Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/designers-developers/developers/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. +Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/howto-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. diff --git a/docs/getting-started/architecture/modularity.md b/docs/getting-started/architecture/modularity.md index f10de0151d889..0f80bc01a50b6 100644 --- a/docs/getting-started/architecture/modularity.md +++ b/docs/getting-started/architecture/modularity.md @@ -100,4 +100,4 @@ Structured this way, these packages can be used in a variety of combinations out ## Going further - - [Package Reference](/docs/designers-developers/developers/packages.md) + - [Package Reference](/docs/reference-guides/packages.md) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 76bb92d5edbde..552105eb0a80d 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -326,7 +326,7 @@ This is currently a work in progress and we recommend reviewing the [block based No, block variations are different versions of a single base block, sharing a similar functionality, but with slight differences in their implementation, or settings (attributes, InnerBlocks,etc). Block variations are transparent for users, and once there is a registered block variation, it will appear as a new block. For example, the `embed` block registers different block variations to embed content from specific providers. -Meanwhile, [block styles](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) allow you to provide alternative styles to existing blocks, and they work by adding a className to the block’s wrapper. Once a block has registered block styles, a block style selector will appear in its sidebar so that users can choose among the different registered styles. +Meanwhile, [block styles](/docs/reference-guides/filters/block-filters.md#block-style-variations) allow you to provide alternative styles to existing blocks, and they work by adding a className to the block’s wrapper. Once a block has registered block styles, a block style selector will appear in its sidebar so that users can choose among the different registered styles. ## How do editor styles work? @@ -339,7 +339,7 @@ function gutenbergtheme_editor_styles() { add_action( 'enqueue_block_editor_assets', 'gutenbergtheme_editor_styles' ); ``` -*See:* [Editor Styles](/docs/designers-developers/developers/themes/theme-support.md#editor-styles) +*See:* [Editor Styles](/docs/howto-guides/themes/theme-support.md#editor-styles) ## Should I be concerned that Gutenberg will make my plugin obsolete? @@ -390,7 +390,7 @@ Our approach—as outlined in [the technical overview introduction](https://make This also [gives us the flexibility](https://github.com/WordPress/gutenberg/issues/1516) to store those blocks that are inherently separate from the content stream (reusable pieces like widgets or small post type elements) elsewhere, and just keep token references for their placement. -We suggest you look at the [Gutenberg key concepts](/docs/designers-developers/key-concepts.md) to learn more about how this aspect of the project works. +We suggest you look at the [Gutenberg key concepts](/docs/getting-started/architecture/key-concepts.md) to learn more about how this aspect of the project works. ## How can I parse the post content back out into blocks in PHP or JS? In JS: diff --git a/docs/getting-started/tutorials/README.md b/docs/getting-started/tutorials/README.md index 17c428bbb508b..b122cadc61a2b 100644 --- a/docs/getting-started/tutorials/README.md +++ b/docs/getting-started/tutorials/README.md @@ -1,19 +1,19 @@ # Tutorials -- First things first, see [setting up your development environment](/docs/designers-developers/developers/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. +- First things first, see [setting up your development environment](/docs/getting-started/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. -- See the [Getting Started with JavaScript Tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) to learn about how to use JavaScript within WordPress. +- See the [Getting Started with JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. -- Beginners: The [Create a Block Tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. +- Beginners: The [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. -- Intermediate: The [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. +- Intermediate: The [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. -- See the [Meta Boxes Tutorial](/docs/designers-developers/developers/tutorials/metabox/readme.md) for new ways of extending the editor storing and using post meta data. +- See the [Meta Boxes Tutorial](/docs/howto-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. -- Check out the [Notices Tutorial](/docs/designers-developers/developers/tutorials/notices/README.md) to learn how to display informational UI at the top of the editor. +- Check out the [Notices Tutorial](/docs/howto-guides/notices/README.md) to learn how to display informational UI at the top of the editor. -- The [Sidebar Tutorial](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. +- The [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. -- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/designers-developers/developers/tutorials/format-api/). +- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/howto-guides/format-api/). -- Build your own [custom block editor instance](/docs/designers-developers/developers/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. +- Build your own [custom block editor instance](/docs/reference-guides/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. diff --git a/docs/getting-started/tutorials/create-block/README.md b/docs/getting-started/tutorials/create-block/README.md index 50b385928a467..653f14fca869f 100644 --- a/docs/getting-started/tutorials/create-block/README.md +++ b/docs/getting-started/tutorials/create-block/README.md @@ -6,7 +6,7 @@ The tutorial includes setting up your development environment, tools, and gettin ## Prerequisites -The first thing you need is a development environment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md). +The first thing you need is a development environment and tools. This includes setting up your WordPress environment, Node, NPM, and your code editor. If you need help, see the [setting up your development environment documentation](/docs/getting-started/tutorials/devenv/readme.md). ## Quick Start @@ -28,10 +28,10 @@ After activated, go to the block editor and use the inserter to search and add y The create a block tutorials breaks down to the following sections. -1. [WordPress Plugin](/docs/designers-developers/developers/tutorials/create-block/wp-plugin.md) -2. [Anatomy of a Gutenberg Block ](/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md) -3. [Block Attributes](/docs/designers-developers/developers/tutorials/create-block/attributes.md) -4. [Code Implementation](/docs/designers-developers/developers/tutorials/create-block/block-code.md) -5. [Authoring Experience](/docs/designers-developers/developers/tutorials/create-block/author-experience.md) -6. [Finishing Touches](/docs/designers-developers/developers/tutorials/create-block/finishing.md) -7. [Share your Block with the World](/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md) +1. [WordPress Plugin](/docs/getting-started/tutorials/create-block/wp-plugin.md) +2. [Anatomy of a Gutenberg Block ](/docs/getting-started/tutorials/create-block/block-anatomy.md) +3. [Block Attributes](/docs/getting-started/tutorials/create-block/attributes.md) +4. [Code Implementation](/docs/getting-started/tutorials/create-block/block-code.md) +5. [Authoring Experience](/docs/getting-started/tutorials/create-block/author-experience.md) +6. [Finishing Touches](/docs/getting-started/tutorials/create-block/finishing.md) +7. [Share your Block with the World](/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md) diff --git a/docs/getting-started/tutorials/create-block/attributes.md b/docs/getting-started/tutorials/create-block/attributes.md index 5614987e33fa0..2c3360db158af 100644 --- a/docs/getting-started/tutorials/create-block/attributes.md +++ b/docs/getting-started/tutorials/create-block/attributes.md @@ -18,11 +18,11 @@ Add this to the `index.js` file within the `registerBlockType` function. The `at When the block loads it will look at the saved content for the block, look for the div tag, take the text portion, and store the content in an `attributes.message` variable. -Note: The text portion is equivalent to `innerText` attribute of a DOM element. For more details and other examples see the [Block Attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md). +Note: The text portion is equivalent to `innerText` attribute of a DOM element. For more details and other examples see the [Block Attributes documentation](/docs/reference-guides/block-api/block-attributes.md). ## Edit and Save -The **attributes** are passed to the `edit` and `save` functions, along with a **setAttributes** function to set the values. Additional parameters are also passed in to this functions, see [the edit/save documentation](/docs/designers-developers/developers/block-api/block-edit-save.md) for more details. +The **attributes** are passed to the `edit` and `save` functions, along with a **setAttributes** function to set the values. Additional parameters are also passed in to this functions, see [the edit/save documentation](/docs/reference-guides/block-api/block-edit-save.md) for more details. The `attributes` is a JavaScript object containing the values of each attribute, or default values if defined. The `setAttributes` is a function to update an attribute. @@ -71,4 +71,4 @@ export default function Save( { attributes, className } ) { Rebuild the block using `npm run build`, reload the editor and add the block. Type a message in the editor, save, and view it in the post. -Next Section: [Code Implementation](/docs/designers-developers/developers/tutorials/create-block/block-code.md) +Next Section: [Code Implementation](/docs/getting-started/tutorials/create-block/block-code.md) diff --git a/docs/getting-started/tutorials/create-block/author-experience.md b/docs/getting-started/tutorials/create-block/author-experience.md index accd856ae2562..a79b73e5d07b9 100644 --- a/docs/getting-started/tutorials/create-block/author-experience.md +++ b/docs/getting-started/tutorials/create-block/author-experience.md @@ -139,4 +139,4 @@ export default function Edit( { attributes, className, setAttributes } ) { } ``` -Next Section: [Finishing Touches](/docs/designers-developers/developers/tutorials/create-block/finishing.md) +Next Section: [Finishing Touches](/docs/getting-started/tutorials/create-block/finishing.md) diff --git a/docs/getting-started/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md index 2eea119b98ecd..2a807b7356105 100644 --- a/docs/getting-started/tutorials/create-block/block-anatomy.md +++ b/docs/getting-started/tutorials/create-block/block-anatomy.md @@ -2,7 +2,7 @@ At its simplest, a block in the WordPress block editor is a JavaScript object with a specific set of properties. -**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. +**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. Here is the complete code for registering a block: @@ -35,13 +35,13 @@ registerBlockType( 'create-block/gutenpride', { The first parameter in the **registerBlockType** function is the block name, this should match exactly to the name registered in the PHP file. -The second parameter to the function is the block object. See the [block registration documentation](/docs/designers-developers/developers/block-api/block-registration.md) for full details. +The second parameter to the function is the block object. See the [block registration documentation](/docs/reference-guides/block-api/block-registration.md) for full details. The **title** is the title of the block shown in the Inserter. The **icon** is the icon shown in the Inserter. The icon property expects any Dashicon name as a string, see [list of available icons](https://developer.wordpress.org/resource/dashicons/). You can also provide an SVG object, but for now it's easiest to just pick a Dashicon name. -The **category** specified is a string and must be one of: "common, formatting, layout, widgets, or embed". You can create your own custom category name, [see documentation for details](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). For this tutorial, I specified "widgets" as the category. +The **category** specified is a string and must be one of: "common, formatting, layout, widgets, or embed". You can create your own custom category name, [see documentation for details](/docs/reference-guides/filters/block-filters.md#managing-block-categories). For this tutorial, I specified "widgets" as the category. The last two block object properties are **edit** and **save**, these are the key parts of a block. Both properties should be defined as functions. @@ -61,4 +61,4 @@ __( 'Gutenpride', 'gutenpride' ); This is an internationalization wrapper that allows for the string "Gutenpride" to be translated. The second parameter, "gutenpride" is called the text domain and gives context for where the string is from. The JavaScript internationalization, often abbreviated i18n, matches the core WordPress internationalization process. See the [Internationalization in Plugin Developer Handbook](https://developer.wordpress.org/plugins/internationalization/) for more details. -Next Section: [Block Attributes](/docs/designers-developers/developers/tutorials/create-block/attributes.md) +Next Section: [Block Attributes](/docs/getting-started/tutorials/create-block/attributes.md) diff --git a/docs/getting-started/tutorials/create-block/block-code.md b/docs/getting-started/tutorials/create-block/block-code.md index 61a4b920aab95..23541de7ecb59 100644 --- a/docs/getting-started/tutorials/create-block/block-code.md +++ b/docs/getting-started/tutorials/create-block/block-code.md @@ -65,4 +65,4 @@ Update **gutenpride.php** to enqueue from generated file location: $editor_css = "build/index.css"; ``` -Next Section: [Authoring Experience](/docs/designers-developers/developers/tutorials/create-block/author-experience.md) +Next Section: [Authoring Experience](/docs/getting-started/tutorials/create-block/author-experience.md) diff --git a/docs/getting-started/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md index a07c82296123b..1eda38da32078 100644 --- a/docs/getting-started/tutorials/create-block/finishing.md +++ b/docs/getting-started/tutorials/create-block/finishing.md @@ -10,13 +10,13 @@ You can visually browse the components and what their implementation looks like ## Additional Tutorials -The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/designers-developers/developers/richtext.md) for documentation using this component. +The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/reference-guides/richtext.md) for documentation using this component. -The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. +The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. -The [Sidebar tutorial](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. +The [Sidebar tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. -Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md). +Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md). ## How did they do that diff --git a/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md index a0924099310f1..220c30a174ea4 100644 --- a/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md +++ b/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md @@ -48,7 +48,7 @@ Examples for an Image Slider block: - carousel - gallery -[Read more about keywords.](/docs/designers-developers/developers/block-api/block-metadata.md#keywords) +[Read more about keywords.](/docs/reference-guides/block-api/block-metadata.md#keywords) ### Choose the right category @@ -62,13 +62,13 @@ The Block Editor allows you to indicate the category your block belongs in, maki - widgets - embed -[Read more about categories.](/docs/designers-developers/developers/block-api/block-metadata.md#category) +[Read more about categories.](/docs/reference-guides/block-api/block-metadata.md#category) Wondering where to input all this information? Read the next section :) ## Step 2: Analyze your plugin -Each block in your plugin should have a corresponding `block.json` file with the [block metadata](/docs/designers-developers/developers/block-api/block-metadata.md). This file provides the Block Directory important information about your block. Along with being the place to store contextual information about your block like the: `name`, `description`, `keywords` and `category`, the `block.json` file stores the location of your block’s files. +Each block in your plugin should have a corresponding `block.json` file with the [block metadata](/docs/reference-guides/block-api/block-metadata.md). This file provides the Block Directory important information about your block. Along with being the place to store contextual information about your block like the: `name`, `description`, `keywords` and `category`, the `block.json` file stores the location of your block’s files. Block plugins submitted to the Block Directory can contain mutliple blocks only if they are children of a single parent/ancestor. There should only be one main block. For example, a list block can contain list-item blocks. Children blocks must set the `parent` property in their `block.json` file. @@ -94,7 +94,7 @@ Here is an example of a basic block.json file. } ``` -The `block.json` file also contains other important properties. Take a look at an [example block.json](/docs/designers-developers/developers/block-api/block-metadata.md) for additional properties to be included in the block.json file. +The `block.json` file also contains other important properties. Take a look at an [example block.json](/docs/reference-guides/block-api/block-metadata.md) for additional properties to be included in the block.json file. ## Step 3: Zip & Submit diff --git a/docs/getting-started/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md index b044423658967..a7a5687c23740 100644 --- a/docs/getting-started/tutorials/create-block/wp-plugin.md +++ b/docs/getting-started/tutorials/create-block/wp-plugin.md @@ -49,7 +49,7 @@ Let's confirm the plugin is loaded and working. -or- -(3B) If you are using `wp-env`, see [Development Environment setup](/docs/designers-developers/developers/tutorials/devenv/readme.md), then you should now run from inside the `gutenpride` directory: +(3B) If you are using `wp-env`, see [Development Environment setup](/docs/getting-started/tutorials/devenv/readme.md), then you should now run from inside the `gutenpride` directory: ```sh wp-env start @@ -112,7 +112,7 @@ For the `editorScript` provided in the block metadata, the build process creates The `wp_register_script` function used internally registers a name, called the handle, and relates that name to the script file. The dependencies are used to specify if the script requires including other libraries. The version is specified so the browser will reload if the file changed. -The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/designers-developers/developers/internationalization.md) +The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/howto-guides/internationalization.md) With the above in place, create a new post to load the editor and check your plugin is in the inserter. You can use `/` to search, or click the box with the [+] and search for "Gutenpride" to find the block. @@ -124,10 +124,10 @@ To open the developer tools in Firefox, use the menu selecting Web Developer : T Try running `npm run start` that will start the watch process for automatic rebuilds. If you then make an update to `src/index.js` file, you will see the build run, and if you reload the WordPress editor you'll see the change. -For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) in the Block Editor Handbook. +For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/js-build-setup.md) in the Block Editor Handbook. ## Summary Hopefully, at this point, you have your plugin created and activated. We have the package.json with the `@wordpress/scripts` dependency, that defines the build and start scripts. The basic block is in place and can be added to the editor. -Next Section: [Anatomy of a Block](/docs/designers-developers/developers/tutorials/create-block/block-anatomy.md) +Next Section: [Anatomy of a Block](/docs/getting-started/tutorials/create-block/block-anatomy.md) diff --git a/docs/getting-started/tutorials/devenv/README.md b/docs/getting-started/tutorials/devenv/README.md index 642e17b5528ac..212c7f689cd58 100644 --- a/docs/getting-started/tutorials/devenv/README.md +++ b/docs/getting-started/tutorials/devenv/README.md @@ -115,7 +115,7 @@ There are several ways to run WordPress locally on your own computer, or you cou The WordPress [wp-env package](https://www.npmjs.com/package/@wordpress/env) lets you set up a local WordPress environment for building and testing plugins and themes, without any additional configuration. -The `wp-env` tool uses Docker to create a virtual machine to that runs the WordPress site. There are instructions available for installing Docker on [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/), [all other versions of Windows](https://docs.docker.com/toolbox/toolbox_install_windows/), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/v17.12/install/linux/docker-ce/ubuntu/#install-using-the-convenience-script). If using Ubuntu, see our additional notes for [help installing Docker on Ubuntu](/docs/designers-developers/developers/tutorials/devenv/docker-ubuntu.md). +The `wp-env` tool uses Docker to create a virtual machine to that runs the WordPress site. There are instructions available for installing Docker on [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/), [all other versions of Windows](https://docs.docker.com/toolbox/toolbox_install_windows/), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/v17.12/install/linux/docker-ce/ubuntu/#install-using-the-convenience-script). If using Ubuntu, see our additional notes for [help installing Docker on Ubuntu](/docs/getting-started/tutorials/devenv/docker-ubuntu.md). After you have installed Docker, go ahead and install the `wp-env` tool. This command will install the tool globally, which means you can run it from any directory: diff --git a/docs/howto-guides/README.md b/docs/howto-guides/README.md index f79b1564f1787..dbed9976d4c9e 100644 --- a/docs/howto-guides/README.md +++ b/docs/howto-guides/README.md @@ -4,15 +4,15 @@ The new editor is highly flexible, like most of WordPress. You can build custom ## Creating Blocks -The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. +The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. -If you want to learn more about block creation, see the [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the best place to start. +If you want to learn more about block creation, see the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for the best place to start. ## Extending Blocks It is also possible to modify the behavior of existing blocks or even remove them completely using filters. -Learn more in the [Block Filters](/docs/designers-developers/developers/filters/block-filters.md) section. +Learn more in the [Block Filters](/docs/reference-guides/filters/block-filters.md) section. ## Extending the Editor UI @@ -20,26 +20,26 @@ Extending the editor UI can be accomplished with the `registerPlugin` API, allow Refer to the [Plugins](/packages/plugins/README.md) and [Edit Post](/packages/edit-post/README.md) section for more information. -You can also filter certain aspects of the editor; this is documented on the [Editor Filters](/docs/designers-developers/developers/filters/editor-filters.md) page. +You can also filter certain aspects of the editor; this is documented on the [Editor Filters](/docs/reference-guides/filters/editor-filters.md) page. ## Meta Boxes -Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/designers-developers/developers/tutorials/metabox/readme.md). +Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/howto-guides/metabox/readme.md). -See how the new editor [supports existing Meta Boxes](/docs/designers-developers/developers/backward-compatibility/meta-box.md). +See how the new editor [supports existing Meta Boxes](/docs/reference-guides/backward-compatibility/meta-box.md). ## Theme Support By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults. -There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/designers-developers/developers/themes/theme-support.md). +There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/howto-guides/themes/theme-support.md). ## Autocomplete -Autocompleters within blocks may be extended and overridden. Learn more about the [autocomplete](/docs/designers-developers/developers/filters/autocomplete-filters.md) filters. +Autocompleters within blocks may be extended and overridden. Learn more about the [autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) filters. ## Block Parsing and Serialization Posts in the editor move through a couple of different stages between being stored in `post_content` and appearing in the editor. Since the blocks themselves are data structures that live in memory it takes a parsing and serialization step to transform out from and into the stored format in the database. -Customizing the parser is an advanced topic that you can learn more about in the [Extending the Parser](/docs/designers-developers/developers/filters/parser-filters.md) section. +Customizing the parser is an advanced topic that you can learn more about in the [Extending the Parser](/docs/reference-guides/filters/parser-filters.md) section. diff --git a/docs/howto-guides/backward-compatibility/README.md b/docs/howto-guides/backward-compatibility/README.md index da58849dec322..82ede6ca49e0b 100644 --- a/docs/howto-guides/backward-compatibility/README.md +++ b/docs/howto-guides/backward-compatibility/README.md @@ -34,7 +34,7 @@ Production packages use the `wp` global variable to provide APIs to third-party * Existing usage of the block should not break or be marked as invalid when the editor is loaded. * The styling of the existing blocks should be guaranteed. -* Markup changes should be limited to the minimum possible, but if a block needs to change its saved markup, making previous versions invalid, a [**deprecated version**](/docs/designers-developers/developers/block-api/block-deprecation.md) of the block should be added. +* Markup changes should be limited to the minimum possible, but if a block needs to change its saved markup, making previous versions invalid, a [**deprecated version**](/docs/reference-guides/block-api/block-deprecation.md) of the block should be added. ## Class names and DOM updates diff --git a/docs/howto-guides/backward-compatibility/deprecations.md b/docs/howto-guides/backward-compatibility/deprecations.md index 89a937ad5459d..df0b5af1d781e 100644 --- a/docs/howto-guides/backward-compatibility/deprecations.md +++ b/docs/howto-guides/backward-compatibility/deprecations.md @@ -20,12 +20,12 @@ For features included in the Gutenberg plugin, the deprecation policy is intende ## 8.6.0 -- Block API integration with [Block Context](/docs/designers-developers/developers/block-api/block-context.md) was updated. When registering a block use `usesContext` and `providesContext` pair in JavaScript files and `uses_context` and `provides_context` pair in PHP files instead of previous pair `context` and `providesContext`. +- Block API integration with [Block Context](/docs/reference-guides/block-api/block-context.md) was updated. When registering a block use `usesContext` and `providesContext` pair in JavaScript files and `uses_context` and `provides_context` pair in PHP files instead of previous pair `context` and `providesContext`. ## 8.3.0 -- The PHP function `gutenberg_get_post_from_context` has been removed. Use [Block Context](/docs/designers-developers/developers/block-api/block-context.md) instead. -- The old Block Pattern APIs `register_pattern`/`unregister_pattern` have been removed. Use the [new functions](/docs/designers-developers/developers/block-api/block-patterns.md#register_block_pattern) instead. +- The PHP function `gutenberg_get_post_from_context` has been removed. Use [Block Context](/docs/reference-guides/block-api/block-context.md) instead. +- The old Block Pattern APIs `register_pattern`/`unregister_pattern` have been removed. Use the [new functions](/docs/reference-guides/block-api/block-patterns.md#register_block_pattern) instead. ## 5.5.0 @@ -293,6 +293,6 @@ For features included in the Gutenberg plugin, the deprecation policy is intende - `wp.blocks.BlockDescription` component removed. Please use the `description` block property instead. - `wp.blocks.InspectorControls.*` components removed. Please use `wp.components.*` components instead. -- `wp.blocks.source.*` matchers removed. Please use the declarative attributes instead. See [block attributes](/docs/designers-developers/developers/block-api/block-attributes.md) for more info. +- `wp.blocks.source.*` matchers removed. Please use the declarative attributes instead. See [block attributes](/docs/reference-guides/block-api/block-attributes.md) for more info. - `wp.data.select( 'selector', ...args )` removed. Please use `wp.data.select( reducerKey' ).*` instead. - `wp.blocks.MediaUploadButton` component removed. Please use `wp.blocks.MediaUpload` component instead. diff --git a/docs/howto-guides/backward-compatibility/meta-box.md b/docs/howto-guides/backward-compatibility/meta-box.md index dc8ce593eb856..56432fd80b56d 100644 --- a/docs/howto-guides/backward-compatibility/meta-box.md +++ b/docs/howto-guides/backward-compatibility/meta-box.md @@ -1,6 +1,6 @@ # Meta Boxes -This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. +This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/howto-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. ### Testing, Converting, and Maintaining Existing Meta Boxes diff --git a/docs/howto-guides/block-tutorial/README.md b/docs/howto-guides/block-tutorial/README.md index 42d72444e898e..b4b2b05a39dd2 100644 --- a/docs/howto-guides/block-tutorial/README.md +++ b/docs/howto-guides/block-tutorial/README.md @@ -4,6 +4,6 @@ The purpose of this tutorial is to step through the fundamentals of creating a n To follow along with this tutorial, you can [download the accompanying WordPress plugin](https://github.com/WordPress/gutenberg-examples) which includes all of the examples for you to try on your own site. At each step along the way, experiment by modifying the examples with your own ideas, and observe the effects they have on the block's behavior. -Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup/) to compile your code to a browser compatible format. +Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/howto-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. diff --git a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md index cc363293e31ea..443dce0e2477b 100644 --- a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md +++ b/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md @@ -5,11 +5,11 @@ Dynamic blocks are blocks that build their structure and content on the fly when There are two primary uses for dynamic blocks: 1. Blocks where content should change even if a post has not been updated. One example from WordPress itself is the Latest Posts block. This block will update everywhere it is used when a new post is published. -2. Blocks where updates to the code (HTML, CSS, JS) should be immediately shown on the front end of the website. For example, if you update the structure of a block by adding a new class, adding an HTML element, or changing the layout in any other way, using a dynamic block ensures those changes are applied immediately on all occurrences of that block across the site. (If a dynamic block is not used then when block code is updated Guterberg's [validation process](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) generally applies, causing users to see the validation message, "This block appears to have been modified externally"). +2. Blocks where updates to the code (HTML, CSS, JS) should be immediately shown on the front end of the website. For example, if you update the structure of a block by adding a new class, adding an HTML element, or changing the layout in any other way, using a dynamic block ensures those changes are applied immediately on all occurrences of that block across the site. (If a dynamic block is not used then when block code is updated Guterberg's [validation process](/docs/reference-guides/block-api/block-edit-save.md#validation) generally applies, causing users to see the validation message, "This block appears to have been modified externally"). -For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/designers-developers/developers/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. +For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/reference-guides/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. -If you are using [InnerBlocks](/docs/designers-developers/developers/tutorials/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` +If you are using [InnerBlocks](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` You can also save an HTML representation of the block. If you provide a server-side rendering callback, this HTML will be replaced with the output of your callback, but will be rendered if your block is deactivated or your render callback is removed. diff --git a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md index 281658ba508a6..e0ea9b6950233 100644 --- a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md +++ b/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md @@ -4,4 +4,4 @@ **Deprecated:** It is no longer recommended to use WP-CLI or create-guten-block to generate block scaffolding. -The official script to generate a block is the new [@wordpress/create-block](/packages/create-block/README.md) package. This package follows the new block directory guidelines, and creates the proper block, environment, and standards set by the project. See the new [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for a complete walk-through. +The official script to generate a block is the new [@wordpress/create-block](/packages/create-block/README.md) package. This package follows the new block directory guidelines, and creates the proper block, environment, and standards set by the project. See the new [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for a complete walk-through. diff --git a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md index e3696634992eb..8da80032db925 100644 --- a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md +++ b/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md @@ -18,7 +18,7 @@ One challenge of maintaining the representation of a block as a JavaScript objec }, ``` -When registering a new block type, the `attributes` property describes the shape of the attributes object you'd like to receive in the `edit` and `save` functions. Each value is a [source function](/docs/designers-developers/developers/block-api/block-attributes.md) to find the desired value from the markup of the block. +When registering a new block type, the `attributes` property describes the shape of the attributes object you'd like to receive in the `edit` and `save` functions. Each value is a [source function](/docs/reference-guides/block-api/block-attributes.md) to find the desired value from the markup of the block. In the code snippet above, when loading the editor, the `content` value will be extracted from the HTML of the paragraph element in the saved post's markup. @@ -26,7 +26,7 @@ In the code snippet above, when loading the editor, the `content` value will be Earlier examples used the `createElement` function to create DOM nodes, but it's also possible to encapsulate this behavior into "components". This abstraction helps you share common behaviors and hide complexity in self-contained units. -There are a number of [components available](/docs/designers-developers/developers/packages/packages-editor.md#components) to use in implementing your blocks. You can see one such component in the code below: the [`RichText` component](/docs/designers-developers/developers/packages/packages-editor.md#richtext) is part of the `wp-editor` package. +There are a number of [components available](/docs/reference-guides/packages/packages-editor.md#components) to use in implementing your blocks. You can see one such component in the code below: the [`RichText` component](/docs/reference-guides/packages/packages-editor.md#richtext) is part of the `wp-editor` package. The `RichText` component can be considered as a super-powered `textarea` element, enabling rich content editing including bold, italics, hyperlinks, etc. diff --git a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md index 87d98bd4f9e76..537e233a1645e 100644 --- a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md +++ b/docs/howto-guides/block-tutorial/writing-your-first-block-type.md @@ -36,7 +36,7 @@ function gutenberg_examples_01_register_block() { add_action( 'init', 'gutenberg_examples_01_register_block' ); ``` -Note the above example, shows using the [wp-scripts build step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup/) that automatically sets dependencies and versions the file. +Note the above example, shows using the [wp-scripts build step](/docs/howto-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. If you were using the ES5 code, you would specify `array( 'wp-blocks', 'wp-element' )` as the dependency array. See the [example 01](https://github.com/WordPress/gutenberg-examples/blob/HEAD/01-basic/index.php) in Gutenberg Examples repository for full syntax. @@ -123,7 +123,7 @@ registerBlockType( 'gutenberg-examples/example-01-basic-esnext', { _By now you should be able to see `Hello World, step 1 (from the editor).` in the admin side and `Hello World, step 1 (from the frontend).` on the frontend side._ -Once a block is registered, you should immediately see that it becomes available as an option in the editor inserter dialog, using values from `title`, `icon`, and `category` to organize its display. You can choose an icon from any included in the built-in [Dashicons icon set](https://developer.wordpress.org/resource/dashicons/), or provide a [custom svg element](/docs/designers-developers/developers/block-api/block-registration.md#icon-optional). +Once a block is registered, you should immediately see that it becomes available as an option in the editor inserter dialog, using values from `title`, `icon`, and `category` to organize its display. You can choose an icon from any included in the built-in [Dashicons icon set](https://developer.wordpress.org/resource/dashicons/), or provide a [custom svg element](/docs/reference-guides/block-api/block-registration.md#icon-optional). A block name must be prefixed with a namespace specific to your plugin. This helps prevent conflicts when more than one plugin registers a block with the same name. In this example, the namespace is `gutenberg-examples`. diff --git a/docs/howto-guides/designers/block-design.md b/docs/howto-guides/designers/block-design.md index 8ec0d4649e187..233d0476fa9fe 100644 --- a/docs/howto-guides/designers/block-design.md +++ b/docs/howto-guides/designers/block-design.md @@ -76,7 +76,7 @@ Avoid long, multi-line block names. Every block should include a description that clearly explains the block's function. The description will display in the Settings Sidebar. -You can add a description by using the description attribute in the [registerBlockType function](/docs/designers-developers/developers/block-api/block-registration.md). +You can add a description by using the description attribute in the [registerBlockType function](/docs/reference-guides/block-api/block-registration.md). Stick to a single imperative sentence with an action + subject format. Examples: @@ -132,7 +132,7 @@ Check how your block looks, feels, and works on as many devices and screen sizes ### Support Gutenberg's dark background editor scheme -Check how your block looks with [dark backgrounds](/docs/designers-developers/developers/themes/theme-support.md#dark-backgrounds) in the editor. +Check how your block looks with [dark backgrounds](/docs/howto-guides/themes/theme-support.md#dark-backgrounds) in the editor. ## Examples diff --git a/docs/howto-guides/format-api/3-apply-format.md b/docs/howto-guides/format-api/3-apply-format.md index 53e72e3ceba18..25dd678114eeb 100644 --- a/docs/howto-guides/format-api/3-apply-format.md +++ b/docs/howto-guides/format-api/3-apply-format.md @@ -71,4 +71,4 @@ The expected behavior is that the format will be toggled, meaning that the text Your browser may have already displayed the selection differently once the tag was applied, but you may want to use a special style of your own. You can use the `className` option in [`registerFormatType`](/packages/rich-text/README.md#registerFormatType) to target the new element by class name: if `className` is set, it'll be added to the new element. -That's it. This is all that is necessary to make a custom format available in the new editor. From here, you may want to check out other [tutorials](/docs/designers-developers/developers/tutorials/) or apply your new knowledge to your next plugin! +That's it. This is all that is necessary to make a custom format available in the new editor. From here, you may want to check out other [tutorials](/docs/getting-started/tutorials/) or apply your new knowledge to your next plugin! diff --git a/docs/howto-guides/format-api/README.md b/docs/howto-guides/format-api/README.md index 3ecb76c07e059..74b742db7bebd 100644 --- a/docs/howto-guides/format-api/README.md +++ b/docs/howto-guides/format-api/README.md @@ -4,10 +4,10 @@ The purpose of this tutorial is to introduce you to the Format API. The Format A In WordPress lingo, a _format_ is a [HTML tag with text-level semantics](https://www.w3.org/TR/html5/textlevel-semantics.html#text-level-semantics-usage-summary) used to give some special meaning to a text selection. For example, in this tutorial, the button to be hooked into the format toolbar will let users wrap a particular text selection with the [`` HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp). -If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) first. +If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) first. ## Table of Contents -1. [Register a new format](/docs/designers-developers/developers/tutorials/format-api/1-register-format.md) -2. [Add a button to the toolbar](/docs/designers-developers/developers/tutorials/format-api/2-toolbar-button.md) -3. [Apply the format when the button is clicked](/docs/designers-developers/developers/tutorials/format-api/3-apply-format.md) +1. [Register a new format](/docs/howto-guides/format-api/1-register-format.md) +2. [Add a button to the toolbar](/docs/howto-guides/format-api/2-toolbar-button.md) +3. [Apply the format when the button is clicked](/docs/howto-guides/format-api/3-apply-format.md) diff --git a/docs/howto-guides/internationalization.md b/docs/howto-guides/internationalization.md index 28d810db117fc..65ad0e204b680 100644 --- a/docs/howto-guides/internationalization.md +++ b/docs/howto-guides/internationalization.md @@ -273,4 +273,4 @@ With the language set, create a new post, add the block, and you will see the tr ### Filtering Translations -The outputs of the translation functions (`__()`, `_x()`, `_n()`, and `_nx()`) are filterable, see [i18n Filters](/docs/designers-developers/developers/filters/i18n-filters.md) for full information. +The outputs of the translation functions (`__()`, `_x()`, `_n()`, and `_nx()`) are filterable, see [i18n Filters](/docs/reference-guides/filters/i18n-filters.md) for full information. diff --git a/docs/howto-guides/javascript/README.md b/docs/howto-guides/javascript/README.md index c0a80e1b3e20c..b505191c791be 100644 --- a/docs/howto-guides/javascript/README.md +++ b/docs/howto-guides/javascript/README.md @@ -10,11 +10,11 @@ The block editor introduced in WordPress 5.0 is written in JavaScript, with the ### Table of Contents -1. [Plugins Background](/docs/designers-developers/developers/tutorials/javascript/plugins-background.md) -2. [Loading JavaScript](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) -3. [Extending the Block Editor](/docs/designers-developers/developers/tutorials/javascript/extending-the-block-editor.md) -4. [Troubleshooting](/docs/designers-developers/developers/tutorials/javascript/troubleshooting.md) -5. [JavaScript Versions and Building](/docs/designers-developers/developers/tutorials/javascript/versions-and-building.md) -6. [Scope your code](/docs/designers-developers/developers/tutorials/javascript/scope-your-code.md) -7. [JavaScript Build Step](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) -8. [ESNext Syntax](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) +1. [Plugins Background](/docs/howto-guides/javascript/plugins-background.md) +2. [Loading JavaScript](/docs/howto-guides/javascript/loading-javascript.md) +3. [Extending the Block Editor](/docs/howto-guides/javascript/extending-the-block-editor.md) +4. [Troubleshooting](/docs/howto-guides/javascript/troubleshooting.md) +5. [JavaScript Versions and Building](/docs/howto-guides/javascript/versions-and-building.md) +6. [Scope your code](/docs/howto-guides/javascript/scope-your-code.md) +7. [JavaScript Build Step](/docs/howto-guides/javascript/js-build-setup.md) +8. [ESNext Syntax](/docs/howto-guides/javascript/esnext-js.md) diff --git a/docs/howto-guides/javascript/extending-the-block-editor.md b/docs/howto-guides/javascript/extending-the-block-editor.md index 9ee0b5e03c86d..0609d78aa958e 100644 --- a/docs/howto-guides/javascript/extending-the-block-editor.md +++ b/docs/howto-guides/javascript/extending-the-block-editor.md @@ -1,6 +1,6 @@ # Extending the Block Editor -Let's look at using the [Block Style Variation example](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) to extend the editor. This example allows you to add your own custom CSS class name to any core block type. +Let's look at using the [Block Style Variation example](/docs/reference-guides/filters/block-filters.md#block-style-variations) to extend the editor. This example allows you to add your own custom CSS class name to any core block type. Replace the existing `console.log()` code in your `myguten.js` file with: @@ -30,7 +30,7 @@ add_action( 'enqueue_block_editor_assets', 'myguten_enqueue' ); The last argument in the `wp_enqueue_script()` function is an array of dependencies. WordPress makes packages available under the `wp` namespace. In the example, you use `wp.blocks` to access the items that the blocks package exports (in this case the `registerBlockStyle()` function). -See [Packages](/docs/designers-developers/developers/packages.md) for list of available packages and what objects they export. +See [Packages](/docs/reference-guides/packages.md) for list of available packages and what objects they export. After you have updated both JavaScript and PHP files, go to the block editor and create a new post. diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md index a1d3c9183aae7..1c3e3f314dc3a 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/howto-guides/javascript/js-build-setup.md @@ -2,7 +2,7 @@ ESNext is JavaScript written using syntax and features only available in a version newer than browser support—the support browser versions is referred to as ECMAScript 5 (ES5). [JSX](https://reactjs.org/docs/introducing-jsx.html) is a custom syntax extension to JavaScript, created by React project, that allows you to write JavaScript using a familiar HTML tag-like syntax. -See the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/getting-started.md) documentation. @@ -34,7 +34,7 @@ First, you need to set up Node.js for your development environment. The steps re - macOS: `brew install node` - Windows: `choco install node` -If you are not using a package manager, see the [developer environment setup documentation](/docs/designers-developers/developers/tutorials/devenv/readme.md) for setting up Node using nvm, or see the official [Node.js download page](https://nodejs.org/en/download/) for installers and binaries. +If you are not using a package manager, see the [developer environment setup documentation](/docs/getting-started/tutorials/devenv/readme.md) for setting up Node using nvm, or see the official [Node.js download page](https://nodejs.org/en/download/) for installers and binaries. **Note:** The build tools and process occur on the command-line, so basic familiarity using a terminal application is required. Some text editors have a terminal built-in that is fine to use; Visual Studio Code and PhpStorm are two popular options. @@ -125,7 +125,7 @@ To configure npm to run a script, you use the scripts section in `package.json` You can then run the build using: `npm run build`. -After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md), and the block will load in the editor. +After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/howto-guides/javascript/loading-javascript.md), and the block will load in the editor. ## Development Mode diff --git a/docs/howto-guides/javascript/troubleshooting.md b/docs/howto-guides/javascript/troubleshooting.md index cd601db316bce..bb2bc57fd5633 100644 --- a/docs/howto-guides/javascript/troubleshooting.md +++ b/docs/howto-guides/javascript/troubleshooting.md @@ -55,7 +55,7 @@ If you are not seeing your changes, and no errors, check that your JavaScript fi If you do not see the file being loaded, double check the enqueue function is correct. You can also check your server logs to see if there is an error messages. -Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. +Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/howto-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. ## Confirm all dependencies are loading @@ -73,4 +73,4 @@ wp_enqueue_script( ); ``` -For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md#dependency-management). +For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/howto-guides/javascript/js-build-setup.md#dependency-management). diff --git a/docs/howto-guides/javascript/versions-and-building.md b/docs/howto-guides/javascript/versions-and-building.md index ccd02f71aca0b..9c13413d4b813 100644 --- a/docs/howto-guides/javascript/versions-and-building.md +++ b/docs/howto-guides/javascript/versions-and-building.md @@ -10,6 +10,6 @@ Additionally, the ESNext code examples in the handbook include [JSX syntax](http For simplicity, the JavaScript tutorial uses the ES5 definition, without JSX. This code can run straight in your browser and does not require an additional build step. In many cases, it is perfectly fine to follow the same approach for simple plugins or experimenting. As your codebase grows in complexity it might be a good idea to switch to ESNext. You will find the majority of code and documentation across the block editor uses ESNext. -See the [JavaScript Build Setup documentation](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. +See the [JavaScript Build Setup documentation](/docs/howto-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. -See the [ESNext syntax documentation](/docs/designers-developers/developers/tutorials/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. diff --git a/docs/howto-guides/metabox/README.md b/docs/howto-guides/metabox/README.md index a1e29fb2beeff..47c071489f00e 100644 --- a/docs/howto-guides/metabox/README.md +++ b/docs/howto-guides/metabox/README.md @@ -2,7 +2,7 @@ Prior to the block editor, custom meta boxes were used to extend the editor. With the new editor there are new ways to extend, giving more power to the developer and a better experience for the authors. Porting older custom meta boxes to one of these new methods is encouraged as to create a more unified and consistent experience for those using the editor. -The new block editor does support most existing meta boxes, see [this backward compatibility article](/docs/designers-developers/developers/backward-compatibility/meta-box.md) for more support details . +The new block editor does support most existing meta boxes, see [this backward compatibility article](/docs/reference-guides/backward-compatibility/meta-box.md) for more support details . Here are two mini-tutorials for creating similar functionality to meta boxes in the block editor. @@ -10,9 +10,9 @@ Here are two mini-tutorials for creating similar functionality to meta boxes in The first method is to use Blocks to store extra data with a post. The data is stored in a post meta field, similar to how meta boxes store information. -* [Store Post Meta with a Block](/docs/designers-developers/developers/tutorials/metabox/meta-block-1-intro.md) +* [Store Post Meta with a Block](/docs/howto-guides/metabox/meta-block-1-intro.md) ## Sidebar Plugin -If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/designers-developers/developers/tutorials/plugin-sidebar-0/). +If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md/). diff --git a/docs/howto-guides/metabox/meta-block-1-intro.md b/docs/howto-guides/metabox/meta-block-1-intro.md index ce001938ecfa6..1a02e4ec6fad1 100644 --- a/docs/howto-guides/metabox/meta-block-1-intro.md +++ b/docs/howto-guides/metabox/meta-block-1-intro.md @@ -6,12 +6,12 @@ In this short tutorial you will create one of these blocks, which will prompt a For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/architecture/key-concepts.md) of the handbook. -Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/readme.md) for information setting up a plugin. +Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/howto-guides/javascript/readme.md) for information setting up a plugin. ## Table of Contents -1. [Register Meta Field](/docs/designers-developers/developers/tutorials/metabox/meta-block-2-register-meta.md) -2. [Add Meta Block](/docs/designers-developers/developers/tutorials/metabox/meta-block-3-add.md) -3. [Use Post Meta Data](/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md) -4. [Finishing Touches](/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md) +1. [Register Meta Field](/docs/howto-guides/metabox/meta-block-2-register-meta.md) +2. [Add Meta Block](/docs/howto-guides/metabox/meta-block-3-add.md) +3. [Use Post Meta Data](/docs/howto-guides/metabox/meta-block-4-use-data.md) +4. [Finishing Touches](/docs/howto-guides/metabox/meta-block-5-finishing.md) diff --git a/docs/howto-guides/metabox/meta-block-3-add.md b/docs/howto-guides/metabox/meta-block-3-add.md index 621447015aa93..ae88a63e17e3b 100644 --- a/docs/howto-guides/metabox/meta-block-3-add.md +++ b/docs/howto-guides/metabox/meta-block-3-add.md @@ -1,6 +1,6 @@ # Create Meta Block -With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/designers-developers/developers/tutorials/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. +With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. For this block, you will use the TextControl component, which is similar to an HTML input text field. For additional components, check out the [Component Reference](/packages/components/README.md). @@ -138,4 +138,4 @@ You can now edit a draft post and add a Meta Block to the post. You will see you ![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) -You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/designers-developers/developers/tutorials/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. +You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/howto-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/howto-guides/metabox/meta-block-5-finishing.md b/docs/howto-guides/metabox/meta-block-5-finishing.md index b8f41f104b8c8..a5b02757ccaa9 100644 --- a/docs/howto-guides/metabox/meta-block-5-finishing.md +++ b/docs/howto-guides/metabox/meta-block-5-finishing.md @@ -1,6 +1,6 @@ # Finishing Touches -One problem using a meta block is the block is easy for an author to forget, since it requires being added to each post. You solve this by using [block templates](/docs/designers-developers/developers/block-api/block-templates.md). A block template is a predefined list of block items per post type. Templates allow you to specify a default initial state for a post type. +One problem using a meta block is the block is easy for an author to forget, since it requires being added to each post. You solve this by using [block templates](/docs/reference-guides/block-api/block-templates.md). A block template is a predefined list of block items per post type. Templates allow you to specify a default initial state for a post type. For this example, you use a template to automatically insert the meta block at the top of a post. diff --git a/docs/howto-guides/notices/README.md b/docs/howto-guides/notices/README.md index 5761139266942..7bef4e05911ec 100644 --- a/docs/howto-guides/notices/README.md +++ b/docs/howto-guides/notices/README.md @@ -71,10 +71,10 @@ To better understand the specific code example above: * `wp.data.dispatch('core/notices')` accesses functionality registered to the block editor data store by the Notices package. * `createNotice()` is a function offered by the Notices package to register a new notice. The block editor reads from the notice data store in order to know which notices to display. -Check out the [_Loading JavaScript_](/docs/designers-developers/developers/tutorials/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. +Check out the [_Loading JavaScript_](/docs/howto-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. ## Learn More The block editor offers a complete API for generating notices. The official documentation is a great place to review what's possible. -For a full list of the available actions and selectors, refer to the [Notices Data Handbook](/docs/designers-developers/developers/data/data-core-notices.md) page. +For a full list of the available actions and selectors, refer to the [Notices Data Handbook](/docs/reference-guides/data/data-core-notices.md) page. diff --git a/docs/howto-guides/platform/README.md b/docs/howto-guides/platform/README.md index cf19d6f05e7f0..67e909a5cad60 100644 --- a/docs/howto-guides/platform/README.md +++ b/docs/howto-guides/platform/README.md @@ -60,5 +60,5 @@ You can also play with the [Gutenberg Example #03](https://github.com/WordPress/ The [`@wordpress/block-editor` package](https://developer.wordpress.org/block-editor/packages/packages-block-editor/) allows you to create and use standalone block editors. -You can learn more by reading the [tutorial "Building a custom block editor"](/docs/designers-developers/developers/platform/custom-block-editor/README.md). +You can learn more by reading the [tutorial "Building a custom block editor"](/docs/reference-guides/platform/custom-block-editor/README.md). diff --git a/docs/howto-guides/platform/custom-block-editor/README.md b/docs/howto-guides/platform/custom-block-editor/README.md index adfb0dcc92147..65623044f31d5 100644 --- a/docs/howto-guides/platform/custom-block-editor/README.md +++ b/docs/howto-guides/platform/custom-block-editor/README.md @@ -1,6 +1,6 @@ # Building a custom block editor -The purpose of [this tutorial](/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md) is to step through the fundamentals of creating a custom instance of a "block editor". +The purpose of [this tutorial](/docs/reference-guides/platform/custom-block-editor/tutorial.md) is to step through the fundamentals of creating a custom instance of a "block editor". ![alt text](https://wordpress.org/gutenberg/files/2020/03/editor.png "The Standalone Editor instance populated with example Blocks within a custom WP Admin page.") @@ -15,4 +15,4 @@ Code snippets are provided in "ESNext". ESNext refers to the next versions of th Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. -* [Start custom block editor tutorial](/docs/designers-developers/developers/platform/custom-block-editor/tutorial.md) +* [Start custom block editor tutorial](/docs/reference-guides/platform/custom-block-editor/tutorial.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md index f5f270cc9c533..47978feeb0ec9 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md @@ -1,12 +1,12 @@ # Creating a Sidebar for Your Plugin -This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/designers-developers/developers/tutorials/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. +This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/howto-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. -1. [Get a sidebar up and running](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) -2. [Tweak the sidebar style and add controls](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) -3. [Register a new meta field](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-3-register-meta.md) -4. [Initialize the input control with the meta field value](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) -5. [Update the meta field value when input's content changes](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-5-update-meta.md) -6. [Finishing touches](/docs/designers-developers/developers/tutorials/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) +1. [Get a sidebar up and running](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) +2. [Tweak the sidebar style and add controls](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) +3. [Register a new meta field](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) +4. [Initialize the input control with the meta field value](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) +5. [Update the meta field value when input's content changes](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) +6. [Finishing touches](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md index 84894b9335ef6..17fdc3cad62de 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md @@ -1,6 +1,6 @@ # Get a Sidebar up and Running -The first step in the journey is to tell the editor that there is a new plugin that will have its own sidebar. You can do so by using the [registerPlugin](/packages/plugins/README.md), [PluginSidebar](/packages/edit-post/README.md#pluginsidebar), and [createElement](/packages/element/README.md) utilities provided by WordPress, to be found in the `@wordpress/plugins`, `@wordpress/edit-post`, and `@wordpress/element` [packages](/docs/designers-developers/developers/packages.md), respectively. +The first step in the journey is to tell the editor that there is a new plugin that will have its own sidebar. You can do so by using the [registerPlugin](/packages/plugins/README.md), [PluginSidebar](/packages/edit-post/README.md#pluginsidebar), and [createElement](/packages/element/README.md) utilities provided by WordPress, to be found in the `@wordpress/plugins`, `@wordpress/edit-post`, and `@wordpress/element` [packages](/docs/reference-guides/packages.md), respectively. Add the following code to a JavaScript file called `plugin-sidebar.js` and save it within your plugin's directory: diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md index afa859da1e35c..fc1e15024a85a 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md @@ -12,7 +12,7 @@ register_post_meta( 'post', 'sidebar_plugin_meta_block_field', array( ) ); ``` -To make sure the field has been loaded, query the block editor [internal data structures](/docs/designers-developers/developers/data/), also known as _stores_. Open your browser's console, and execute this piece of code: +To make sure the field has been loaded, query the block editor [internal data structures](/docs/reference-guides/data/), also known as _stores_. Open your browser's console, and execute this piece of code: ```js wp.data.select( 'core/editor' ).getCurrentPost().meta; diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md index bc602e39b2798..94e7e52db98cc 100644 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md +++ b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md @@ -105,7 +105,7 @@ This is how the code changes from the previous section: * The `MetaBlockField` function has now a `props` argument as input. It contains the data object returned by the `mapSelectToProps` function, which it uses to initialize its value property. * The component rendered within the `div` element was also updated, the plugin now uses `MetaBlockFieldWithData`. This will be updated every time the original data changes. -* [getEditedPostAttribute](/docs/designers-developers/developers/data/data-core-editor.md#geteditedpostattribute) is used to retrieve data instead of [getCurrentPost](/docs/designers-developers/developers/data/data-core-editor.md#getcurrentpost) because it returns the most recent values of the post, including user editions that haven't been yet saved. +* [getEditedPostAttribute](/docs/reference-guides/data/data-core-editor.md#geteditedpostattribute) is used to retrieve data instead of [getCurrentPost](/docs/reference-guides/data/data-core-editor.md#getcurrentpost) because it returns the most recent values of the post, including user editions that haven't been yet saved. Update the code and open the sidebar. The input's content is no longer `Initial value` but a void string. Users can't type values yet, but let's check that the component is updated if the value in the store changes. Open the browser's console, execute diff --git a/docs/howto-guides/themes/block-based-themes.md b/docs/howto-guides/themes/block-based-themes.md index 5d2eb2f825ec8..c2894b72c2717 100644 --- a/docs/howto-guides/themes/block-based-themes.md +++ b/docs/howto-guides/themes/block-based-themes.md @@ -31,7 +31,7 @@ theme |__ ... ``` -The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/designers-developers/developers/themes/theme-json.md) file for some styles. +The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/howto-guides/themes/theme-json.md) file for some styles. ## What is a block template? @@ -126,7 +126,7 @@ As we're still early in the process, the number of blocks specifically dedicated ## Styling -One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/designers-developers/developers/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. +One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/howto-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. ## Resources diff --git a/docs/howto-guides/themes/theme-support.md b/docs/howto-guides/themes/theme-support.md index 50497c0a59e52..66607e3264e32 100644 --- a/docs/howto-guides/themes/theme-support.md +++ b/docs/howto-guides/themes/theme-support.md @@ -360,7 +360,7 @@ To change the main column width of the editor, add the following CSS to `style-e You can use those editor widths to match those in your theme. You can use any CSS width unit, including `%` or `px`. -Further reading: [Applying Styles with Stylesheets](/docs/designers-developers/developers/tutorials/block-tutorial/applying-styles-with-stylesheets.md). +Further reading: [Applying Styles with Stylesheets](/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md). ## Responsive embedded content diff --git a/docs/reference-guides/block-api/README.md b/docs/reference-guides/block-api/README.md index 790e694aa65ba..753ba459c8919 100644 --- a/docs/reference-guides/block-api/README.md +++ b/docs/reference-guides/block-api/README.md @@ -4,15 +4,15 @@ Blocks are the fundamental element of the editor. They are the primary way in wh The following sections will walk you through the existing block APIs: -- [Block registration](/docs/designers-developers/developers/block-api/block-registration.md) -- [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) -- [Attributes](/docs/designers-developers/developers/block-api/block-attributes.md) -- [Context](/docs/designers-developers/developers/block-api/block-context.md) -- [Deprecation](/docs/designers-developers/developers/block-api/block-deprecation.md) -- [Supports](/docs/designers-developers/developers/block-api/block-supports.md) -- [Transformations](/docs/designers-developers/developers/block-api/block-transforms.md) -- [Templates](/docs/designers-developers/developers/block-api/block-templates.md) -- [Metadata](/docs/designers-developers/developers/block-api/block-metadata.md) -- [Block Patterns](/docs/designers-developers/developers/block-api/block-patterns.md) -- [Annotations](/docs/designers-developers/developers/block-api/block-annotations.md) -- [Versions](/docs/designers-developers/developers/block-api/versions.md) +- [Block registration](/docs/reference-guides/block-api/block-registration.md) +- [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) +- [Attributes](/docs/reference-guides/block-api/block-attributes.md) +- [Context](/docs/reference-guides/block-api/block-context.md) +- [Deprecation](/docs/reference-guides/block-api/block-deprecation.md) +- [Supports](/docs/reference-guides/block-api/block-supports.md) +- [Transformations](/docs/reference-guides/block-api/block-transforms.md) +- [Templates](/docs/reference-guides/block-api/block-templates.md) +- [Metadata](/docs/reference-guides/block-api/block-metadata.md) +- [Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Annotations](/docs/reference-guides/block-api/block-annotations.md) +- [Versions](/docs/reference-guides/block-api/versions.md) diff --git a/docs/reference-guides/block-api/block-attributes.md b/docs/reference-guides/block-api/block-attributes.md index dd482fd49e5c9..b5cdb3399b338 100644 --- a/docs/reference-guides/block-api/block-attributes.md +++ b/docs/reference-guides/block-api/block-attributes.md @@ -20,7 +20,7 @@ See [WordPress's REST API documentation](https://developer.wordpress.org/rest-ap Attribute sources are used to define how the block attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block. -If no attribute source is specified, the attribute will be saved to (and read from) the block's [comment delimiter](/docs/designers-developers/key-concepts.md#delimiters-and-parsing-expression-grammar). +If no attribute source is specified, the attribute will be saved to (and read from) the block's [comment delimiter](/docs/getting-started/architecture/key-concepts.md#delimiters-and-parsing-expression-grammar). The keys specified in the attributes source object are named as you see fit. The result of the attribute source definition is assigned as a value to each key. diff --git a/docs/reference-guides/block-api/block-deprecation.md b/docs/reference-guides/block-api/block-deprecation.md index f998a428857d3..e15f1a76cde0d 100644 --- a/docs/reference-guides/block-api/block-deprecation.md +++ b/docs/reference-guides/block-api/block-deprecation.md @@ -37,9 +37,9 @@ It is also recommended to keep [fixtures](https://github.com/WordPress/gutenberg Deprecations are defined on a block type as its `deprecated` property, an array of deprecation objects where each object takes the form: -- `attributes` (Object): The [attributes definition](/docs/designers-developers/developers/block-api/block-attributes.md) of the deprecated form of the block. -- `supports` (Object): The [supports definition](/docs/designers-developers/developers/block-api/block-registration.md) of the deprecated form of the block. -- `save` (Function): The [save implementation](/docs/designers-developers/developers/block-api/block-edit-save.md) of the deprecated form of the block. +- `attributes` (Object): The [attributes definition](/docs/reference-guides/block-api/block-attributes.md) of the deprecated form of the block. +- `supports` (Object): The [supports definition](/docs/reference-guides/block-api/block-registration.md) of the deprecated form of the block. +- `save` (Function): The [save implementation](/docs/reference-guides/block-api/block-edit-save.md) of the deprecated form of the block. - `migrate` (Function, Optional): A function which, given the old attributes and inner blocks is expected to return either the new attributes or a tuple array of `[ attributes, innerBlocks ]` compatible with the block. As mentioned above, a deprecation's `migrate` will not be run if its `save` function does not return a valid block so you will need to make sure your migrations are available in all the deprecations where they are relevant. - `isEligible` (Function, Optional): A function which, given the attributes and inner blocks of the parsed block, returns true if the deprecation can handle the block migration even if the block is valid. This is particularly useful in cases where a block is technically valid even once deprecated, and requires updates to its attributes or inner blocks. This function is not called when the results of all previous deprecations' `save` functions were invalid. diff --git a/docs/reference-guides/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md index a1a3765996390..17dbd38cbff41 100644 --- a/docs/reference-guides/block-api/block-edit-save.md +++ b/docs/reference-guides/block-api/block-edit-save.md @@ -92,7 +92,7 @@ var blockSettings = { The `edit` function also receives a number of properties through an object argument. You can use these properties to adapt the behavior of your block. -The `attributes` property surfaces all the available attributes and their corresponding values, as described by the `attributes` property when the block type was registered. See [attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for how to specify attribute sources. +The `attributes` property surfaces all the available attributes and their corresponding values, as described by the `attributes` property when the block type was registered. See [attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for how to specify attribute sources. In this case, assuming we had defined an attribute of `content` during block registration, we would receive and use that value in our edit function: @@ -285,10 +285,10 @@ _Note:_ The save function should be a pure function that depends only on the att It can not have any side effect or retrieve information from another source, e.g. it is not possible to use the data module inside it `select( store ).selector( ... )`. This is because if the external information changes, the block may be flagged as invalid when the post is later edited ([read more about Validation](#validation)). If there is a need to have other information as part of the save, developers can consider one of these two alternatives: - - Use [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. + - Use [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. - Store the external value as an attribute which is dynamically updated in the block's `edit` function as changes occur. -For [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. +For [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. If left unspecified, the default implementation will save no markup in post content for the dynamic block, instead deferring this to always be calculated when the block is shown on the front of the site. @@ -324,11 +324,11 @@ save: function( props ) { {% end %} -When saving your block, you want to save the attributes in the same format specified by the attribute source definition. If no attribute source is specified, the attribute will be saved to the block's comment delimiter. See the [Block Attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for more details. +When saving your block, you want to save the attributes in the same format specified by the attribute source definition. If no attribute source is specified, the attribute will be saved to the block's comment delimiter. See the [Block Attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for more details. ## Examples -Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/designers-developers/developers/tutorials/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. +Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. ### Saving Attributes to Child Elements @@ -504,10 +504,10 @@ The two most common sources of block invalidations are: Before starting to debug, be sure to familiarize yourself with the validation step described above documenting the process for detecting whether a block is invalid. A block is invalid if its regenerated markup does not match what is saved in post content, so often this can be caused by the attributes of a block being parsed incorrectly from the saved content. -If you're using [attribute sources](/docs/designers-developers/developers/block-api/block-attributes.md), be sure that attributes sourced from markup are saved exactly as you expect, and in the correct type (usually a `'string'` or `'number'`). +If you're using [attribute sources](/docs/reference-guides/block-api/block-attributes.md), be sure that attributes sourced from markup are saved exactly as you expect, and in the correct type (usually a `'string'` or `'number'`). When a block is detected as invalid, a warning will be logged into your browser's developer tools console. The warning will include specific details about the exact point at which a difference in markup occurred. Be sure to look closely at any differences in the expected and actual markups to see where problems are occurring. **I've changed my block's `save` behavior and old content now includes invalid blocks. How can I fix this?** -Refer to the guide on [Deprecated Blocks](/docs/designers-developers/developers/block-api/block-deprecation.md) to learn more about how to accommodate legacy content in intentional markup changes. +Refer to the guide on [Deprecated Blocks](/docs/reference-guides/block-api/block-deprecation.md) to learn more about how to accommodate legacy content in intentional markup changes. diff --git a/docs/reference-guides/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md index 182283fdaa1a9..a3c115f23773b 100644 --- a/docs/reference-guides/block-api/block-metadata.md +++ b/docs/reference-guides/block-api/block-metadata.md @@ -50,7 +50,7 @@ To register a new block type using metadata that can be shared between codebase } ``` -The same file is also used when [submitting block to Block Directory](/docs/designers-developers/developers/tutorials/create-block/submitting-to-block-directory.md). +The same file is also used when [submitting block to Block Directory](/docs/getting-started/tutorials/create-block/submitting-to-block-directory.md). ## Server-side registration @@ -130,7 +130,7 @@ The core provided categories are: - widgets - embed -Plugins and Themes can also register [custom block categories](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). +Plugins and Themes can also register [custom block categories](/docs/reference-guides/filters/block-filters.md#managing-block-categories). An implementation should expect and tolerate unknown categories, providing some reasonable fallback behavior (e.g. a "text" category). @@ -232,7 +232,7 @@ The [gettext](https://www.gnu.org/software/gettext/) text domain of the plugin/b Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface. -See the [the attributes documentation](/docs/designers-developers/developers/block-api/block-attributes.md) for more details. +See the [the attributes documentation](/docs/reference-guides/block-api/block-attributes.md) for more details. ### Provides Context @@ -244,7 +244,7 @@ See the [the attributes documentation](/docs/designers-developers/developers/blo Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block's own attribute. -See [the block context documentation](/docs/designers-developers/developers/block-api/block-context.md) for more details. +See [the block context documentation](/docs/reference-guides/block-api/block-context.md) for more details. ```json { @@ -264,7 +264,7 @@ See [the block context documentation](/docs/designers-developers/developers/bloc Array of the names of context values to inherit from an ancestor provider. -See [the block context documentation](/docs/designers-developers/developers/block-api/block-context.md) for more details. +See [the block context documentation](/docs/reference-guides/block-api/block-context.md) for more details. ```json { @@ -280,7 +280,7 @@ See [the block context documentation](/docs/designers-developers/developers/bloc - Property: `supports` - Default: `{}` -It contains as set of options to control features used in the editor. See the [the supports documentation](/docs/designers-developers/developers/block-api/block-supports.md) for more details. +It contains as set of options to control features used in the editor. See the [the supports documentation](/docs/reference-guides/block-api/block-supports.md) for more details. ### Style Variations @@ -301,7 +301,7 @@ It contains as set of options to control features used in the editor. See the [t Block styles can be used to provide alternative styles to block. It works by adding a class name to the block's wrapper. Using CSS, a theme developer can target the class name for the style variation if it is selected. -Plugins and Themes can also register [custom block style](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) for existing blocks. +Plugins and Themes can also register [custom block style](/docs/reference-guides/filters/block-filters.md#block-style-variations) for existing blocks. ### Example @@ -322,7 +322,7 @@ Plugins and Themes can also register [custom block style](/docs/designers-develo It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block. -See the [the example documentation](/docs/designers-developers/developers/block-api/block-registration.md#example-optional) for more details. +See the [the example documentation](/docs/reference-guides/block-api/block-registration.md#example-optional) for more details. ### Editor Script @@ -471,10 +471,10 @@ Once all details are ready, Core Blocks will be migrated iteratively and third-p The following properties are going to be supported for backward compatibility reasons on the client-side only. Some of them might be replaced with alternative APIs in the future: -- `edit` - see the [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) documentation for more details. -- `save` - see the [Edit and Save](/docs/designers-developers/developers/block-api/block-edit-save.md) documentation for more details. -- `transforms` - see the [Transforms](/docs/designers-developers/developers/block-api/block-registration.md#transforms-optional) documentation for more details. -- `deprecated` - see the [Deprecated Blocks](/docs/designers-developers/developers/block-api/block-deprecation.md) documentation for more details. +- `edit` - see the [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) documentation for more details. +- `save` - see the [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) documentation for more details. +- `transforms` - see the [Transforms](/docs/reference-guides/block-api/block-registration.md#transforms-optional) documentation for more details. +- `deprecated` - see the [Deprecated Blocks](/docs/reference-guides/block-api/block-deprecation.md) documentation for more details. - `merge` - undocumented as of today. Its role is to handle merging multiple blocks into one. - `getEditWrapperProps` - undocumented as well. Its role is to inject additional props to the block edit's component wrapper. @@ -494,4 +494,4 @@ wp.blocks.registerBlockType( 'my-block/name', { } ); ``` -In the case of [dynamic blocks](/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. +In the case of [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. diff --git a/docs/reference-guides/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md index cc184fbf945b0..ffebee4a48800 100644 --- a/docs/reference-guides/block-api/block-registration.md +++ b/docs/reference-guides/block-api/block-registration.md @@ -67,7 +67,7 @@ The core provided categories are: category: 'widgets', ``` -Plugins and Themes can also register [custom block categories](/docs/designers-developers/developers/filters/block-filters.md#managing-block-categories). +Plugins and Themes can also register [custom block categories](/docs/reference-guides/filters/block-filters.md#managing-block-categories). #### icon (optional) @@ -138,7 +138,7 @@ styles: [ ], ``` -Plugins and Themes can also register [custom block style](/docs/designers-developers/developers/filters/block-filters.md#block-style-variations) for existing blocks. +Plugins and Themes can also register [custom block style](/docs/reference-guides/filters/block-filters.md#block-style-variations) for existing blocks. #### attributes (optional) @@ -166,7 +166,7 @@ attributes: { }, ``` -- **See: [Attributes](/docs/designers-developers/developers/block-api/block-attributes.md).** +- **See: [Attributes](/docs/reference-guides/block-api/block-attributes.md).** #### example (optional) @@ -292,13 +292,13 @@ variations: [ - **_Type:_** `Object` -Supports contains as set of options to control features used in the editor. See the [the supports documentation](/docs/designers-developers/developers/block-api/block-supports.md) for more details. +Supports contains as set of options to control features used in the editor. See the [the supports documentation](/docs/reference-guides/block-api/block-supports.md) for more details. #### transforms (optional) - **Type:** `Object` -Transforms provide rules for what a block can be transformed from and what it can be transformed to. A block can be transformed from another block, a shortcode, a regular expression, a file or a raw DOM node. Take a look at the [Block Transforms API](/docs/designers-developers/developers/block-api/block-transforms.md) for more info about each available transformation. +Transforms provide rules for what a block can be transformed from and what it can be transformed to. A block can be transformed from another block, a shortcode, a regular expression, a file or a raw DOM node. Take a look at the [Block Transforms API](/docs/reference-guides/block-api/block-transforms.md) for more info about each available transformation. #### parent (optional) diff --git a/docs/reference-guides/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md index dd53f61342178..0a2e36c36cf17 100644 --- a/docs/reference-guides/block-api/block-supports.md +++ b/docs/reference-guides/block-api/block-supports.md @@ -57,7 +57,7 @@ attributes: { - Type: `boolean` - Default value: `true` -This property allows to enable [wide alignment](/docs/designers-developers/developers/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. +This property allows to enable [wide alignment](/docs/howto-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. ```js supports: { @@ -271,7 +271,7 @@ supports: { - Type: `boolean` - Default value: `false` -This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/designers-developers/developers/themes/theme-support.md#supporting-custom-line-heights). +This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/howto-guides/themes/theme-support.md#supporting-custom-line-heights). ```js supports: { @@ -330,7 +330,7 @@ supports: { - Subproperties: - `padding`: type `boolean`, default value `false` -This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/designers-developers/developers/themes/theme-support.md##cover-block-padding). +This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/howto-guides/themes/theme-support.md##cover-block-padding). ```js supports: { diff --git a/docs/reference-guides/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md index dc456d5dc3c19..1ebd48e76bf50 100644 --- a/docs/reference-guides/block-api/block-templates.md +++ b/docs/reference-guides/block-api/block-templates.md @@ -59,7 +59,7 @@ registerBlockType( 'myplugin/template', { }); ``` -See the [Meta Block Tutorial](/docs/designers-developers/developers/tutorials/metabox/meta-block-5-finishing.md) for a full example of a template in use. +See the [Meta Block Tutorial](/docs/howto-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. ## Custom Post types diff --git a/docs/reference-guides/data/README.md b/docs/reference-guides/data/README.md index 7408d171144cf..d03590a09dcc8 100644 --- a/docs/reference-guides/data/README.md +++ b/docs/reference-guides/data/README.md @@ -1,11 +1,11 @@ # Data Module Reference - - [**core**: WordPress Core Data](/docs/designers-developers/developers/data/data-core.md) - - [**core/annotations**: Annotations](/docs/designers-developers/developers/data/data-core-annotations.md) - - [**core/blocks**: Block Types Data](/docs/designers-developers/developers/data/data-core-blocks.md) - - [**core/block-editor**: The Block Editor’s Data](/docs/designers-developers/developers/data/data-core-block-editor.md) - - [**core/editor**: The Post Editor’s Data](/docs/designers-developers/developers/data/data-core-editor.md) - - [**core/edit-post**: The Editor’s UI Data](/docs/designers-developers/developers/data/data-core-edit-post.md) - - [**core/notices**: Notices Data](/docs/designers-developers/developers/data/data-core-notices.md) - - [**core/nux**: The NUX (New User Experience) Data](/docs/designers-developers/developers/data/data-core-nux.md) - - [**core/viewport**: The Viewport Data](/docs/designers-developers/developers/data/data-core-viewport.md) \ No newline at end of file + - [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) + - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) + - [**core/blocks**: Block Types Data](/docs/reference-guides/data/data-core-blocks.md) + - [**core/block-editor**: The Block Editor’s Data](/docs/reference-guides/data/data-core-block-editor.md) + - [**core/editor**: The Post Editor’s Data](/docs/reference-guides/data/data-core-editor.md) + - [**core/edit-post**: The Editor’s UI Data](/docs/reference-guides/data/data-core-edit-post.md) + - [**core/notices**: Notices Data](/docs/reference-guides/data/data-core-notices.md) + - [**core/nux**: The NUX (New User Experience) Data](/docs/reference-guides/data/data-core-nux.md) + - [**core/viewport**: The Viewport Data](/docs/reference-guides/data/data-core-viewport.md) \ No newline at end of file diff --git a/docs/reference-guides/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md index da02d5f550b66..05390c7a816a2 100644 --- a/docs/reference-guides/filters/block-filters.md +++ b/docs/reference-guides/filters/block-filters.md @@ -4,7 +4,7 @@ To modify the behavior of existing blocks, WordPress exposes several APIs: ### Block Style Variations -Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/designers-developers/developers/tutorials/javascript/) for a full example. +Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/) for a full example. _Example:_ @@ -178,7 +178,7 @@ wp.hooks.addFilter( ); ``` -_Note:_ A [block validation](/docs/designers-developers/developers/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content output by the `save()` function. +_Note:_ A [block validation](/docs/reference-guides/block-api/block-edit-save.md#validation) error will occur if this filter modifies existing content the next time the post is edited. The editor verifies that the content stored in the post matches the content output by the `save()` function. To avoid this validation error, use `render_block` server-side to modify existing post content instead of this filter. See [render_block documentation](https://developer.wordpress.org/reference/hooks/render_block/). diff --git a/docs/reference-guides/slotfills/README.md b/docs/reference-guides/slotfills/README.md index c01ff23c948f7..da88e6cb7661e 100644 --- a/docs/reference-guides/slotfills/README.md +++ b/docs/reference-guides/slotfills/README.md @@ -97,12 +97,12 @@ const PostStatus = ( { isOpened, onTogglePanel } ) => ( The following SlotFills are available in the `edit-post` package. Please refer to the individual items below for usage and example details: -* [MainDashboardButton](/docs/designers-developers/developers/slotfills/main-dashboard-button.md) -* [PluginBlockSettingsMenuItem](/docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md) -* [PluginDocumentSettingPanel](/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md) -* [PluginMoreMenuItem](/docs/designers-developers/developers/slotfills/plugin-more-menu-item.md) -* [PluginPostPublishPanel](/docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md) -* [PluginPostStatusInfo](/docs/designers-developers/developers/slotfills/plugin-post-status-info.md) -* [PluginPrePublishPanel](/docs/designers-developers/developers/slotfills/plugin-pre-publish-panel.md) -* [PluginSidebar](/docs/designers-developers/developers/slotfills/plugin-sidebar.md) -* [PluginSidebarMoreMenuItem](/docs/designers-developers/developers/slotfills/plugin-sidebar-more-menu-item.md) +* [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) +* [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) +* [PluginDocumentSettingPanel](/docs/reference-guides/slotfills/plugin-document-setting-panel.md) +* [PluginMoreMenuItem](/docs/reference-guides/slotfills/plugin-more-menu-item.md) +* [PluginPostPublishPanel](/docs/reference-guides/slotfills/plugin-post-publish-panel.md) +* [PluginPostStatusInfo](/docs/reference-guides/slotfills/plugin-post-status-info.md) +* [PluginPrePublishPanel](/docs/reference-guides/slotfills/plugin-pre-publish-panel.md) +* [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) +* [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) From a566a6f08e23fcc31eddd2f0dfac51274bb0fb8a Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:02:22 +0100 Subject: [PATCH 46/68] Update links for contributor section --- docs/contributors/accessibility-testing.md | 2 +- docs/contributors/code/coding-guidelines.md | 6 +++--- docs/contributors/code/develop.md | 14 +++++++------- docs/contributors/code/git-workflow.md | 2 +- docs/contributors/code/native-mobile.md | 6 +++--- docs/contributors/code/testing-overview.md | 8 ++++---- docs/contributors/design/reference.md | 4 ++-- docs/contributors/documentation/document.md | 4 ++-- docs/contributors/repository-management.md | 2 +- .../architecture/automated-testing.md | 2 +- docs/getting-started/architecture/performance.md | 2 +- docs/getting-started/tutorials/devenv/README.md | 2 +- docs/howto-guides/javascript/js-build-setup.md | 2 +- docs/manifest.json | 6 ++++++ docs/toc.json | 1 + 15 files changed, 35 insertions(+), 28 deletions(-) diff --git a/docs/contributors/accessibility-testing.md b/docs/contributors/accessibility-testing.md index c4250027e3bc9..d7b56d715bcfc 100644 --- a/docs/contributors/accessibility-testing.md +++ b/docs/contributors/accessibility-testing.md @@ -4,7 +4,7 @@ This is a guide on how to test accessibility on Gutenberg. This is a living docu ## Getting Started -Make sure you have set up your local environment following the instructions on [Getting Started](/docs/contributors/getting-started.md). +Make sure you have set up your local environment following the instructions on [Getting Started](/docs/contributors/code/getting-started.md). ## Keyboard Testing diff --git a/docs/contributors/code/coding-guidelines.md b/docs/contributors/code/coding-guidelines.md index bf2f24ca816b2..70959b81aad42 100644 --- a/docs/contributors/code/coding-guidelines.md +++ b/docs/contributors/code/coding-guidelines.md @@ -220,7 +220,7 @@ It is preferred to implement all components as [function components](https://rea ## JavaScript Documentation using JSDoc -Gutenberg follows the [WordPress JavaScript Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/), with additional guidelines relevant for its distinct use of [import semantics](/docs/contributors/coding-guidelines.md#imports) in organizing files, the [use of TypeScript tooling](/docs/contributors/testing-overview.md#javascript-testing) for types validation, and automated documentation generation using [`@wordpress/docgen`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/docgen). +Gutenberg follows the [WordPress JavaScript Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/), with additional guidelines relevant for its distinct use of [import semantics](/docs/contributors/code/coding-guidelines.md#imports) in organizing files, the [use of TypeScript tooling](/docs/contributors/code/testing-overview.md#javascript-testing) for types validation, and automated documentation generation using [`@wordpress/docgen`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/docgen). For additional guidance, consult the following resources: @@ -266,7 +266,7 @@ Note the use of quotes when defining a set of string literals. As in the [JavaSc Use the [TypeScript `import` function](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#import-types) to import type declarations from other files or third-party dependencies. -Since an imported type declaration can occupy an excess of the available line length and become verbose when referenced multiple times, you are encouraged to create an alias of the external type using a `@typedef` declaration at the top of the file, immediately following [the `import` groupings](/docs/contributors/coding-guidelines.md#imports). +Since an imported type declaration can occupy an excess of the available line length and become verbose when referenced multiple times, you are encouraged to create an alias of the external type using a `@typedef` declaration at the top of the file, immediately following [the `import` groupings](/docs/contributors/code/coding-guidelines.md#imports). ```js /** @typedef {import('@wordpress/data').WPDataRegistry} WPDataRegistry */ @@ -472,6 +472,6 @@ For class components, there is no recommendation for documenting the props of th We use [`phpcs` (PHP_CodeSniffer)](https://github.com/squizlabs/PHP_CodeSniffer) with the [WordPress Coding Standards ruleset](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) to run a lot of automated checks against all PHP code in this project. This ensures that we are consistent with WordPress PHP coding standards. -The easiest way to use PHPCS is [local environment](/docs/contributors/getting-started.md#local-environment). Once that's installed, you can check your PHP by running `npm run lint-php`. +The easiest way to use PHPCS is [local environment](/docs/contributors/code/getting-started.md#local-environment). Once that's installed, you can check your PHP by running `npm run lint-php`. If you prefer to install PHPCS locally, you should use `composer`. [Install `composer`](https://getcomposer.org/download/) on your computer, then run `composer install`. This will install `phpcs` and `WordPress-Coding-Standards` which you can then run via `composer lint`. diff --git a/docs/contributors/code/develop.md b/docs/contributors/code/develop.md index d606b1d88b995..ae1d8df2d69fc 100644 --- a/docs/contributors/code/develop.md +++ b/docs/contributors/code/develop.md @@ -16,11 +16,11 @@ Browse [the issues list](https://github.com/wordpress/gutenberg/issues) to find ## Contributor Resources -* [Getting Started](/docs/contributors/getting-started.md) documents getting your development environment setup, this includes your test site and developer tools suggestions. -* [Git Workflow](/docs/contributors/git-workflow.md) documents the git process for deploying changes using pull requests. -* [Coding Guidelines](/docs/contributors/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. -* [Testing Overview](/docs/contributors/testing-overview.md) for PHP and JavaScript development in Gutenberg. +* [Getting Started](/docs/contributors/code/getting-started.md) documents getting your development environment setup, this includes your test site and developer tools suggestions. +* [Git Workflow](/docs/contributors/code/git-workflow.md) documents the git process for deploying changes using pull requests. +* [Coding Guidelines](/docs/contributors/code/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. +* [Testing Overview](/docs/contributors/code/testing-overview.md) for PHP and JavaScript development in Gutenberg. * [Accessibility Testing](/docs/contributors/accessibility-testing.md) documents the process of testing accessibility in Gutenberg. -* [Managing Packages](/docs/contributors/managing-packages.md) documents the process for managing the npm packages. -* [Gutenberg Release Process](/docs/contributors/release.md) - a checklist for the different types of releases for the Gutenberg project. -* [React Native mobile Gutenberg](/docs/contributors/native-mobile.md) - a guide on the React Native based mobile Gutenberg editor. +* [Managing Packages](/docs/contributors/code/managing-packages.md) documents the process for managing the npm packages. +* [Gutenberg Release Process](/docs/contributors/code/release.md) - a checklist for the different types of releases for the Gutenberg project. +* [React Native mobile Gutenberg](/docs/contributors/code/native-mobile.md) - a guide on the React Native based mobile Gutenberg editor. diff --git a/docs/contributors/code/git-workflow.md b/docs/contributors/code/git-workflow.md index 1b47aa2ec6334..38741e3c1ba21 100644 --- a/docs/contributors/code/git-workflow.md +++ b/docs/contributors/code/git-workflow.md @@ -49,7 +49,7 @@ This will create a directory called `gutenberg` with all the files for the proje git switch -c update/my-branch ``` -**Step 4**: Make the code changes. Build, confirm, and test your change thoroughly. See [coding guidelines](/docs/contributors/coding-guidelines.md) and [testing overview](/docs/contributors/testing-overview.md) for guidance. +**Step 4**: Make the code changes. Build, confirm, and test your change thoroughly. See [coding guidelines](/docs/contributors/code/coding-guidelines.md) and [testing overview](/docs/contributors/code/testing-overview.md) for guidance. **Step 5**: Commit your change with a [good commit message](https://make.wordpress.org/core/handbook/best-practices/commit-messages/). This will commit your change to your local copy of the repository. diff --git a/docs/contributors/code/native-mobile.md b/docs/contributors/code/native-mobile.md index 4f1bc73ad3433..e62ba1254d32e 100644 --- a/docs/contributors/code/native-mobile.md +++ b/docs/contributors/code/native-mobile.md @@ -4,7 +4,7 @@ Intertwined with the web codepaths, the Gutenberg repo also includes the [React ## Running Gutenberg Mobile on Android and iOS -For instructions on how to run the **Gutenberg Mobile Demo App** on Android or iOS, see [Getting Started for the React Native based Mobile Gutenberg](/docs/contributors/getting-started-native-mobile.md) +For instructions on how to run the **Gutenberg Mobile Demo App** on Android or iOS, see [Getting Started for the React Native based Mobile Gutenberg](/docs/contributors/code/getting-started-native-mobile.md) Also, the mobile client is packaged and released via the [official WordPress apps](https://wordpress.org/mobile/). Even though the build pipeline is slightly different then the mobile demo apps and lives in its own repo for now ([here's the native mobile repo](https://github.com/wordpress-mobile/gutenberg-mobile)), the source code itself is taken directly from this repo and the "web" side codepaths. @@ -21,11 +21,11 @@ Our tooling isn't as good yet as we'd like to and it's hard to have a good aware If you encounter a failed Android/iOS test on your pull request, we recommend the following steps: 1. Re-running the failed GitHub Action job ([guide for how to re-run](https://docs.github.com/en/actions/configuring-and-managing-workflows/managing-a-workflow-run#viewing-your-workflow-history)) - This should fix failed tests the majority of the time. Cases where you need to re-run tests for a pass should go down in the near future as flakiness in tests is actively being worked on. See the following GitHub issue for updated info on known failures: https://github.com/WordPress/gutenberg/issues/23949 -2. You can check if the test is failing locally by following the steps to run the E2E test on your machine from the [mobile getting started guide](/docs/contributors/getting-started-native-mobile.md#ui-tests), with even more relevant info in the [relevant directory README.md](https://github.com/WordPress/gutenberg/tree/HEAD/packages/react-native-editor/__device-tests__#running-the-tests-locally) +2. You can check if the test is failing locally by following the steps to run the E2E test on your machine from the [mobile getting started guide](/docs/contributors/code/getting-started-native-mobile.md#ui-tests), with even more relevant info in the [relevant directory README.md](https://github.com/WordPress/gutenberg/tree/HEAD/packages/react-native-editor/__device-tests__#running-the-tests-locally) 3. In addition to reading the logs from the E2E test, you can download a video recording from the Artifacts section of the GitHub job that may have additional useful information. 4. Check if any changes in your PR would require corresponding changes to `.native.js` versions of files. 5. Lastly, if you're stuck on a failing mobile test, feel free to reach out to contributors on Slack in the #mobile or #core-editor chats in the WordPress Core Slack, [free to join](https://make.wordpress.org/chat/). ## Debugging the native mobile unit tests -Follow the instructions in [Native mobile testing](/docs/contributors/testing-overview.md#native-mobile-testing) to locally debug the native mobile unit tests when needed. +Follow the instructions in [Native mobile testing](/docs/contributors/code/testing-overview.md#native-mobile-testing) to locally debug the native mobile unit tests when needed. diff --git a/docs/contributors/code/testing-overview.md b/docs/contributors/code/testing-overview.md index 7e28c8e14a0a1..377e5276833c2 100644 --- a/docs/contributors/code/testing-overview.md +++ b/docs/contributors/code/testing-overview.md @@ -23,7 +23,7 @@ Tests for JavaScript use [Jest](https://jestjs.io/) as the test runner and its A It should be noted that in the past, React components were unit tested with [Enzyme](https://github.com/airbnb/enzyme). However, for new tests, it is preferred to use React Testing Library (RTL) and over time old tests should be refactored to use RTL too (typically when working on code that touches an old test). -Assuming you've followed the [instructions](/docs/contributors/getting-started.md) to install Node and project dependencies, tests can be run from the command-line with NPM: +Assuming you've followed the [instructions](/docs/contributors/code/getting-started.md) to install Node and project dependencies, tests can be run from the command-line with NPM: ``` npm test @@ -31,7 +31,7 @@ npm test Linting is static code analysis used to enforce coding standards and to avoid potential errors. This project uses [ESLint](http://eslint.org/) and [TypeScript's JavaScript type-checking](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html) to capture these issues. While the above `npm test` will execute both unit tests and code linting, code linting can be verified independently by running `npm run lint`. Some JavaScript issues can be fixed automatically by running `npm run lint-js:fix`. -To improve your developer workflow, you should setup an editor linting integration. See the [getting started documentation](/docs/contributors/getting-started.md) for additional information. +To improve your developer workflow, you should setup an editor linting integration. See the [getting started documentation](/docs/contributors/code/getting-started.md) for additional information. To run unit tests only, without the linter, use `npm run test-unit` instead. @@ -386,7 +386,7 @@ Contributors to Gutenberg will note that PRs include continuous integration E2E End-to-end tests use [Puppeteer](https://github.com/puppeteer/puppeteer) as a headless Chromium driver, and are otherwise still run by a [Jest](https://jestjs.io/) test runner. -If you're using the built-in [local environment](/docs/contributors/getting-started.md#local-environment), you can run the e2e tests locally using this command: +If you're using the built-in [local environment](/docs/contributors/code/getting-started.md#local-environment), you can run the e2e tests locally using this command: ```bash npm run test-e2e @@ -454,7 +454,7 @@ Every core block is required to have at least one set of fixture files for its m ## PHP Testing -Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. If you're using the built-in [local environment](/docs/contributors/getting-started.md#local-environment), you can run the PHP tests locally using this command: +Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. If you're using the built-in [local environment](/docs/contributors/code/getting-started.md#local-environment), you can run the PHP tests locally using this command: ```bash npm run test-php diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 9a4e6944aef83..281961bda5c7f 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -1,8 +1,8 @@ # Reference - [Glossary](/docs/getting-started/glossary.md) -- [Coding Guidelines](/docs/contributors/coding-guidelines.md) -- [Testing Overview](/docs/contributors/testing-overview.md) +- [Coding Guidelines](/docs/contributors/code/coding-guidelines.md) +- [Testing Overview](/docs/contributors/code/testing-overview.md) - [Frequently Asked Questions](/docs/getting-started/faq.md) ## Logo diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index a9d85c6679daa..781dcd2fa49be 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -25,7 +25,7 @@ The Block Editor Handbook is a mix of markdown files in the `/docs/` directory o An automated job publishes the docs every 15 minutes to the [Block Editor Handbook site](https://developer.wordpress.org/block-editor/). -See [the Git Workflow](/docs/contributors/git-workflow.md) documentation for how to use git to deploy changes using pull requests. Additionally, see the [video walk-through](https://wordpress.tv/2020/09/02/marcus-kazmierczak-contribute-developer-documentation-to-gutenberg/) and the accompanying [slides for contributing documentation to Gutenberg](https://mkaz.blog/wordpress/contribute-documentation-to-gutenberg/). +See [the Git Workflow](/docs/contributors/code/git-workflow.md) documentation for how to use git to deploy changes using pull requests. Additionally, see the [video walk-through](https://wordpress.tv/2020/09/02/marcus-kazmierczak-contribute-developer-documentation-to-gutenberg/) and the accompanying [slides for contributing documentation to Gutenberg](https://mkaz.blog/wordpress/contribute-documentation-to-gutenberg/). ### Update a Document @@ -96,7 +96,7 @@ The preferred format for code examples is ESNext, this should be the default vie ### Editor Config -You should configure your editor to use Prettier to auto-format markdown documents. See the [Getting Started documentation](/docs/contributors/develop/getting-started.md) for complete details. +You should configure your editor to use Prettier to auto-format markdown documents. See the [Getting Started documentation](/docs/contributors/code/getting-started.md) for complete details. An example config for using Visual Studio Code and the Prettier extensions: diff --git a/docs/contributors/repository-management.md b/docs/contributors/repository-management.md index bbc3120a0bba4..6ece48707c74f 100644 --- a/docs/contributors/repository-management.md +++ b/docs/contributors/repository-management.md @@ -123,7 +123,7 @@ A pull request can generally be merged once it is: - Vetted against all potential edge cases. - Changelog entries were properly added. - Reviewed by someone other than the original author. -- [Rebased](/docs/contributors/git-workflow.md#keeping-your-branch-up-to-date) onto the latest version of the trunk branch. +- [Rebased](/docs/contributors/code/git-workflow.md#keeping-your-branch-up-to-date) onto the latest version of the master branch. The final pull request merge decision is made by the **@wordpress/gutenberg-core** team. diff --git a/docs/getting-started/architecture/automated-testing.md b/docs/getting-started/architecture/automated-testing.md index 4ca6555c8fbfb..42dfd28a571b0 100644 --- a/docs/getting-started/architecture/automated-testing.md +++ b/docs/getting-started/architecture/automated-testing.md @@ -13,7 +13,7 @@ These include: For more context, refer to the following resources: -- [Testing Overview: End-to-End Testing](/docs/contributors/testing-overview.md#end-to-end-testing) +- [Testing Overview: End-to-End Testing](/docs/contributors/code/testing-overview.md#end-to-end-testing) - [Testing: Experiment with Puppeteer for E2E testing](https://github.com/WordPress/gutenberg/pull/5618) - In early iterations, the contributing team opted to use Cypress for end-to-end testing. This pull request outlines problems with the approach, and proposed the initial transition to Puppeteer. - [JavaScript Chat Summary: January 28, 2020](https://make.wordpress.org/core/2020/02/04/javascript-chat-summary-january-28-2020/) diff --git a/docs/getting-started/architecture/performance.md b/docs/getting-started/architecture/performance.md index e4473b2350f1f..a886beaf73850 100644 --- a/docs/getting-started/architecture/performance.md +++ b/docs/getting-started/architecture/performance.md @@ -4,7 +4,7 @@ Performance is a key feature for editor applications and the Block editor is not ## Metrics -To ensure the block editor stays performant across releases and development, we monitor some key metrics using [performance testing](/docs/contributors/testing-overview.md#performance-testing). +To ensure the block editor stays performant across releases and development, we monitor some key metrics using [performance testing](/docs/contributors/code/testing-overview.md#performance-testing). **Loading Time:** The time it takes to load an editor page. **Typing Time:** The time it takes for the browser to respond while typing on the editor. diff --git a/docs/getting-started/tutorials/devenv/README.md b/docs/getting-started/tutorials/devenv/README.md index 212c7f689cd58..05ae80c3da4fb 100644 --- a/docs/getting-started/tutorials/devenv/README.md +++ b/docs/getting-started/tutorials/devenv/README.md @@ -1,6 +1,6 @@ # Development Environment -This guide is for setting up your local environment for JavaScript development for creating plugins and tools to extend WordPress and the block editor. If you are looking to contribute to Gutenberg project itself, see additional documentation in the [Getting Started guide](/docs/contributors/getting-started.md). +This guide is for setting up your local environment for JavaScript development for creating plugins and tools to extend WordPress and the block editor. If you are looking to contribute to Gutenberg project itself, see additional documentation in the [Getting Started guide](/docs/contributors/code/getting-started.md). A development environment is a catch-all term for what you need setup on your computer to work. The three main pieces needed for our development environment are: diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/howto-guides/javascript/js-build-setup.md index 1c3e3f314dc3a..ddff1bb175888 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/howto-guides/javascript/js-build-setup.md @@ -4,7 +4,7 @@ ESNext is JavaScript written using syntax and features only available in a versi See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. -Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/getting-started.md) documentation. +Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/code/getting-started.md) documentation. Browsers cannot interpret or run ESNext and JSX syntaxes, so we must use a transformation step to convert these syntaxes to code that browsers can understand. diff --git a/docs/manifest.json b/docs/manifest.json index d929c5c1f0771..d30d078ac9560 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1847,6 +1847,12 @@ "markdown_source": "../docs/contributors/localizing.md", "parent": "contributors" }, + { + "title": "Accessibility Testing", + "slug": "accessibility-testing", + "markdown_source": "../docs/contributors/accessibility-testing.md", + "parent": "contributors" + }, { "title": "Repository Management", "slug": "repository-management", diff --git a/docs/toc.json b/docs/toc.json index 8dc2de711652a..db4be1003e5f6 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -165,6 +165,7 @@ ] }, { "docs/contributors/triage.md": [] }, { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, { "docs/contributors/repository-management.md": [] }, { "docs/contributors/folder-structure.md": [] }, { "docs/contributors/versions-in-wordpress.md": [] }, From e8e4678f3ea71dfccc38ecb06143ecdbee6a4918 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:12:34 +0100 Subject: [PATCH 47/68] Move architecture folder under explanation --- .../architecture/README.md | 0 .../architecture/automated-testing.md | 0 .../architecture/data-flow.md | 0 .../full-site-editing-templates.md | 0 .../architecture/key-concepts.md | 0 .../architecture/modularity.md | 0 .../architecture/performance.md | 0 docs/manifest.json | 76 +++++++++---------- docs/toc.json | 17 +++-- 9 files changed, 47 insertions(+), 46 deletions(-) rename docs/{getting-started => explanations}/architecture/README.md (100%) rename docs/{getting-started => explanations}/architecture/automated-testing.md (100%) rename docs/{getting-started => explanations}/architecture/data-flow.md (100%) rename docs/explanations/{ => architecture}/full-site-editing-templates.md (100%) rename docs/{getting-started => explanations}/architecture/key-concepts.md (100%) rename docs/{getting-started => explanations}/architecture/modularity.md (100%) rename docs/{getting-started => explanations}/architecture/performance.md (100%) diff --git a/docs/getting-started/architecture/README.md b/docs/explanations/architecture/README.md similarity index 100% rename from docs/getting-started/architecture/README.md rename to docs/explanations/architecture/README.md diff --git a/docs/getting-started/architecture/automated-testing.md b/docs/explanations/architecture/automated-testing.md similarity index 100% rename from docs/getting-started/architecture/automated-testing.md rename to docs/explanations/architecture/automated-testing.md diff --git a/docs/getting-started/architecture/data-flow.md b/docs/explanations/architecture/data-flow.md similarity index 100% rename from docs/getting-started/architecture/data-flow.md rename to docs/explanations/architecture/data-flow.md diff --git a/docs/explanations/full-site-editing-templates.md b/docs/explanations/architecture/full-site-editing-templates.md similarity index 100% rename from docs/explanations/full-site-editing-templates.md rename to docs/explanations/architecture/full-site-editing-templates.md diff --git a/docs/getting-started/architecture/key-concepts.md b/docs/explanations/architecture/key-concepts.md similarity index 100% rename from docs/getting-started/architecture/key-concepts.md rename to docs/explanations/architecture/key-concepts.md diff --git a/docs/getting-started/architecture/modularity.md b/docs/explanations/architecture/modularity.md similarity index 100% rename from docs/getting-started/architecture/modularity.md rename to docs/explanations/architecture/modularity.md diff --git a/docs/getting-started/architecture/performance.md b/docs/explanations/architecture/performance.md similarity index 100% rename from docs/getting-started/architecture/performance.md rename to docs/explanations/architecture/performance.md diff --git a/docs/manifest.json b/docs/manifest.json index d30d078ac9560..10f076a35e3dc 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -65,42 +65,6 @@ "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", "parent": "create-block" }, - { - "title": "Architecture", - "slug": "architecture", - "markdown_source": "../docs/getting-started/architecture/README.md", - "parent": "getting-started" - }, - { - "title": "Key Concepts", - "slug": "key-concepts", - "markdown_source": "../docs/getting-started/architecture/key-concepts.md", - "parent": "architecture" - }, - { - "title": "Data Flow and Data Format", - "slug": "data-flow", - "markdown_source": "../docs/getting-started/architecture/data-flow.md", - "parent": "architecture" - }, - { - "title": "Modularity", - "slug": "modularity", - "markdown_source": "../docs/getting-started/architecture/modularity.md", - "parent": "architecture" - }, - { - "title": "Performance", - "slug": "performance", - "markdown_source": "../docs/getting-started/architecture/performance.md", - "parent": "architecture" - }, - { - "title": "Automated Testing", - "slug": "automated-testing", - "markdown_source": "../docs/getting-started/architecture/automated-testing.md", - "parent": "architecture" - }, { "title": "Glossary", "slug": "glossary", @@ -1727,11 +1691,47 @@ "markdown_source": "../docs/explanations/README.md", "parent": null }, + { + "title": "Architecture", + "slug": "architecture", + "markdown_source": "../docs/explanations/architecture/README.md", + "parent": "explanations" + }, + { + "title": "Key Concepts", + "slug": "key-concepts", + "markdown_source": "../docs/explanations/architecture/key-concepts.md", + "parent": "architecture" + }, + { + "title": "Data Flow and Data Format", + "slug": "data-flow", + "markdown_source": "../docs/explanations/architecture/data-flow.md", + "parent": "architecture" + }, + { + "title": "Modularity", + "slug": "modularity", + "markdown_source": "../docs/explanations/architecture/modularity.md", + "parent": "architecture" + }, + { + "title": "Performance", + "slug": "performance", + "markdown_source": "../docs/explanations/architecture/performance.md", + "parent": "architecture" + }, + { + "title": "Automated Testing", + "slug": "automated-testing", + "markdown_source": "../docs/explanations/architecture/automated-testing.md", + "parent": "architecture" + }, { "title": "FullSiteEditingTemplates", "slug": "full-site-editing-templates", - "markdown_source": "../docs/explanations/full-site-editing-templates.md", - "parent": "explanations" + "markdown_source": "../docs/explanations/architecture/full-site-editing-templates.md", + "parent": "architecture" }, { "title": "Contributor Guide", diff --git a/docs/toc.json b/docs/toc.json index db4be1003e5f6..35ac7d3b29f72 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -13,13 +13,6 @@ { "docs/getting-started/tutorials/create-block/finishing.md": [] } ] } ] }, - { "docs/getting-started/architecture/README.md": [ - { "docs/getting-started/architecture/key-concepts.md": [] }, - { "docs/getting-started/architecture/data-flow.md": [] }, - { "docs/getting-started/architecture/modularity.md": [] }, - { "docs/getting-started/architecture/performance.md": [] }, - { "docs/getting-started/architecture/automated-testing.md": [] } - ] }, { "docs/getting-started/glossary.md": [] }, { "docs/getting-started/faq.md": [] }, { "docs/getting-started/history.md": [] }, @@ -141,7 +134,15 @@ ] } ] }, { "docs/explanations/README.md": [ - { "docs/explanations/full-site-editing-templates.md": [] } + + { "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] } ] }, { "docs/contributors/README.md": [ { "docs/contributors/code/develop.md": [ From eeb7e4537ddc3d2246c1f54817c781b0e7eb56c0 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:25:42 +0100 Subject: [PATCH 48/68] Replace occurence of howto-guides with how-to-guides --- docs/contributors/design/reference.md | 2 +- docs/contributors/documentation/document.md | 4 +- .../tutorials/block-based-theme/README.md | 14 +- .../full-site-editing-templates.md | 2 +- .../explanations/architecture/key-concepts.md | 2 +- docs/getting-started/README.md | 6 +- docs/getting-started/faq.md | 2 +- docs/getting-started/tutorials/README.md | 12 +- .../tutorials/create-block/block-anatomy.md | 2 +- .../tutorials/create-block/finishing.md | 6 +- .../tutorials/create-block/wp-plugin.md | 4 +- .../{howto-guides => how-to-guides}/README.md | 6 +- .../accessibility.md | 0 .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin .../assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../js-tutorial-console-log-success.png | Bin .../js-tutorial-error-blocks-undefined.png | Bin ...in-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin .../assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin .../backward-compatibility/README.md | 0 .../backward-compatibility/deprecations.md | 0 .../backward-compatibility/meta-box.md | 2 +- .../how-to-guides/block-based-theme/README.md | 380 +++++++++++++++++ .../block-based-themes-2-adding-blocks.md | 55 +++ .../block-tutorial/README.md | 2 +- .../applying-styles-with-stylesheets.md | 0 .../block-controls-toolbar-and-sidebar.md | 0 .../block-tutorial/creating-dynamic-blocks.md | 2 +- .../generate-blocks-with-wp-cli.md | 0 ...roducing-attributes-and-editable-fields.md | 0 .../nested-blocks-inner-blocks.md | 0 .../writing-your-first-block-type.md | 2 +- .../designers/README.md | 0 .../designers/animation.md | 0 .../designers/assets/advanced-settings-do.png | Bin .../designers/assets/block-controls-do.png | Bin .../designers/assets/block-controls-dont.png | Bin .../assets/block-descriptions-do.png | Bin .../assets/block-descriptions-dont.png | Bin .../designers/assets/blocks-do.png | Bin .../designers/assets/blocks-dont.png | Bin .../designers/assets/placeholder-do.png | Bin .../designers/assets/placeholder-dont.png | Bin .../designers/block-design.md | 2 +- .../designers/design-resources.md | 0 .../designers/user-interface.md | 0 .../feature-flags.md | 0 .../format-api/1-register-format.md | 0 .../format-api/2-toolbar-button.md | 0 .../format-api/3-apply-format.md | 0 .../format-api/README.md | 8 +- .../internationalization.md | 0 .../javascript/README.md | 16 +- .../javascript/esnext-js.md | 0 .../javascript/extending-the-block-editor.md | 0 .../javascript/js-build-setup.md | 4 +- .../javascript/loading-javascript.md | 0 .../javascript/plugins-background.md | 0 .../javascript/scope-your-code.md | 0 .../javascript/troubleshooting.md | 4 +- .../javascript/versions-and-building.md | 4 +- .../metabox/README.md | 4 +- .../metabox/meta-block-1-intro.md | 10 +- .../metabox/meta-block-2-register-meta.md | 0 .../metabox/meta-block-3-add.md | 4 +- .../metabox/meta-block-4-use-data.md | 0 .../metabox/meta-block-5-finishing.md | 0 .../metabox/meta-block.png | Bin .../notices/README.md | 2 +- .../notices/block-editor-notice.png | Bin .../notices/classic-editor-notice.png | Bin .../platform/README.md | 0 .../platform/custom-block-editor/README.md | 0 .../platform/custom-block-editor/tutorial.md | 0 .../sidebar-tutorial/plugin-sidebar-0.md | 12 + .../plugin-sidebar-1-up-and-running.md | 0 .../plugin-sidebar-2-styles-and-controls.md | 0 .../plugin-sidebar-3-register-meta.md | 0 .../plugin-sidebar-4-initialize-input.md | 0 .../plugin-sidebar-5-update-meta.md | 0 .../plugin-sidebar-6-finishing-touches.md | 0 .../themes/README.md | 0 .../themes/block-based-themes.md | 4 +- .../themes/theme-json.md | 0 .../themes/theme-support.md | 2 +- .../sidebar-tutorial/plugin-sidebar-0.md | 12 - docs/manifest.json | 140 +++---- .../block-api/block-edit-save.md | 6 +- .../block-api/block-metadata.md | 2 +- .../block-api/block-supports.md | 6 +- .../block-api/block-templates.md | 2 +- .../reference-guides/filters/block-filters.md | 2 +- docs/toc.json | 392 ++++++++++-------- 105 files changed, 812 insertions(+), 331 deletions(-) rename docs/{howto-guides => how-to-guides}/README.md (88%) rename docs/{howto-guides => how-to-guides}/accessibility.md (100%) rename docs/{howto-guides => how-to-guides}/assets/fancy-quote-in-inspector.png (100%) rename docs/{howto-guides => how-to-guides}/assets/fancy-quote-with-style.png (100%) rename docs/{howto-guides => how-to-guides}/assets/inspector.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-console-log-error.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-console-log-success.png (100%) rename docs/{howto-guides => how-to-guides}/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-more-menu-item.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-post-publish-panel.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-post-status-info-location.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-pre-publish-panel.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-closed-state.png (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{howto-guides => how-to-guides}/assets/plugin-sidebar-open-state.png (100%) rename docs/{howto-guides => how-to-guides}/assets/sidebar-style-and-controls.png (100%) rename docs/{howto-guides => how-to-guides}/assets/sidebar-up-and-running.png (100%) rename docs/{howto-guides => how-to-guides}/assets/toolbar-text.png (100%) rename docs/{howto-guides => how-to-guides}/assets/toolbar-with-custom-button.png (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/README.md (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/deprecations.md (100%) rename docs/{howto-guides => how-to-guides}/backward-compatibility/meta-box.md (98%) create mode 100644 docs/how-to-guides/block-based-theme/README.md create mode 100644 docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md rename docs/{howto-guides => how-to-guides}/block-tutorial/README.md (91%) rename docs/{howto-guides => how-to-guides}/block-tutorial/applying-styles-with-stylesheets.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/block-controls-toolbar-and-sidebar.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/creating-dynamic-blocks.md (97%) rename docs/{howto-guides => how-to-guides}/block-tutorial/generate-blocks-with-wp-cli.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/introducing-attributes-and-editable-fields.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/nested-blocks-inner-blocks.md (100%) rename docs/{howto-guides => how-to-guides}/block-tutorial/writing-your-first-block-type.md (98%) rename docs/{howto-guides => how-to-guides}/designers/README.md (100%) rename docs/{howto-guides => how-to-guides}/designers/animation.md (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/advanced-settings-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-controls-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-controls-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-descriptions-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/block-descriptions-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/blocks-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/blocks-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/placeholder-do.png (100%) rename docs/{howto-guides => how-to-guides}/designers/assets/placeholder-dont.png (100%) rename docs/{howto-guides => how-to-guides}/designers/block-design.md (98%) rename docs/{howto-guides => how-to-guides}/designers/design-resources.md (100%) rename docs/{howto-guides => how-to-guides}/designers/user-interface.md (100%) rename docs/{howto-guides => how-to-guides}/feature-flags.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/1-register-format.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/2-toolbar-button.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/3-apply-format.md (100%) rename docs/{howto-guides => how-to-guides}/format-api/README.md (74%) rename docs/{howto-guides => how-to-guides}/internationalization.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/README.md (59%) rename docs/{howto-guides => how-to-guides}/javascript/esnext-js.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/extending-the-block-editor.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/js-build-setup.md (96%) rename docs/{howto-guides => how-to-guides}/javascript/loading-javascript.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/plugins-background.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/scope-your-code.md (100%) rename docs/{howto-guides => how-to-guides}/javascript/troubleshooting.md (94%) rename docs/{howto-guides => how-to-guides}/javascript/versions-and-building.md (82%) rename docs/{howto-guides => how-to-guides}/metabox/README.md (83%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-1-intro.md (63%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-2-register-meta.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-3-add.md (91%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-4-use-data.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block-5-finishing.md (100%) rename docs/{howto-guides => how-to-guides}/metabox/meta-block.png (100%) rename docs/{howto-guides => how-to-guides}/notices/README.md (95%) rename docs/{howto-guides => how-to-guides}/notices/block-editor-notice.png (100%) rename docs/{howto-guides => how-to-guides}/notices/classic-editor-notice.png (100%) rename docs/{howto-guides => how-to-guides}/platform/README.md (100%) rename docs/{howto-guides => how-to-guides}/platform/custom-block-editor/README.md (100%) rename docs/{howto-guides => how-to-guides}/platform/custom-block-editor/tutorial.md (100%) create mode 100644 docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-1-up-and-running.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-3-register-meta.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-4-initialize-input.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-5-update-meta.md (100%) rename docs/{howto-guides => how-to-guides}/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md (100%) rename docs/{howto-guides => how-to-guides}/themes/README.md (100%) rename docs/{howto-guides => how-to-guides}/themes/block-based-themes.md (96%) rename docs/{howto-guides => how-to-guides}/themes/theme-json.md (100%) rename docs/{howto-guides => how-to-guides}/themes/theme-support.md (99%) delete mode 100644 docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md diff --git a/docs/contributors/design/reference.md b/docs/contributors/design/reference.md index 281961bda5c7f..b3d589576c7b0 100644 --- a/docs/contributors/design/reference.md +++ b/docs/contributors/design/reference.md @@ -15,4 +15,4 @@ Released under GPL license, made by [Cristel Rossignol](https://twitter.com/cris ## Mockups -Mockup Sketch files are available in [the Design section](/docs/howto-guides/designers/design-resources.md). +Mockup Sketch files are available in [the Design section](/docs/how-to-guides/designers/design-resources.md). diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/document.md index 781dcd2fa49be..857b2487c6b48 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/document.md @@ -39,7 +39,7 @@ To update an existing page: ### Create a New Document -To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/howto-guides/javascript/js-build-setup.md): +To add a new documentation page requires a working JavaScript development environment to build the documentation, see the [JavaScript build setup documentation](/docs/how-to-guides/javascript/js-build-setup.md): 1. Create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/HEAD/docs) folder, use lower-case, no spaces, if needed a dash separator, and .md extension. 2. Add content, all documents require one and only H1 tag, using markdown notation. @@ -73,7 +73,7 @@ An example, the link to this page is: `/docs/contributors/document.md` The code example in markdown should be wrapped in three tick marks \`\`\` and should additionally include a language specifier. See this [GitHub documentation around fenced code blocks](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). -A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). +A unique feature to the Gutenberg documentation is the `codetabs` toggle, this allows two versions of code to be shown at once. This is used for showing both `ESNext` and `ES5` code samples. For example, [on this block tutorial page](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). Here is an example `codetabs` section: diff --git a/docs/designers-developers/developers/tutorials/block-based-theme/README.md b/docs/designers-developers/developers/tutorials/block-based-theme/README.md index faf0b054a163f..310ec28a3ec7a 100644 --- a/docs/designers-developers/developers/tutorials/block-based-theme/README.md +++ b/docs/designers-developers/developers/tutorials/block-based-theme/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/howto-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/howto-guides/block-based-themes/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/howto-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/howto-guides/block-based-themes/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -32,7 +32,7 @@ Each template or template part contains the [block grammar](https://developer.wo A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. -The theme may optionally include an [experimental-theme.json file](/docs/howto-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. +The theme may optionally include an [experimental-theme.json file](/docs/how-to-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) diff --git a/docs/explanations/architecture/full-site-editing-templates.md b/docs/explanations/architecture/full-site-editing-templates.md index 4717eee4ecbe2..7c19996eaa699 100644 --- a/docs/explanations/architecture/full-site-editing-templates.md +++ b/docs/explanations/architecture/full-site-editing-templates.md @@ -2,7 +2,7 @@ > This is the documentation for the current implementation of the block-based templates and template parts themes. This is part of the Full Site Editing project. These features are still experimental in the plugin. “Experimental” means this is just an early implementation that is subject to potential drastic and breaking changes in iterations based on feedback from users, contributors, and theme authors. -This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/howto-guides/themes/block-based-themes.md). +This document will explain the internals of how templates and templates parts are rendered in the frontend and edited in the backend. For an introduction about block-based themes and Full site editing templates, refer to the [block-based themes documentation](/docs/how-to-guides/themes/block-based-themes.md). ## Storage diff --git a/docs/explanations/architecture/key-concepts.md b/docs/explanations/architecture/key-concepts.md index 3ec6487b63794..080e2c5803f75 100644 --- a/docs/explanations/architecture/key-concepts.md +++ b/docs/explanations/architecture/key-concepts.md @@ -59,4 +59,4 @@ Note: custom post types can also be initialized with a starting `post_content` t ## Global Styles (in progress) -Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/howto-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. +Describes a set of configuration and default properties of blocks and their visual aspects. Global Styles is both an interface (which users access through the site editor) and a configuration system done through [a `theme.json` file](/docs/how-to-guides/themes/theme-json.md). This file absorbs most of the configuration aspects usually scattered through various `add_theme_support` calls to simplify communicating with the editor. It thus aims to improve declaring what settings should be enabled, what attributes are supported, what specific tools a theme offers (like a custom color palette), the available design tools present both globally and on each block, and an infrastructure that allows to enqueue only the relevant CSS based on what blocks are used on a page. diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 2d56c6e272d47..0f91f0036e907 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -26,15 +26,15 @@ The Editor offers rich new value to users with visual, drag-and-drop creation to ### Develop for the block editor -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/howto-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - [Gutenberg Architecture](/docs/architecture/readme.md) - [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) - [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/howto-guides/themes/readme.md) +- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) - [Block API Reference](/docs/reference-guides/block-api/readme.md) - [Block Editor Accessibility](/docs/reference-guides/accessibility.md) -- [Internationalization](/docs/howto-guides/internationalization.md) +- [Internationalization](/docs/how-to-guides/internationalization.md) ### Contribute to the block editor diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 552105eb0a80d..24d389d05c927 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -339,7 +339,7 @@ function gutenbergtheme_editor_styles() { add_action( 'enqueue_block_editor_assets', 'gutenbergtheme_editor_styles' ); ``` -*See:* [Editor Styles](/docs/howto-guides/themes/theme-support.md#editor-styles) +*See:* [Editor Styles](/docs/how-to-guides/themes/theme-support.md#editor-styles) ## Should I be concerned that Gutenberg will make my plugin obsolete? diff --git a/docs/getting-started/tutorials/README.md b/docs/getting-started/tutorials/README.md index b122cadc61a2b..57a4d2557461f 100644 --- a/docs/getting-started/tutorials/README.md +++ b/docs/getting-started/tutorials/README.md @@ -2,18 +2,18 @@ - First things first, see [setting up your development environment](/docs/getting-started/tutorials/devenv/readme.md) for the tools and setup you need to extend the block editor. -- See the [Getting Started with JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. +- See the [Getting Started with JavaScript Tutorial](/docs/how-to-guides/javascript/readme.md) to learn about how to use JavaScript within WordPress. - Beginners: The [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/readme.md) walks through creating a block plugin using the `@wordpress/create-block` package; a quick and easy way to start creating your own block. -- Intermediate: The [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. +- Intermediate: The [Block Tutorial](/docs/how-to-guides/block-tutorial/readme.md) covers different aspects of block development. The documentation is slightly dated but still valid, if you are new to block development, start with the Create Block Tutorial above. -- See the [Meta Boxes Tutorial](/docs/howto-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. +- See the [Meta Boxes Tutorial](/docs/how-to-guides/metabox/readme.md) for new ways of extending the editor storing and using post meta data. -- Check out the [Notices Tutorial](/docs/howto-guides/notices/README.md) to learn how to display informational UI at the top of the editor. +- Check out the [Notices Tutorial](/docs/how-to-guides/notices/README.md) to learn how to display informational UI at the top of the editor. -- The [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. +- The [Sidebar Tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md) will walk you through the steps of creating a sidebar to update data from the `post_meta` table. -- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/howto-guides/format-api/). +- Learn how to add customized buttons to the toolbar with the [Format API tutorial](/docs/how-to-guides/format-api/). - Build your own [custom block editor instance](/docs/reference-guides/platform/custom-block-editor/) - this will walk you through building a standalone instance of the block editor within WP Admin. diff --git a/docs/getting-started/tutorials/create-block/block-anatomy.md b/docs/getting-started/tutorials/create-block/block-anatomy.md index 2a807b7356105..0e99d24a3c2c7 100644 --- a/docs/getting-started/tutorials/create-block/block-anatomy.md +++ b/docs/getting-started/tutorials/create-block/block-anatomy.md @@ -2,7 +2,7 @@ At its simplest, a block in the WordPress block editor is a JavaScript object with a specific set of properties. -**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. +**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, I recommend reviewing the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development. Here is the complete code for registering a block: diff --git a/docs/getting-started/tutorials/create-block/finishing.md b/docs/getting-started/tutorials/create-block/finishing.md index 1eda38da32078..1691547970414 100644 --- a/docs/getting-started/tutorials/create-block/finishing.md +++ b/docs/getting-started/tutorials/create-block/finishing.md @@ -12,11 +12,11 @@ You can visually browse the components and what their implementation looks like The **RichText component** allows for creating a richer input besides plain text, allowing for bold, italic, links, and other inline formating. See the [RichText Reference](/docs/reference-guides/richtext.md) for documentation using this component. -The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. +The InspectorPanel (the settings on the right for a block) and Block Controls (toolbar controls) have a standard way to be implemented. See the [Block controls tutorial](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) for additional information. -The [Sidebar tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. +The [Sidebar tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md) is a good resource on how to create a sidebar for your plugin. -Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md). +Nested blocks, a block that contains additional blocks, is a common pattern used by various blocks such as Columns, Cover, and Social Links. The **InnerBlocks component** enables this functionality, see the [Using InnerBlocks documentation](/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md). ## How did they do that diff --git a/docs/getting-started/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md index a7a5687c23740..269ac279251e1 100644 --- a/docs/getting-started/tutorials/create-block/wp-plugin.md +++ b/docs/getting-started/tutorials/create-block/wp-plugin.md @@ -112,7 +112,7 @@ For the `editorScript` provided in the block metadata, the build process creates The `wp_register_script` function used internally registers a name, called the handle, and relates that name to the script file. The dependencies are used to specify if the script requires including other libraries. The version is specified so the browser will reload if the file changed. -The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/howto-guides/internationalization.md) +The `wp_set_script_translations` function tells WordPress to load translations for this script, if they exist. See more about [translations & internationalization.](/docs/how-to-guides/internationalization.md) With the above in place, create a new post to load the editor and check your plugin is in the inserter. You can use `/` to search, or click the box with the [+] and search for "Gutenpride" to find the block. @@ -124,7 +124,7 @@ To open the developer tools in Firefox, use the menu selecting Web Developer : T Try running `npm run start` that will start the watch process for automatic rebuilds. If you then make an update to `src/index.js` file, you will see the build run, and if you reload the WordPress editor you'll see the change. -For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/js-build-setup.md) in the Block Editor Handbook. +For more info, see the build section of the [Getting Started with JavaScript tutorial](/docs/how-to-guides/javascript/js-build-setup.md) in the Block Editor Handbook. ## Summary diff --git a/docs/howto-guides/README.md b/docs/how-to-guides/README.md similarity index 88% rename from docs/howto-guides/README.md rename to docs/how-to-guides/README.md index dbed9976d4c9e..fee7fdf2657bb 100644 --- a/docs/howto-guides/README.md +++ b/docs/how-to-guides/README.md @@ -4,7 +4,7 @@ The new editor is highly flexible, like most of WordPress. You can build custom ## Creating Blocks -The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. +The editor is about blocks, and the main extensibility API is the Block API. It allows you to create your own static blocks, [Dynamic Blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) ( rendered on the server ) and also blocks capable of saving data to Post Meta for more structured content. If you want to learn more about block creation, see the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/readme.md) for the best place to start. @@ -24,7 +24,7 @@ You can also filter certain aspects of the editor; this is documented on the [Ed ## Meta Boxes -Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/howto-guides/metabox/readme.md). +Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn how through these [meta data tutorials](/docs/how-to-guides/metabox/readme.md). See how the new editor [supports existing Meta Boxes](/docs/reference-guides/backward-compatibility/meta-box.md). @@ -32,7 +32,7 @@ See how the new editor [supports existing Meta Boxes](/docs/reference-guides/bac By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults. -There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/howto-guides/themes/theme-support.md). +There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/how-to-guides/themes/theme-support.md). ## Autocomplete diff --git a/docs/howto-guides/accessibility.md b/docs/how-to-guides/accessibility.md similarity index 100% rename from docs/howto-guides/accessibility.md rename to docs/how-to-guides/accessibility.md diff --git a/docs/howto-guides/assets/fancy-quote-in-inspector.png b/docs/how-to-guides/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/howto-guides/assets/fancy-quote-in-inspector.png rename to docs/how-to-guides/assets/fancy-quote-in-inspector.png diff --git a/docs/howto-guides/assets/fancy-quote-with-style.png b/docs/how-to-guides/assets/fancy-quote-with-style.png similarity index 100% rename from docs/howto-guides/assets/fancy-quote-with-style.png rename to docs/how-to-guides/assets/fancy-quote-with-style.png diff --git a/docs/howto-guides/assets/inspector.png b/docs/how-to-guides/assets/inspector.png similarity index 100% rename from docs/howto-guides/assets/inspector.png rename to docs/how-to-guides/assets/inspector.png diff --git a/docs/howto-guides/assets/js-tutorial-console-log-error.png b/docs/how-to-guides/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-console-log-error.png rename to docs/how-to-guides/assets/js-tutorial-console-log-error.png diff --git a/docs/howto-guides/assets/js-tutorial-console-log-success.png b/docs/how-to-guides/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-console-log-success.png rename to docs/how-to-guides/assets/js-tutorial-console-log-success.png diff --git a/docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png b/docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/howto-guides/assets/js-tutorial-error-blocks-undefined.png rename to docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png b/docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/howto-guides/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/howto-guides/assets/plugin-more-menu-item.png b/docs/how-to-guides/assets/plugin-more-menu-item.png similarity index 100% rename from docs/howto-guides/assets/plugin-more-menu-item.png rename to docs/how-to-guides/assets/plugin-more-menu-item.png diff --git a/docs/howto-guides/assets/plugin-post-publish-panel.png b/docs/how-to-guides/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/howto-guides/assets/plugin-post-publish-panel.png rename to docs/how-to-guides/assets/plugin-post-publish-panel.png diff --git a/docs/howto-guides/assets/plugin-post-status-info-location.png b/docs/how-to-guides/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/howto-guides/assets/plugin-post-status-info-location.png rename to docs/how-to-guides/assets/plugin-post-status-info-location.png diff --git a/docs/howto-guides/assets/plugin-pre-publish-panel.png b/docs/how-to-guides/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/howto-guides/assets/plugin-pre-publish-panel.png rename to docs/how-to-guides/assets/plugin-pre-publish-panel.png diff --git a/docs/howto-guides/assets/plugin-sidebar-closed-state.png b/docs/how-to-guides/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-closed-state.png rename to docs/how-to-guides/assets/plugin-sidebar-closed-state.png diff --git a/docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif b/docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-more-menu-item.gif rename to docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/howto-guides/assets/plugin-sidebar-open-state.png b/docs/how-to-guides/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/howto-guides/assets/plugin-sidebar-open-state.png rename to docs/how-to-guides/assets/plugin-sidebar-open-state.png diff --git a/docs/howto-guides/assets/sidebar-style-and-controls.png b/docs/how-to-guides/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/howto-guides/assets/sidebar-style-and-controls.png rename to docs/how-to-guides/assets/sidebar-style-and-controls.png diff --git a/docs/howto-guides/assets/sidebar-up-and-running.png b/docs/how-to-guides/assets/sidebar-up-and-running.png similarity index 100% rename from docs/howto-guides/assets/sidebar-up-and-running.png rename to docs/how-to-guides/assets/sidebar-up-and-running.png diff --git a/docs/howto-guides/assets/toolbar-text.png b/docs/how-to-guides/assets/toolbar-text.png similarity index 100% rename from docs/howto-guides/assets/toolbar-text.png rename to docs/how-to-guides/assets/toolbar-text.png diff --git a/docs/howto-guides/assets/toolbar-with-custom-button.png b/docs/how-to-guides/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/howto-guides/assets/toolbar-with-custom-button.png rename to docs/how-to-guides/assets/toolbar-with-custom-button.png diff --git a/docs/howto-guides/backward-compatibility/README.md b/docs/how-to-guides/backward-compatibility/README.md similarity index 100% rename from docs/howto-guides/backward-compatibility/README.md rename to docs/how-to-guides/backward-compatibility/README.md diff --git a/docs/howto-guides/backward-compatibility/deprecations.md b/docs/how-to-guides/backward-compatibility/deprecations.md similarity index 100% rename from docs/howto-guides/backward-compatibility/deprecations.md rename to docs/how-to-guides/backward-compatibility/deprecations.md diff --git a/docs/howto-guides/backward-compatibility/meta-box.md b/docs/how-to-guides/backward-compatibility/meta-box.md similarity index 98% rename from docs/howto-guides/backward-compatibility/meta-box.md rename to docs/how-to-guides/backward-compatibility/meta-box.md index 56432fd80b56d..ebffb327ffe7f 100644 --- a/docs/howto-guides/backward-compatibility/meta-box.md +++ b/docs/how-to-guides/backward-compatibility/meta-box.md @@ -1,6 +1,6 @@ # Meta Boxes -This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/howto-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. +This is a brief document detailing how meta box support works in the block editor. With the superior developer and user experience of blocks, especially once block templates are available, **porting PHP meta boxes to blocks is highly encouraged!** See the [Meta Block tutorial](/docs/how-to-guides/metabox/meta-block-1-intro.md) for how to store post meta data using blocks. ### Testing, Converting, and Maintaining Existing Meta Boxes diff --git a/docs/how-to-guides/block-based-theme/README.md b/docs/how-to-guides/block-based-theme/README.md new file mode 100644 index 0000000000000..310ec28a3ec7a --- /dev/null +++ b/docs/how-to-guides/block-based-theme/README.md @@ -0,0 +1,380 @@ +# Creating a block-based theme + +The purpose of this tutorial is to show how to create a basic block based theme +and help theme developers transition to full site editing. + +You will learn about the required files, how to combine templates and template parts, +how to add presets for global styles, and how to add blocks and export the templates in the site editor. + +Full site editing is an experimental feature and the workflow in this tutorial is likely to change. + +This tutorial is up to date as of Gutenberg version 9.1. + +## Table of Contents + + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) + +## What is needed to create a block-based theme? + +To use a block based theme you need to have Gutenberg installed and full site editing must be enabled. + +Full site editing can be enabled from the Gutenberg experiments menu in the WordPress admin area. + +A block-based theme is built using HTML templates and template parts. Templates are the main files used in the [template hierarchy](https://developer.wordpress.org/themes/basics/template-hierarchy/), for example index, single or archive. Templates can optionally include structural template parts, for example a header, footer or sidebar. + +Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. The block HTML is generated in and exported from the **site editor**. It can also be added to the theme's HTML files manually. + +### Required files and file structure + +A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. + +The theme may optionally include an [experimental-theme.json file](/docs/how-to-guides/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. + +Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: + +``` +theme +|__ style.css +|__ functions.php +|__ index.php +|__ experimental-theme.json +|__ block-templates + |__ index.html + |__ single.html + |__ archive.html + |__ ... +|__ block-template-parts + |__ header.html + |__ footer.html + |__ sidebar.html + |__ ... +``` + +## Creating the theme + +Create a new folder for your theme in `/wp-content/themes/`. +Inside this folder, create the `block-templates` and `block-template-parts` folders. + +Create a `style.css` file. The file header in the `style.css` file has [the same items that you would use in a traditional theme](https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/#explanations). + +``` +/* +Theme Name: My first theme +Theme URI: +Author: The WordPress team +Author URI: https://wordpress.org/ +Description: +Tags: +Version: 1.0.0 +Requires at least: 5.0 +Tested up to: 5.4 +Requires PHP: 7.0 +License: GNU General Public License v2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html +Text Domain: myfirsttheme + +This theme, like WordPress, is licensed under the GPL. +Use it to make something cool, have fun, and share what you've learned with others. +*/ +``` + +Create a `functions.php` file. + +In this file, you will enqueue the `style.css` file and add any theme support that you want to use. For example colors, wide blocks and featured images. + +_You no longer need to add theme support for the title tag. It is already enabled with full site editing._ + +https://developer.wordpress.org/themes/basics/theme-functions/#what-is-functions-php + +https://developer.wordpress.org/block-editor/developers/themes/theme-support/ + +```php +. + */ + add_theme_support( 'automatic-feed-links' ); + + /** + * Enable support for post thumbnails and featured images. + */ + add_theme_support( 'post-thumbnails' ); + + add_theme_support( 'editor-color-palette', array( + array( + 'name' => __( 'strong magenta', 'myfirsttheme' ), + 'slug' => 'strong-magenta', + 'color' => '#a156b4', + ), + array( + 'name' => __( 'very dark gray', 'myfirsttheme' ), + 'slug' => 'very-dark-gray', + 'color' => '#444', + ), + ) ); + + add_theme_support( 'wp-block-styles' ); + + add_theme_support( 'align-wide' ); +} +endif; // myfirsttheme_setup +add_action( 'after_setup_theme', 'myfirsttheme_setup' ); + +/** + * Enqueue theme scripts and styles. + */ +function myfirsttheme_scripts() { + wp_enqueue_style( 'myfirsttheme-style', get_stylesheet_uri() ); + + if ( is_singular() && comments_open() && get_option( 'thread_comments' ) ) { + wp_enqueue_script( 'comment-reply' ); + } +} +add_action( 'wp_enqueue_scripts', 'myfirsttheme_scripts' ); +``` + +Create an `index.php` file. +This file is used as a fallback if the theme is activated when full site editing is not enabled. +You may leave the file empty for this tutorial. + +Your theme should now include the following files and folders: + +``` +theme + |__ style.css + |__ functions.php + |__ index.php + |__ block-templates + |__ (empty folder) + |__ block-template-parts + |__ (empty folder) +``` + +### Creating the templates and template parts + +Create two template parts called `footer.html` and `header.html` and place them inside the `block-template-parts` folder. You can leave the files empty for now. + +Inside the block-templates folder, create an `index.html` file. + +In `index.html`, include the template parts by adding two HTML comments. + +The HTML comments starts with `wp:template-part` which is the name of the template-part block type. Inside the curly brackets are two keys and their values: The slug of the template part, and the theme name. + +``` + + + +``` + +If you used a different theme name, adjust the value for the theme key. + +Eventually, you will be able to create and combine templates and template parts directly in the site editor. + +### Experimental-theme.json - Global styles + +The purpose of the `experimental-theme.json` file is to make it easier to style blocks by setting defaults. + +It is used to: + * Create CSS variables (also called CSS custom properties) that can be used to style blocks both on the front and in the editor. + * Set global styles. + * Set styles for individual block types. + +[The documentation for global styles contains a list of available block and style combinations.](https://developer.wordpress.org/block-editor/developers/themes/theme-json/) + +Create a file called `experimental-theme.json` and save it inside the main folder. + +CSS variables are generated using **Global presets**. The variables are added to the `:root` on the front, and to the `.editor-styles-wrapper` class in the editor. + +Styles that are added to the themes `style.css` file or an editor style sheet are loaded after global styles. + +Add the following global presets to the `experimental-theme.json` file: + +``` +{ + "global": { + "settings": { + "color": { + "palette": [ + { + "slug": "strong-magenta", + "color": "#a156b4" + }, + { + "slug": "very-dark-gray", + "color": "#444" + }, + ] + }, + "custom": { + "line-height": [ + { + "small": "1.3" + }, + { + "medium": "2" + }, + { + "large": "2.5" + } + ] + } + } + } +} +``` + +This code generates the following variables: +``` + --wp--preset--color--strong-magenta: #a156b4; + --wp--preset--color--very-dark-gray: #444; + + --wp--custom--line-height--small: 1.3; + --wp--custom--line-height--medium: 2; + --wp--custom--line-height--large: 2.5; +``` + +**Global styles** are used to set default values for the website and for the blocks. + +This example will add the dark grey color as the website background color. +Add the code inside the globals, after the presets: +``` + "styles": { + "color": { + "background": "var(--wp--preset--color--very-dark-gray)" + } + } +``` + +**Block styles** sets default values for all blocks of a specific type. + +This example uses the CSS variables to add text color and line height to the H2 heading block, +in combination with a custom font size. + +When adding styles for the headings block, include the heading level, h1 to h6. + +Block styles are separate from global styles. Add the code after the globals, but before the closing brace. + +``` +"core/heading/h2": { + "styles": { + "color": { + "text": "var( --wp--preset--color--strong-magenta )" + }, + "typography": { + "fontSize": "2.5rem", + "lineHeight": "var(--wp--custom--line-height--medium)" + } + } +}, +``` + +CSS variables for font sizes are generated using the `editor-font-sizes` theme support or by adding a global preset. + +https://developer.wordpress.org/block-editor/developers/themes/theme-support/#block-font-sizes + +If the theme does not add any custom font sizes, variables are created using the default sizes. +This example adds the default medium font size to the paragraph block. + +The font sizes are unitless, which is why calc is used: https://developer.mozilla.org/en-US/docs/Web/CSS/calc + +``` +"core/paragraph": { + "styles": { + "typography": { + "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" + } + } +}, +``` + +Using the CSS variables is optional. In this example, the default background color for the group block is changed to white using a color code: + +``` +"core/group": { + "styles": { + "color": { + "background": "#ffffff" + } + } +} +``` + +Below are the presets and styles combined: + +``` +{ + "global": { + "settings": { + "color": { + "palette": [ + { + "slug": "strong-magenta", + "color": "#a156b4" + }, + { + "slug": "very-dark-gray", + "color": "#444" + }, + ] + }, + "custom": { + "line-height": [ + { + "small": "1.3" + }, + { + "medium": "2" + }, + { + "large": "2.5" + } + ] + } + } + }, + + "core/heading/h2": { + "styles": { + "color": { + "text": "var( --wp--preset--color--strong-magenta )" + }, + "typography": { + "fontSize": "2.5rem", + "lineHeight": "var(--wp--custom--line-height--medium)" + } + } + }, + + "core/paragraph": { + "styles": { + "typography": { + "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" + } + } + }, + + "core/group": { + "styles": { + "color": { + "background": "#ffffff" + } + } + } +} +``` + +## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) diff --git a/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md b/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md new file mode 100644 index 0000000000000..c1e5a2d6a4658 --- /dev/null +++ b/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md @@ -0,0 +1,55 @@ +# Adding blocks to your theme + +Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. + +There is more than one way to add blocks to the theme files: + +- Adding and editing blocks in the site editor and exporting the theme. +- Adding block HTML and comments to the HTML files manually. + +## Working with blocks and templates in the site editor + +The beta site editor is available from the WordPress admin area when full site editing is enabled. To use the site editor, a full site editing theme must be installed and active. + +The site editor is similar to the block editor, but is used for the site layout instead of the post and page content. + +Two new menus have been added to the top toolbar of the editor: + +One that shows a list of posts, pages and categories, and indicates the item that is used as the front page. + +![Site editor toolbar page menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-page-menu.png) + +And a list of templates and template parts, that indicates the item that is being edited. Hovering over the parts will show a preview. + +![Site editor toolbar template menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-template-menu.png) + +Template parts can be selected and edited directly in the site editor, like other blocks: + +![A selected template part is highlighted. When selected, the template part has a limited set of alignment controls in the block toolbar](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-editor-template-part.png) + +Select the header template part in the menu to view and edit it individually. Add the blocks that you would like in your header, for example a site title block, a navigation block, and an image. + +Next, select the footer template part and add some content, for example widget blocks. + +Select the index template again to view the template parts together in the page context. + +To add a post loop to the index template, add a **query** block. The query block includes the query loop and the query pagination. The default loop displays the post title and post content. The query loop and query pagination are also available as individual blocks. + + +## Saving templates and template parts + +When you have made your changes, click on the **update design** button in the upper right corner, +where you normally publish and update your content. + +Select the templates and template parts that you want to save: + +![The save menu displays a list of templates and template parts with checkboxes](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-save.png) + +When you save changes in the site editor, the files in the active theme are not updated. Instead, the templates and template parts are saved as custom post types, that are accessed via the appearance menu. + +![The template parts view in the admin area displays a list of all saved template parts](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-appearance-template-parts.png) + + +## Exporting changes + +Saved templates and template parts can be exported as a partial theme from the Tools menu in the site editor. The block HTML code can then be copied to the theme that you are editing. diff --git a/docs/howto-guides/block-tutorial/README.md b/docs/how-to-guides/block-tutorial/README.md similarity index 91% rename from docs/howto-guides/block-tutorial/README.md rename to docs/how-to-guides/block-tutorial/README.md index b4b2b05a39dd2..d16645fdf45e0 100644 --- a/docs/howto-guides/block-tutorial/README.md +++ b/docs/how-to-guides/block-tutorial/README.md @@ -4,6 +4,6 @@ The purpose of this tutorial is to step through the fundamentals of creating a n To follow along with this tutorial, you can [download the accompanying WordPress plugin](https://github.com/WordPress/gutenberg-examples) which includes all of the examples for you to try on your own site. At each step along the way, experiment by modifying the examples with your own ideas, and observe the effects they have on the block's behavior. -Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/howto-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. +Code snippets are provided in two formats "ES5" and "ESNext". ES5 refers to "classic" JavaScript (ECMAScript 5), while ESNext refers to the next versions of the language standard, plus JSX syntax. You can change between them using tabs found above each code example. Using ESNext, does require you to run [the JavaScript build step](/docs/how-to-guides/javascript/js-build-setup/) to compile your code to a browser compatible format. Note that it is not required to use ESNext to create blocks or extend the editor, you can use classic JavaScript. However, once familiar with ESNext, developers find it is easier to read and write, thus most code examples you'll find use the ESNext syntax. diff --git a/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md b/docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md similarity index 100% rename from docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md rename to docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md diff --git a/docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md similarity index 100% rename from docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md rename to docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md diff --git a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md b/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md similarity index 97% rename from docs/howto-guides/block-tutorial/creating-dynamic-blocks.md rename to docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md index 443dce0e2477b..bcd7fc023eba8 100644 --- a/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md +++ b/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md @@ -9,7 +9,7 @@ There are two primary uses for dynamic blocks: For many dynamic blocks, the `save` callback function should be returned as `null`, which tells the editor to save only the [block attributes](/docs/reference-guides/block-api/block-attributes.md) to the database. These attributes are then passed into the server-side rendering callback, so you can decide how to display the block on the front end of your site. When you return `null`, the editor will skip the block markup validation process, avoiding issues with frequently-changing markup. -If you are using [InnerBlocks](/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` +If you are using [InnerBlocks](/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md) in a dynamic block you will need to save the `InnerBlocks` in the `save` callback function using `` You can also save an HTML representation of the block. If you provide a server-side rendering callback, this HTML will be replaced with the output of your callback, but will be rendered if your block is deactivated or your render callback is removed. diff --git a/docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md b/docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md similarity index 100% rename from docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md rename to docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md diff --git a/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md b/docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md similarity index 100% rename from docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md rename to docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md diff --git a/docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md b/docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md similarity index 100% rename from docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md rename to docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md diff --git a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md b/docs/how-to-guides/block-tutorial/writing-your-first-block-type.md similarity index 98% rename from docs/howto-guides/block-tutorial/writing-your-first-block-type.md rename to docs/how-to-guides/block-tutorial/writing-your-first-block-type.md index 537e233a1645e..55faf6d69f757 100644 --- a/docs/howto-guides/block-tutorial/writing-your-first-block-type.md +++ b/docs/how-to-guides/block-tutorial/writing-your-first-block-type.md @@ -36,7 +36,7 @@ function gutenberg_examples_01_register_block() { add_action( 'init', 'gutenberg_examples_01_register_block' ); ``` -Note the above example, shows using the [wp-scripts build step](/docs/howto-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. +Note the above example, shows using the [wp-scripts build step](/docs/how-to-guides/javascript/js-build-setup/) that automatically sets dependencies and versions the file. If you were using the ES5 code, you would specify `array( 'wp-blocks', 'wp-element' )` as the dependency array. See the [example 01](https://github.com/WordPress/gutenberg-examples/blob/HEAD/01-basic/index.php) in Gutenberg Examples repository for full syntax. diff --git a/docs/howto-guides/designers/README.md b/docs/how-to-guides/designers/README.md similarity index 100% rename from docs/howto-guides/designers/README.md rename to docs/how-to-guides/designers/README.md diff --git a/docs/howto-guides/designers/animation.md b/docs/how-to-guides/designers/animation.md similarity index 100% rename from docs/howto-guides/designers/animation.md rename to docs/how-to-guides/designers/animation.md diff --git a/docs/howto-guides/designers/assets/advanced-settings-do.png b/docs/how-to-guides/designers/assets/advanced-settings-do.png similarity index 100% rename from docs/howto-guides/designers/assets/advanced-settings-do.png rename to docs/how-to-guides/designers/assets/advanced-settings-do.png diff --git a/docs/howto-guides/designers/assets/block-controls-do.png b/docs/how-to-guides/designers/assets/block-controls-do.png similarity index 100% rename from docs/howto-guides/designers/assets/block-controls-do.png rename to docs/how-to-guides/designers/assets/block-controls-do.png diff --git a/docs/howto-guides/designers/assets/block-controls-dont.png b/docs/how-to-guides/designers/assets/block-controls-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/block-controls-dont.png rename to docs/how-to-guides/designers/assets/block-controls-dont.png diff --git a/docs/howto-guides/designers/assets/block-descriptions-do.png b/docs/how-to-guides/designers/assets/block-descriptions-do.png similarity index 100% rename from docs/howto-guides/designers/assets/block-descriptions-do.png rename to docs/how-to-guides/designers/assets/block-descriptions-do.png diff --git a/docs/howto-guides/designers/assets/block-descriptions-dont.png b/docs/how-to-guides/designers/assets/block-descriptions-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/block-descriptions-dont.png rename to docs/how-to-guides/designers/assets/block-descriptions-dont.png diff --git a/docs/howto-guides/designers/assets/blocks-do.png b/docs/how-to-guides/designers/assets/blocks-do.png similarity index 100% rename from docs/howto-guides/designers/assets/blocks-do.png rename to docs/how-to-guides/designers/assets/blocks-do.png diff --git a/docs/howto-guides/designers/assets/blocks-dont.png b/docs/how-to-guides/designers/assets/blocks-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/blocks-dont.png rename to docs/how-to-guides/designers/assets/blocks-dont.png diff --git a/docs/howto-guides/designers/assets/placeholder-do.png b/docs/how-to-guides/designers/assets/placeholder-do.png similarity index 100% rename from docs/howto-guides/designers/assets/placeholder-do.png rename to docs/how-to-guides/designers/assets/placeholder-do.png diff --git a/docs/howto-guides/designers/assets/placeholder-dont.png b/docs/how-to-guides/designers/assets/placeholder-dont.png similarity index 100% rename from docs/howto-guides/designers/assets/placeholder-dont.png rename to docs/how-to-guides/designers/assets/placeholder-dont.png diff --git a/docs/howto-guides/designers/block-design.md b/docs/how-to-guides/designers/block-design.md similarity index 98% rename from docs/howto-guides/designers/block-design.md rename to docs/how-to-guides/designers/block-design.md index 233d0476fa9fe..818dd4436962d 100644 --- a/docs/howto-guides/designers/block-design.md +++ b/docs/how-to-guides/designers/block-design.md @@ -132,7 +132,7 @@ Check how your block looks, feels, and works on as many devices and screen sizes ### Support Gutenberg's dark background editor scheme -Check how your block looks with [dark backgrounds](/docs/howto-guides/themes/theme-support.md#dark-backgrounds) in the editor. +Check how your block looks with [dark backgrounds](/docs/how-to-guides/themes/theme-support.md#dark-backgrounds) in the editor. ## Examples diff --git a/docs/howto-guides/designers/design-resources.md b/docs/how-to-guides/designers/design-resources.md similarity index 100% rename from docs/howto-guides/designers/design-resources.md rename to docs/how-to-guides/designers/design-resources.md diff --git a/docs/howto-guides/designers/user-interface.md b/docs/how-to-guides/designers/user-interface.md similarity index 100% rename from docs/howto-guides/designers/user-interface.md rename to docs/how-to-guides/designers/user-interface.md diff --git a/docs/howto-guides/feature-flags.md b/docs/how-to-guides/feature-flags.md similarity index 100% rename from docs/howto-guides/feature-flags.md rename to docs/how-to-guides/feature-flags.md diff --git a/docs/howto-guides/format-api/1-register-format.md b/docs/how-to-guides/format-api/1-register-format.md similarity index 100% rename from docs/howto-guides/format-api/1-register-format.md rename to docs/how-to-guides/format-api/1-register-format.md diff --git a/docs/howto-guides/format-api/2-toolbar-button.md b/docs/how-to-guides/format-api/2-toolbar-button.md similarity index 100% rename from docs/howto-guides/format-api/2-toolbar-button.md rename to docs/how-to-guides/format-api/2-toolbar-button.md diff --git a/docs/howto-guides/format-api/3-apply-format.md b/docs/how-to-guides/format-api/3-apply-format.md similarity index 100% rename from docs/howto-guides/format-api/3-apply-format.md rename to docs/how-to-guides/format-api/3-apply-format.md diff --git a/docs/howto-guides/format-api/README.md b/docs/how-to-guides/format-api/README.md similarity index 74% rename from docs/howto-guides/format-api/README.md rename to docs/how-to-guides/format-api/README.md index 74b742db7bebd..bc028f4f07317 100644 --- a/docs/howto-guides/format-api/README.md +++ b/docs/how-to-guides/format-api/README.md @@ -4,10 +4,10 @@ The purpose of this tutorial is to introduce you to the Format API. The Format A In WordPress lingo, a _format_ is a [HTML tag with text-level semantics](https://www.w3.org/TR/html5/textlevel-semantics.html#text-level-semantics-usage-summary) used to give some special meaning to a text selection. For example, in this tutorial, the button to be hooked into the format toolbar will let users wrap a particular text selection with the [`` HTML tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/samp). -If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/howto-guides/javascript/readme.md) first. +If you are unfamiliar with how to work with WordPress plugins and JavaScript, you may want to check the [JavaScript Tutorial](/docs/how-to-guides/javascript/readme.md) first. ## Table of Contents -1. [Register a new format](/docs/howto-guides/format-api/1-register-format.md) -2. [Add a button to the toolbar](/docs/howto-guides/format-api/2-toolbar-button.md) -3. [Apply the format when the button is clicked](/docs/howto-guides/format-api/3-apply-format.md) +1. [Register a new format](/docs/how-to-guides/format-api/1-register-format.md) +2. [Add a button to the toolbar](/docs/how-to-guides/format-api/2-toolbar-button.md) +3. [Apply the format when the button is clicked](/docs/how-to-guides/format-api/3-apply-format.md) diff --git a/docs/howto-guides/internationalization.md b/docs/how-to-guides/internationalization.md similarity index 100% rename from docs/howto-guides/internationalization.md rename to docs/how-to-guides/internationalization.md diff --git a/docs/howto-guides/javascript/README.md b/docs/how-to-guides/javascript/README.md similarity index 59% rename from docs/howto-guides/javascript/README.md rename to docs/how-to-guides/javascript/README.md index b505191c791be..b31b0fa4d9989 100644 --- a/docs/howto-guides/javascript/README.md +++ b/docs/how-to-guides/javascript/README.md @@ -10,11 +10,11 @@ The block editor introduced in WordPress 5.0 is written in JavaScript, with the ### Table of Contents -1. [Plugins Background](/docs/howto-guides/javascript/plugins-background.md) -2. [Loading JavaScript](/docs/howto-guides/javascript/loading-javascript.md) -3. [Extending the Block Editor](/docs/howto-guides/javascript/extending-the-block-editor.md) -4. [Troubleshooting](/docs/howto-guides/javascript/troubleshooting.md) -5. [JavaScript Versions and Building](/docs/howto-guides/javascript/versions-and-building.md) -6. [Scope your code](/docs/howto-guides/javascript/scope-your-code.md) -7. [JavaScript Build Step](/docs/howto-guides/javascript/js-build-setup.md) -8. [ESNext Syntax](/docs/howto-guides/javascript/esnext-js.md) +1. [Plugins Background](/docs/how-to-guides/javascript/plugins-background.md) +2. [Loading JavaScript](/docs/how-to-guides/javascript/loading-javascript.md) +3. [Extending the Block Editor](/docs/how-to-guides/javascript/extending-the-block-editor.md) +4. [Troubleshooting](/docs/how-to-guides/javascript/troubleshooting.md) +5. [JavaScript Versions and Building](/docs/how-to-guides/javascript/versions-and-building.md) +6. [Scope your code](/docs/how-to-guides/javascript/scope-your-code.md) +7. [JavaScript Build Step](/docs/how-to-guides/javascript/js-build-setup.md) +8. [ESNext Syntax](/docs/how-to-guides/javascript/esnext-js.md) diff --git a/docs/howto-guides/javascript/esnext-js.md b/docs/how-to-guides/javascript/esnext-js.md similarity index 100% rename from docs/howto-guides/javascript/esnext-js.md rename to docs/how-to-guides/javascript/esnext-js.md diff --git a/docs/howto-guides/javascript/extending-the-block-editor.md b/docs/how-to-guides/javascript/extending-the-block-editor.md similarity index 100% rename from docs/howto-guides/javascript/extending-the-block-editor.md rename to docs/how-to-guides/javascript/extending-the-block-editor.md diff --git a/docs/howto-guides/javascript/js-build-setup.md b/docs/how-to-guides/javascript/js-build-setup.md similarity index 96% rename from docs/howto-guides/javascript/js-build-setup.md rename to docs/how-to-guides/javascript/js-build-setup.md index ddff1bb175888..b3b4eeaf035ec 100644 --- a/docs/howto-guides/javascript/js-build-setup.md +++ b/docs/how-to-guides/javascript/js-build-setup.md @@ -2,7 +2,7 @@ ESNext is JavaScript written using syntax and features only available in a version newer than browser support—the support browser versions is referred to as ECMAScript 5 (ES5). [JSX](https://reactjs.org/docs/introducing-jsx.html) is a custom syntax extension to JavaScript, created by React project, that allows you to write JavaScript using a familiar HTML tag-like syntax. -See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. Let's set up your development environment to use these syntaxes, we'll cover development for your plugin to work with the Gutenberg project (ie: the block editor). If you want to develop on Gutenberg itself, see the [Getting Started](/docs/contributors/code/getting-started.md) documentation. @@ -125,7 +125,7 @@ To configure npm to run a script, you use the scripts section in `package.json` You can then run the build using: `npm run build`. -After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/howto-guides/javascript/loading-javascript.md), and the block will load in the editor. +After the build finishes, you will see the built file created at `build/index.js`. Enqueue this file in the admin screen as you would any JavaScript in WordPress, see [loading JavaScript step in this tutorial](/docs/how-to-guides/javascript/loading-javascript.md), and the block will load in the editor. ## Development Mode diff --git a/docs/howto-guides/javascript/loading-javascript.md b/docs/how-to-guides/javascript/loading-javascript.md similarity index 100% rename from docs/howto-guides/javascript/loading-javascript.md rename to docs/how-to-guides/javascript/loading-javascript.md diff --git a/docs/howto-guides/javascript/plugins-background.md b/docs/how-to-guides/javascript/plugins-background.md similarity index 100% rename from docs/howto-guides/javascript/plugins-background.md rename to docs/how-to-guides/javascript/plugins-background.md diff --git a/docs/howto-guides/javascript/scope-your-code.md b/docs/how-to-guides/javascript/scope-your-code.md similarity index 100% rename from docs/howto-guides/javascript/scope-your-code.md rename to docs/how-to-guides/javascript/scope-your-code.md diff --git a/docs/howto-guides/javascript/troubleshooting.md b/docs/how-to-guides/javascript/troubleshooting.md similarity index 94% rename from docs/howto-guides/javascript/troubleshooting.md rename to docs/how-to-guides/javascript/troubleshooting.md index bb2bc57fd5633..30179342bc5ac 100644 --- a/docs/howto-guides/javascript/troubleshooting.md +++ b/docs/how-to-guides/javascript/troubleshooting.md @@ -55,7 +55,7 @@ If you are not seeing your changes, and no errors, check that your JavaScript fi If you do not see the file being loaded, double check the enqueue function is correct. You can also check your server logs to see if there is an error messages. -Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/howto-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. +Add a test message to confirm your JavaScript is loading, add a `console.log("Here");` at the top of your code, and confirm the message is shown. If not, it is likely the file is not loading properly, [review the loading JavaScript page](/docs/how-to-guides/javascript/loading-javascript.md) for details on enqueuing JavaScript properly. ## Confirm all dependencies are loading @@ -73,4 +73,4 @@ wp_enqueue_script( ); ``` -For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/howto-guides/javascript/js-build-setup.md#dependency-management). +For automated dependency management, it is recommended to [use wp-scripts to build step your JavaScript](/docs/how-to-guides/javascript/js-build-setup.md#dependency-management). diff --git a/docs/howto-guides/javascript/versions-and-building.md b/docs/how-to-guides/javascript/versions-and-building.md similarity index 82% rename from docs/howto-guides/javascript/versions-and-building.md rename to docs/how-to-guides/javascript/versions-and-building.md index 9c13413d4b813..afe4c365b51d7 100644 --- a/docs/howto-guides/javascript/versions-and-building.md +++ b/docs/how-to-guides/javascript/versions-and-building.md @@ -10,6 +10,6 @@ Additionally, the ESNext code examples in the handbook include [JSX syntax](http For simplicity, the JavaScript tutorial uses the ES5 definition, without JSX. This code can run straight in your browser and does not require an additional build step. In many cases, it is perfectly fine to follow the same approach for simple plugins or experimenting. As your codebase grows in complexity it might be a good idea to switch to ESNext. You will find the majority of code and documentation across the block editor uses ESNext. -See the [JavaScript Build Setup documentation](/docs/howto-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. +See the [JavaScript Build Setup documentation](/docs/how-to-guides/javascript/js-build-setup.md) for setting up a development environment using ESNext syntax. -See the [ESNext syntax documentation](/docs/howto-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. +See the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) for explanation and examples about common code differences between standard JavaScript and ESNext. diff --git a/docs/howto-guides/metabox/README.md b/docs/how-to-guides/metabox/README.md similarity index 83% rename from docs/howto-guides/metabox/README.md rename to docs/how-to-guides/metabox/README.md index 47c071489f00e..a35a9edac92a3 100644 --- a/docs/howto-guides/metabox/README.md +++ b/docs/how-to-guides/metabox/README.md @@ -10,9 +10,9 @@ Here are two mini-tutorials for creating similar functionality to meta boxes in The first method is to use Blocks to store extra data with a post. The data is stored in a post meta field, similar to how meta boxes store information. -* [Store Post Meta with a Block](/docs/howto-guides/metabox/meta-block-1-intro.md) +* [Store Post Meta with a Block](/docs/how-to-guides/metabox/meta-block-1-intro.md) ## Sidebar Plugin -If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md/). +If you are interested in working with the post meta outside the editor, check out the [Sidebar Tutorial](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md/). diff --git a/docs/howto-guides/metabox/meta-block-1-intro.md b/docs/how-to-guides/metabox/meta-block-1-intro.md similarity index 63% rename from docs/howto-guides/metabox/meta-block-1-intro.md rename to docs/how-to-guides/metabox/meta-block-1-intro.md index 1a02e4ec6fad1..4e13ac7a7d3d0 100644 --- a/docs/howto-guides/metabox/meta-block-1-intro.md +++ b/docs/how-to-guides/metabox/meta-block-1-intro.md @@ -6,12 +6,12 @@ In this short tutorial you will create one of these blocks, which will prompt a For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/architecture/key-concepts.md) of the handbook. -Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/howto-guides/javascript/readme.md) for information setting up a plugin. +Before starting this tutorial, you will need a plugin to hold your code. Please take a look at the first two steps of [the JavaScript tutorial](/docs/how-to-guides/javascript/readme.md) for information setting up a plugin. ## Table of Contents -1. [Register Meta Field](/docs/howto-guides/metabox/meta-block-2-register-meta.md) -2. [Add Meta Block](/docs/howto-guides/metabox/meta-block-3-add.md) -3. [Use Post Meta Data](/docs/howto-guides/metabox/meta-block-4-use-data.md) -4. [Finishing Touches](/docs/howto-guides/metabox/meta-block-5-finishing.md) +1. [Register Meta Field](/docs/how-to-guides/metabox/meta-block-2-register-meta.md) +2. [Add Meta Block](/docs/how-to-guides/metabox/meta-block-3-add.md) +3. [Use Post Meta Data](/docs/how-to-guides/metabox/meta-block-4-use-data.md) +4. [Finishing Touches](/docs/how-to-guides/metabox/meta-block-5-finishing.md) diff --git a/docs/howto-guides/metabox/meta-block-2-register-meta.md b/docs/how-to-guides/metabox/meta-block-2-register-meta.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-2-register-meta.md rename to docs/how-to-guides/metabox/meta-block-2-register-meta.md diff --git a/docs/howto-guides/metabox/meta-block-3-add.md b/docs/how-to-guides/metabox/meta-block-3-add.md similarity index 91% rename from docs/howto-guides/metabox/meta-block-3-add.md rename to docs/how-to-guides/metabox/meta-block-3-add.md index ae88a63e17e3b..aa138b1418d3c 100644 --- a/docs/howto-guides/metabox/meta-block-3-add.md +++ b/docs/how-to-guides/metabox/meta-block-3-add.md @@ -1,6 +1,6 @@ # Create Meta Block -With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/howto-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. +With the meta field registered in the previous step, next you will create a new block used to display the field value to the user. See the [Block Tutorial](/docs/how-to-guides/block-tutorial/readme.md) for a deeper understanding of creating custom blocks. For this block, you will use the TextControl component, which is similar to an HTML input text field. For additional components, check out the [Component Reference](/packages/components/README.md). @@ -138,4 +138,4 @@ You can now edit a draft post and add a Meta Block to the post. You will see you ![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) -You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/howto-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. +You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/how-to-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/howto-guides/metabox/meta-block-4-use-data.md b/docs/how-to-guides/metabox/meta-block-4-use-data.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-4-use-data.md rename to docs/how-to-guides/metabox/meta-block-4-use-data.md diff --git a/docs/howto-guides/metabox/meta-block-5-finishing.md b/docs/how-to-guides/metabox/meta-block-5-finishing.md similarity index 100% rename from docs/howto-guides/metabox/meta-block-5-finishing.md rename to docs/how-to-guides/metabox/meta-block-5-finishing.md diff --git a/docs/howto-guides/metabox/meta-block.png b/docs/how-to-guides/metabox/meta-block.png similarity index 100% rename from docs/howto-guides/metabox/meta-block.png rename to docs/how-to-guides/metabox/meta-block.png diff --git a/docs/howto-guides/notices/README.md b/docs/how-to-guides/notices/README.md similarity index 95% rename from docs/howto-guides/notices/README.md rename to docs/how-to-guides/notices/README.md index 7bef4e05911ec..85e2aa1acc61a 100644 --- a/docs/howto-guides/notices/README.md +++ b/docs/how-to-guides/notices/README.md @@ -71,7 +71,7 @@ To better understand the specific code example above: * `wp.data.dispatch('core/notices')` accesses functionality registered to the block editor data store by the Notices package. * `createNotice()` is a function offered by the Notices package to register a new notice. The block editor reads from the notice data store in order to know which notices to display. -Check out the [_Loading JavaScript_](/docs/howto-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. +Check out the [_Loading JavaScript_](/docs/how-to-guides/javascript/loading-javascript.md) tutorial for a primer on how to load your custom JavaScript into the block editor. ## Learn More diff --git a/docs/howto-guides/notices/block-editor-notice.png b/docs/how-to-guides/notices/block-editor-notice.png similarity index 100% rename from docs/howto-guides/notices/block-editor-notice.png rename to docs/how-to-guides/notices/block-editor-notice.png diff --git a/docs/howto-guides/notices/classic-editor-notice.png b/docs/how-to-guides/notices/classic-editor-notice.png similarity index 100% rename from docs/howto-guides/notices/classic-editor-notice.png rename to docs/how-to-guides/notices/classic-editor-notice.png diff --git a/docs/howto-guides/platform/README.md b/docs/how-to-guides/platform/README.md similarity index 100% rename from docs/howto-guides/platform/README.md rename to docs/how-to-guides/platform/README.md diff --git a/docs/howto-guides/platform/custom-block-editor/README.md b/docs/how-to-guides/platform/custom-block-editor/README.md similarity index 100% rename from docs/howto-guides/platform/custom-block-editor/README.md rename to docs/how-to-guides/platform/custom-block-editor/README.md diff --git a/docs/howto-guides/platform/custom-block-editor/tutorial.md b/docs/how-to-guides/platform/custom-block-editor/tutorial.md similarity index 100% rename from docs/howto-guides/platform/custom-block-editor/tutorial.md rename to docs/how-to-guides/platform/custom-block-editor/tutorial.md diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md new file mode 100644 index 0000000000000..fa33fb682c874 --- /dev/null +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md @@ -0,0 +1,12 @@ +# Creating a Sidebar for Your Plugin + +This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/how-to-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. + + In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. + +1. [Get a sidebar up and running](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) +2. [Tweak the sidebar style and add controls](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) +3. [Register a new meta field](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) +4. [Initialize the input control with the meta field value](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) +5. [Update the meta field value when input's content changes](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) +6. [Finishing touches](/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md similarity index 100% rename from docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md rename to docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md diff --git a/docs/howto-guides/themes/README.md b/docs/how-to-guides/themes/README.md similarity index 100% rename from docs/howto-guides/themes/README.md rename to docs/how-to-guides/themes/README.md diff --git a/docs/howto-guides/themes/block-based-themes.md b/docs/how-to-guides/themes/block-based-themes.md similarity index 96% rename from docs/howto-guides/themes/block-based-themes.md rename to docs/how-to-guides/themes/block-based-themes.md index c2894b72c2717..dc931cc203b11 100644 --- a/docs/howto-guides/themes/block-based-themes.md +++ b/docs/how-to-guides/themes/block-based-themes.md @@ -31,7 +31,7 @@ theme |__ ... ``` -The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/howto-guides/themes/theme-json.md) file for some styles. +The difference with existing WordPress themes is that the different templates in the template hierarchy, and template parts, are block templates instead of php files. In addition, this example includes an [`experimental-theme.json`](/docs/how-to-guides/themes/theme-json.md) file for some styles. ## What is a block template? @@ -126,7 +126,7 @@ As we're still early in the process, the number of blocks specifically dedicated ## Styling -One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/howto-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. +One of the most important aspects of themes (if not the most important) is the styling. While initially you'll be able to provide styles and enqueue them using the same hooks themes have always used, the [Global Styles](/docs/how-to-guides/themes/theme-json.md) effort will provide a scaffolding for adding many theme styles in the future. ## Resources diff --git a/docs/howto-guides/themes/theme-json.md b/docs/how-to-guides/themes/theme-json.md similarity index 100% rename from docs/howto-guides/themes/theme-json.md rename to docs/how-to-guides/themes/theme-json.md diff --git a/docs/howto-guides/themes/theme-support.md b/docs/how-to-guides/themes/theme-support.md similarity index 99% rename from docs/howto-guides/themes/theme-support.md rename to docs/how-to-guides/themes/theme-support.md index 66607e3264e32..1b434af064b1d 100644 --- a/docs/howto-guides/themes/theme-support.md +++ b/docs/how-to-guides/themes/theme-support.md @@ -360,7 +360,7 @@ To change the main column width of the editor, add the following CSS to `style-e You can use those editor widths to match those in your theme. You can use any CSS width unit, including `%` or `px`. -Further reading: [Applying Styles with Stylesheets](/docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md). +Further reading: [Applying Styles with Stylesheets](/docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md). ## Responsive embedded content diff --git a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md b/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md deleted file mode 100644 index 47978feeb0ec9..0000000000000 --- a/docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md +++ /dev/null @@ -1,12 +0,0 @@ -# Creating a Sidebar for Your Plugin - -This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/howto-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor. - - In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table. - -1. [Get a sidebar up and running](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md) -2. [Tweak the sidebar style and add controls](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md) -3. [Register a new meta field](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md) -4. [Initialize the input control with the meta field value](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md) -5. [Update the meta field value when input's content changes](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md) -6. [Finishing touches](/docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md) diff --git a/docs/manifest.json b/docs/manifest.json index 10f076a35e3dc..4fcc8896476d7 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -91,333 +91,333 @@ }, { "title": "Developer Documentation", - "slug": "howto-guides", - "markdown_source": "../docs/howto-guides/README.md", + "slug": "how-to-guides", + "markdown_source": "../docs/how-to-guides/README.md", "parent": null }, { "title": "Getting Started with JavaScript", "slug": "javascript", - "markdown_source": "../docs/howto-guides/javascript/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/javascript/README.md", + "parent": "how-to-guides" }, { "title": "Plugins Background", "slug": "plugins-background", - "markdown_source": "../docs/howto-guides/javascript/plugins-background.md", + "markdown_source": "../docs/how-to-guides/javascript/plugins-background.md", "parent": "javascript" }, { "title": "Loading JavaScript", "slug": "loading-javascript", - "markdown_source": "../docs/howto-guides/javascript/loading-javascript.md", + "markdown_source": "../docs/how-to-guides/javascript/loading-javascript.md", "parent": "javascript" }, { "title": "Extending the Block Editor", "slug": "extending-the-block-editor", - "markdown_source": "../docs/howto-guides/javascript/extending-the-block-editor.md", + "markdown_source": "../docs/how-to-guides/javascript/extending-the-block-editor.md", "parent": "javascript" }, { "title": "Troubleshooting", "slug": "troubleshooting", - "markdown_source": "../docs/howto-guides/javascript/troubleshooting.md", + "markdown_source": "../docs/how-to-guides/javascript/troubleshooting.md", "parent": "javascript" }, { "title": "JavaScript Versions and Build Step", "slug": "versions-and-building", - "markdown_source": "../docs/howto-guides/javascript/versions-and-building.md", + "markdown_source": "../docs/how-to-guides/javascript/versions-and-building.md", "parent": "javascript" }, { "title": "Scope Your Code", "slug": "scope-your-code", - "markdown_source": "../docs/howto-guides/javascript/scope-your-code.md", + "markdown_source": "../docs/how-to-guides/javascript/scope-your-code.md", "parent": "javascript" }, { "title": "JavaScript Build Setup", "slug": "js-build-setup", - "markdown_source": "../docs/howto-guides/javascript/js-build-setup.md", + "markdown_source": "../docs/how-to-guides/javascript/js-build-setup.md", "parent": "javascript" }, { "title": "ESNext Syntax", "slug": "esnext-js", - "markdown_source": "../docs/howto-guides/javascript/esnext-js.md", + "markdown_source": "../docs/how-to-guides/javascript/esnext-js.md", "parent": "javascript" }, { "title": "Meta Boxes", "slug": "metabox", - "markdown_source": "../docs/howto-guides/metabox/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/metabox/README.md", + "parent": "how-to-guides" }, { "title": "Store Post Meta with a Block", "slug": "meta-block-1-intro", - "markdown_source": "../docs/howto-guides/metabox/meta-block-1-intro.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-1-intro.md", "parent": "metabox" }, { "title": "Register Meta Field", "slug": "meta-block-2-register-meta", - "markdown_source": "../docs/howto-guides/metabox/meta-block-2-register-meta.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-2-register-meta.md", "parent": "metabox" }, { "title": "Create Meta Block", "slug": "meta-block-3-add", - "markdown_source": "../docs/howto-guides/metabox/meta-block-3-add.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-3-add.md", "parent": "metabox" }, { "title": "Use Post Meta Data", "slug": "meta-block-4-use-data", - "markdown_source": "../docs/howto-guides/metabox/meta-block-4-use-data.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-4-use-data.md", "parent": "metabox" }, { "title": "Finishing Touches", "slug": "meta-block-5-finishing", - "markdown_source": "../docs/howto-guides/metabox/meta-block-5-finishing.md", + "markdown_source": "../docs/how-to-guides/metabox/meta-block-5-finishing.md", "parent": "metabox" }, { "title": "Displaying Notices from Your Plugin or Theme", "slug": "notices", - "markdown_source": "../docs/howto-guides/notices/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/notices/README.md", + "parent": "how-to-guides" }, { "title": "Creating a Sidebar for Your Plugin", "slug": "plugin-sidebar-0", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md", + "parent": "how-to-guides" }, { "title": "Get a Sidebar up and Running", "slug": "plugin-sidebar-1-up-and-running", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md", "parent": "plugin-sidebar-0" }, { "title": "Tweak the sidebar style and add controls", "slug": "plugin-sidebar-2-styles-and-controls", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md", "parent": "plugin-sidebar-0" }, { "title": "Register the Meta Field", "slug": "plugin-sidebar-3-register-meta", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md", "parent": "plugin-sidebar-0" }, { "title": "Initialize the Input Control", "slug": "plugin-sidebar-4-initialize-input", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md", "parent": "plugin-sidebar-0" }, { "title": "Update the Meta Field When the Input's Content Changes", "slug": "plugin-sidebar-5-update-meta", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md", "parent": "plugin-sidebar-0" }, { "title": "Finishing Touches", "slug": "plugin-sidebar-6-finishing-touches", - "markdown_source": "../docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", + "markdown_source": "../docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md", "parent": "plugin-sidebar-0" }, { "title": "Blocks", "slug": "block-tutorial", - "markdown_source": "../docs/howto-guides/block-tutorial/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/block-tutorial/README.md", + "parent": "how-to-guides" }, { "title": "Writing Your First Block Type", "slug": "writing-your-first-block-type", - "markdown_source": "../docs/howto-guides/block-tutorial/writing-your-first-block-type.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/writing-your-first-block-type.md", "parent": "block-tutorial" }, { "title": "Applying Styles From a Stylesheet", "slug": "applying-styles-with-stylesheets", - "markdown_source": "../docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md", "parent": "block-tutorial" }, { "title": "Introducing Attributes and Editable Fields", "slug": "introducing-attributes-and-editable-fields", - "markdown_source": "../docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md", "parent": "block-tutorial" }, { "title": "Block Controls: Block Toolbar and Settings Sidebar", "slug": "block-controls-toolbar-and-sidebar", - "markdown_source": "../docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md", "parent": "block-tutorial" }, { "title": "Creating dynamic blocks", "slug": "creating-dynamic-blocks", - "markdown_source": "../docs/howto-guides/block-tutorial/creating-dynamic-blocks.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md", "parent": "block-tutorial" }, { "title": "Generate Blocks with WP-CLI", "slug": "generate-blocks-with-wp-cli", - "markdown_source": "../docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md", "parent": "block-tutorial" }, { "title": "Nested Blocks: Using InnerBlocks", "slug": "nested-blocks-inner-blocks", - "markdown_source": "../docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md", + "markdown_source": "../docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md", "parent": "block-tutorial" }, { "title": "Feature Flags", "slug": "feature-flags", - "markdown_source": "../docs/howto-guides/feature-flags.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/feature-flags.md", + "parent": "how-to-guides" }, { "title": "Theming for the Block Editor", "slug": "themes", - "markdown_source": "../docs/howto-guides/themes/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/themes/README.md", + "parent": "how-to-guides" }, { "title": "Theme Support", "slug": "theme-support", - "markdown_source": "../docs/howto-guides/themes/theme-support.md", + "markdown_source": "../docs/how-to-guides/themes/theme-support.md", "parent": "themes" }, { "title": "Themes & Block Editor: experimental theme.json", "slug": "theme-json", - "markdown_source": "../docs/howto-guides/themes/theme-json.md", + "markdown_source": "../docs/how-to-guides/themes/theme-json.md", "parent": "themes" }, { "title": "Creating a block-based theme", "slug": "block-based-themes", - "markdown_source": "../docs/howto-guides/block-based-themes/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/block-based-themes/README.md", + "parent": "how-to-guides" }, { "title": "Adding blocks to your theme", "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md", + "markdown_source": "../docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md", "parent": "block-based-themes" }, { "title": "Backward Compatibility", "slug": "backward-compatibility", - "markdown_source": "../docs/howto-guides/backward-compatibility/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/backward-compatibility/README.md", + "parent": "how-to-guides" }, { "title": "Deprecations", "slug": "deprecations", - "markdown_source": "../docs/howto-guides/backward-compatibility/deprecations.md", + "markdown_source": "../docs/how-to-guides/backward-compatibility/deprecations.md", "parent": "backward-compatibility" }, { "title": "Meta Boxes", "slug": "meta-box", - "markdown_source": "../docs/howto-guides/backward-compatibility/meta-box.md", + "markdown_source": "../docs/how-to-guides/backward-compatibility/meta-box.md", "parent": "backward-compatibility" }, { "title": "Introduction to the Format API", "slug": "format-api", - "markdown_source": "../docs/howto-guides/format-api/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/format-api/README.md", + "parent": "how-to-guides" }, { "title": "Register a New Format", "slug": "1-register-format", - "markdown_source": "../docs/howto-guides/format-api/1-register-format.md", + "markdown_source": "../docs/how-to-guides/format-api/1-register-format.md", "parent": "format-api" }, { "title": "Add a Button to the Toolbar", "slug": "2-toolbar-button", - "markdown_source": "../docs/howto-guides/format-api/2-toolbar-button.md", + "markdown_source": "../docs/how-to-guides/format-api/2-toolbar-button.md", "parent": "format-api" }, { "title": "Apply the Format When the Button Is Clicked", "slug": "3-apply-format", - "markdown_source": "../docs/howto-guides/format-api/3-apply-format.md", + "markdown_source": "../docs/how-to-guides/format-api/3-apply-format.md", "parent": "format-api" }, { "title": "Gutenberg as a Development Platform", "slug": "platform", - "markdown_source": "../docs/howto-guides/platform/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/platform/README.md", + "parent": "how-to-guides" }, { "title": "Building a custom block editor", "slug": "custom-block-editor", - "markdown_source": "../docs/howto-guides/platform/custom-block-editor/README.md", + "markdown_source": "../docs/how-to-guides/platform/custom-block-editor/README.md", "parent": "platform" }, { "title": "Tutorial: building a custom block editor", "slug": "tutorial", - "markdown_source": "../docs/howto-guides/platform/custom-block-editor/tutorial.md", + "markdown_source": "../docs/how-to-guides/platform/custom-block-editor/tutorial.md", "parent": "custom-block-editor" }, { "title": "Designer Documentation", "slug": "designers", - "markdown_source": "../docs/howto-guides/designers/README.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/designers/README.md", + "parent": "how-to-guides" }, { "title": "Block Design", "slug": "block-design", - "markdown_source": "../docs/howto-guides/designers/block-design.md", + "markdown_source": "../docs/how-to-guides/designers/block-design.md", "parent": "designers" }, { "title": "User Interface", "slug": "user-interface", - "markdown_source": "../docs/howto-guides/designers/user-interface.md", + "markdown_source": "../docs/how-to-guides/designers/user-interface.md", "parent": "designers" }, { "title": "Resources", "slug": "design-resources", - "markdown_source": "../docs/howto-guides/designers/design-resources.md", + "markdown_source": "../docs/how-to-guides/designers/design-resources.md", "parent": "designers" }, { "title": "Animation", "slug": "animation", - "markdown_source": "../docs/howto-guides/designers/animation.md", + "markdown_source": "../docs/how-to-guides/designers/animation.md", "parent": "designers" }, { "title": "Accessibility", "slug": "accessibility", - "markdown_source": "../docs/howto-guides/accessibility.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/accessibility.md", + "parent": "how-to-guides" }, { "title": "Internationalization", "slug": "internationalization", - "markdown_source": "../docs/howto-guides/internationalization.md", - "parent": "howto-guides" + "markdown_source": "../docs/how-to-guides/internationalization.md", + "parent": "how-to-guides" }, { "title": "ReferenceGuides", diff --git a/docs/reference-guides/block-api/block-edit-save.md b/docs/reference-guides/block-api/block-edit-save.md index 17dbd38cbff41..0e56151c381b3 100644 --- a/docs/reference-guides/block-api/block-edit-save.md +++ b/docs/reference-guides/block-api/block-edit-save.md @@ -285,10 +285,10 @@ _Note:_ The save function should be a pure function that depends only on the att It can not have any side effect or retrieve information from another source, e.g. it is not possible to use the data module inside it `select( store ).selector( ... )`. This is because if the external information changes, the block may be flagged as invalid when the post is later edited ([read more about Validation](#validation)). If there is a need to have other information as part of the save, developers can consider one of these two alternatives: - - Use [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. + - Use [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) and dynamically retrieve the required information on the server. - Store the external value as an attribute which is dynamically updated in the block's `edit` function as changes occur. -For [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. +For [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md), the return value of `save` could represent a cached copy of the block's content to be shown only in case the plugin implementing the block is ever disabled. If left unspecified, the default implementation will save no markup in post content for the dynamic block, instead deferring this to always be calculated when the block is shown on the front of the site. @@ -328,7 +328,7 @@ When saving your block, you want to save the attributes in the same format speci ## Examples -Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. +Here are a couple examples of using attributes, edit, and save all together. For a full working example, see the [Introducing Attributes and Editable Fields](/docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md) section of the Block Tutorial. ### Saving Attributes to Child Elements diff --git a/docs/reference-guides/block-api/block-metadata.md b/docs/reference-guides/block-api/block-metadata.md index a3c115f23773b..8ef4491e9756c 100644 --- a/docs/reference-guides/block-api/block-metadata.md +++ b/docs/reference-guides/block-api/block-metadata.md @@ -494,4 +494,4 @@ wp.blocks.registerBlockType( 'my-block/name', { } ); ``` -In the case of [dynamic blocks](/docs/howto-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. +In the case of [dynamic blocks](/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md) supported by WordPress, it should be still possible to register `render_callback` property using both [`register_block_type`](https://developer.wordpress.org/reference/functions/register_block_type/) and `register_block_type_from_metadata` functions on the server. diff --git a/docs/reference-guides/block-api/block-supports.md b/docs/reference-guides/block-api/block-supports.md index 0a2e36c36cf17..5b01f69086bfa 100644 --- a/docs/reference-guides/block-api/block-supports.md +++ b/docs/reference-guides/block-api/block-supports.md @@ -57,7 +57,7 @@ attributes: { - Type: `boolean` - Default value: `true` -This property allows to enable [wide alignment](/docs/howto-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. +This property allows to enable [wide alignment](/docs/how-to-guides/themes/theme-support.md#wide-alignment) for your theme. To disable this behavior for a single block, set this flag to `false`. ```js supports: { @@ -271,7 +271,7 @@ supports: { - Type: `boolean` - Default value: `false` -This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/howto-guides/themes/theme-support.md#supporting-custom-line-heights). +This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if [the theme declares support](/docs/how-to-guides/themes/theme-support.md#supporting-custom-line-heights). ```js supports: { @@ -330,7 +330,7 @@ supports: { - Subproperties: - `padding`: type `boolean`, default value `false` -This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/howto-guides/themes/theme-support.md##cover-block-padding). +This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values, if [the theme declares support](/docs/how-to-guides/themes/theme-support.md##cover-block-padding). ```js supports: { diff --git a/docs/reference-guides/block-api/block-templates.md b/docs/reference-guides/block-api/block-templates.md index 1ebd48e76bf50..d64e80028bc0b 100644 --- a/docs/reference-guides/block-api/block-templates.md +++ b/docs/reference-guides/block-api/block-templates.md @@ -59,7 +59,7 @@ registerBlockType( 'myplugin/template', { }); ``` -See the [Meta Block Tutorial](/docs/howto-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. +See the [Meta Block Tutorial](/docs/how-to-guides/metabox/meta-block-5-finishing.md) for a full example of a template in use. ## Custom Post types diff --git a/docs/reference-guides/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md index 05390c7a816a2..963f7937734c1 100644 --- a/docs/reference-guides/filters/block-filters.md +++ b/docs/reference-guides/filters/block-filters.md @@ -4,7 +4,7 @@ To modify the behavior of existing blocks, WordPress exposes several APIs: ### Block Style Variations -Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/howto-guides/javascript/) for a full example. +Block Style Variations allow providing alternative styles to existing blocks. They work by adding a className to the block's wrapper. This className can be used to provide an alternative styling for the block if the style variation is selected. See the [Getting Started with JavaScript tutorial](/docs/how-to-guides/javascript/) for a full example. _Example:_ diff --git a/docs/toc.json b/docs/toc.json index 35ac7d3b29f72..a76aa93d03210 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,175 +1,221 @@ -[ - { "docs/getting-started/README.md": [ - { "docs/getting-started/tutorials/README.md": [ - { "docs/getting-started/tutorials/devenv/README.md": [ - { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } - ] }, - { "docs/getting-started/tutorials/create-block/README.md": [ - { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, - { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, - { "docs/getting-started/tutorials/create-block/attributes.md": [] }, - { "docs/getting-started/tutorials/create-block/block-code.md": [] }, - { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } - ] } - ] }, - { "docs/getting-started/glossary.md": [] }, - { "docs/getting-started/faq.md": [] }, - { "docs/getting-started/history.md": [] }, - { "docs/getting-started/outreach.md": [] } - ] }, - { "docs/howto-guides/README.md": [ - { "docs/howto-guides/javascript/README.md": [ - { "docs/howto-guides/javascript/plugins-background.md": [] }, - { "docs/howto-guides/javascript/loading-javascript.md": [] }, - { "docs/howto-guides/javascript/extending-the-block-editor.md": [] }, - { "docs/howto-guides/javascript/troubleshooting.md": [] }, - { "docs/howto-guides/javascript/versions-and-building.md": [] }, - { "docs/howto-guides/javascript/scope-your-code.md": [] }, - { "docs/howto-guides/javascript/js-build-setup.md": [] }, - { "docs/howto-guides/javascript/esnext-js.md": [] } - ] }, - { "docs/howto-guides/metabox/README.md": [ - { "docs/howto-guides/metabox/meta-block-1-intro.md": [] }, - { "docs/howto-guides/metabox/meta-block-2-register-meta.md": [] }, - { "docs/howto-guides/metabox/meta-block-3-add.md": [] }, - { "docs/howto-guides/metabox/meta-block-4-use-data.md": [] }, - { "docs/howto-guides/metabox/meta-block-5-finishing.md": [] } - ] }, - { "docs/howto-guides/notices/README.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/howto-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] }, - { "docs/howto-guides/block-tutorial/README.md": [ - { "docs/howto-guides/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/howto-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/howto-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/howto-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/howto-guides/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/howto-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/howto-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] }, - { "docs/howto-guides/feature-flags.md": [] }, - { "docs/howto-guides/themes/README.md": [ - { "docs/howto-guides/themes/theme-support.md": [] }, - { "docs/howto-guides/themes/theme-json.md": [] } - ] }, - { "docs/howto-guides/block-based-themes/README.md": [ - { "docs/howto-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } - ] }, - { "docs/howto-guides/backward-compatibility/README.md": [ - { "docs/howto-guides/backward-compatibility/deprecations.md": [] }, - { "docs/howto-guides/backward-compatibility/meta-box.md": [] } - ] }, +[{ + "docs/getting-started/README.md": [{ + "docs/getting-started/tutorials/README.md": [{ + "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] + }, + { + "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] + } + ] + }, + { "docs/getting-started/glossary.md": [] }, + { "docs/getting-started/faq.md": [] }, + { "docs/getting-started/history.md": [] }, + { "docs/getting-started/outreach.md": [] } + ] + }, + { + "docs/how-to-guides/README.md": [{ + "docs/how-to-guides/javascript/README.md": [ + { "docs/how-to-guides/javascript/plugins-background.md": [] }, + { "docs/how-to-guides/javascript/loading-javascript.md": [] }, + { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/how-to-guides/javascript/troubleshooting.md": [] }, + { "docs/how-to-guides/javascript/versions-and-building.md": [] }, + { "docs/how-to-guides/javascript/scope-your-code.md": [] }, + { "docs/how-to-guides/javascript/js-build-setup.md": [] }, + { "docs/how-to-guides/javascript/esnext-js.md": [] } + ] + }, + { + "docs/how-to-guides/metabox/README.md": [ + { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, + { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } + ] + }, + { "docs/how-to-guides/notices/README.md": [] }, + { + "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] + }, + { + "docs/how-to-guides/block-tutorial/README.md": [ + { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] + }, + { "docs/how-to-guides/feature-flags.md": [] }, + { + "docs/how-to-guides/themes/README.md": [ + { "docs/how-to-guides/themes/theme-support.md": [] }, + { "docs/how-to-guides/themes/theme-json.md": [] } + ] + }, + { + "docs/how-to-guides/block-based-themes/README.md": [ + { "docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + ] + }, + { + "docs/how-to-guides/backward-compatibility/README.md": [ + { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, + { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } + ] + }, - { "docs/howto-guides/format-api/README.md": [ - { "docs/howto-guides/format-api/1-register-format.md": [] }, - { "docs/howto-guides/format-api/2-toolbar-button.md": [] }, - { "docs/howto-guides/format-api/3-apply-format.md": [] } - ] }, - { "docs/howto-guides/platform/README.md": [ - { "docs/howto-guides/platform/custom-block-editor/README.md": [ - { "docs/howto-guides/platform/custom-block-editor/tutorial.md": [] } - ] } - ] }, - { "docs/howto-guides/designers/README.md": [ - { "docs/howto-guides/designers/block-design.md": [] }, - { "docs/howto-guides/designers/user-interface.md": [] }, - { "docs/howto-guides/designers/design-resources.md": [] }, - { "docs/howto-guides/designers/animation.md": [] } - ] }, - { "docs/howto-guides/accessibility.md": [] }, - { "docs/howto-guides/internationalization.md": [] } - ] }, - { "docs/reference-guides/README.md": [ - { "docs/reference-guides/block-api/README.md": [ - { "docs/reference-guides/block-api/block-registration.md": [] }, - { "docs/reference-guides/block-api/block-edit-save.md": [] }, - { "docs/reference-guides/block-api/block-attributes.md": [] }, - { "docs/reference-guides/block-api/block-context.md": [] }, - { "docs/reference-guides/block-api/block-deprecation.md": [] }, - { "docs/reference-guides/block-api/block-supports.md": [] }, - { "docs/reference-guides/block-api/block-transforms.md": [] }, - { "docs/reference-guides/block-api/block-templates.md": [] }, - { "docs/reference-guides/block-api/block-metadata.md": [] }, - { "docs/reference-guides/block-api/block-patterns.md": [] }, - { "docs/reference-guides/block-api/block-annotations.md": [] }, - { "docs/reference-guides/block-api/versions.md": [] } - ] }, - { "docs/reference-guides/filters/README.md": [ - { "docs/reference-guides/filters/block-filters.md": [] }, - { "docs/reference-guides/filters/editor-filters.md": [] }, - { "docs/reference-guides/filters/parser-filters.md": [] }, - { "docs/reference-guides/filters/autocomplete-filters.md": [] } - ] }, - {"docs/reference-guides/slotfills/README.md": [ - { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, - { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, - { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } - ]}, - { "docs/reference-guides/richtext.md": [] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/reference-guides/packages.md": "{{packages}}" }, - { "docs/reference-guides/data/README.md": [ - { "docs/reference-guides/data/data-core.md": []}, - { "docs/reference-guides/data/data-core-annotations.md": [] }, - { "docs/reference-guides/data/data-core-blocks.md": [] }, - { "docs/reference-guides/data/data-core-block-editor.md": [] }, - { "docs/reference-guides/data/data-core-editor.md": [] }, - { "docs/reference-guides/data/data-core-edit-post.md": [] }, - { "docs/reference-guides/data/data-core-notices.md": [] }, - { "docs/reference-guides/data/data-core-nux.md": [] }, - { "docs/reference-guides/data/data-core-viewport.md": [] } - ] } - ] }, - { "docs/explanations/README.md": [ + { + "docs/how-to-guides/format-api/README.md": [ + { "docs/how-to-guides/format-api/1-register-format.md": [] }, + { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, + { "docs/how-to-guides/format-api/3-apply-format.md": [] } + ] + }, + { + "docs/how-to-guides/platform/README.md": [{ + "docs/how-to-guides/platform/custom-block-editor/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } + ] + }] + }, + { + "docs/how-to-guides/designers/README.md": [ + { "docs/how-to-guides/designers/block-design.md": [] }, + { "docs/how-to-guides/designers/user-interface.md": [] }, + { "docs/how-to-guides/designers/design-resources.md": [] }, + { "docs/how-to-guides/designers/animation.md": [] } + ] + }, + { "docs/how-to-guides/accessibility.md": [] }, + { "docs/how-to-guides/internationalization.md": [] } + ] + }, + { + "docs/reference-guides/README.md": [{ + "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] + }, + { + "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] + }, + { + "docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ] + }, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { + "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": [] }, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } + ] + } + ] + }, + { + "docs/explanations/README.md": [ - { "docs/explanations/architecture/README.md": [ - { "docs/explanations/architecture/key-concepts.md": [] }, - { "docs/explanations/architecture/data-flow.md": [] }, - { "docs/explanations/architecture/modularity.md": [] }, - { "docs/explanations/architecture/performance.md": [] }, - { "docs/explanations/architecture/automated-testing.md": [] }, - { "docs/explanations/architecture/full-site-editing-templates.md": [] } - ] } - ] }, - { "docs/contributors/README.md": [ - { "docs/contributors/code/develop.md": [ - { "docs/contributors/code/getting-started.md": [] }, - { "docs/contributors/code/git-workflow.md": [] }, - { "docs/contributors/code/coding-guidelines.md": [] }, - { "docs/contributors/code/testing-overview.md": [] }, - { "docs/contributors/code/grammar.md": [] }, - { "docs/contributors/code/scripts.md": [] }, - { "docs/contributors/code/managing-packages.md": [] }, - { "docs/contributors/code/release.md": [] }, - { "docs/contributors/code/native-mobile.md": [] }, - { "docs/contributors/code/getting-started-native-mobile.md": [] } - ] }, - { "docs/contributors/design/design.md": [ - { "docs/contributors/design/the-block.md": [] }, - { "docs/contributors/design/reference.md": [] } - ] }, - { "docs/contributors/documentation/document.md": [ - { "docs/contributors/documentation/copy-guide.md": [] } - ] }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/accessibility-testing.md": [] }, - { "docs/contributors/repository-management.md": [] }, - { "docs/contributors/folder-structure.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/roadmap.md": [] } - ] } -] + { + "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] + } + ] + }, + { + "docs/contributors/README.md": [{ + "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] + }, + { + "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] + }, + { + "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } + ] + }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] + } +] \ No newline at end of file From 657c8777326ab6059ff7561bd464cf98ab8572a5 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:31:17 +0100 Subject: [PATCH 49/68] Use relative link for slotfills README --- docs/how-to-guides/platform/custom-block-editor/tutorial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/platform/custom-block-editor/tutorial.md b/docs/how-to-guides/platform/custom-block-editor/tutorial.md index eef731317b1cf..62702baab2e2c 100644 --- a/docs/how-to-guides/platform/custom-block-editor/tutorial.md +++ b/docs/how-to-guides/platform/custom-block-editor/tutorial.md @@ -279,7 +279,7 @@ Here we are scaffolding the core of the editor's layout alongside a few speciali Let's examine these in more detail: * `` - enables the use of the ["Slot/Fill" - pattern](https://github.com/WordPress/gutenberg/blob/e38dbe958c04d8089695eb686d4f5caff2707505/docs/designers-developers/developers/slotfills/README.md) through our component tree. + pattern](/docs/reference-guides/slotfills/README.md) through our component tree. * `` - enables the use of [dropzones for drag and drop functionality](https://github.com/WordPress/gutenberg/tree/e38dbe958c04d8089695eb686d4f5caff2707505/packages/components/src/drop-zone). * `` - custom component. Provides a "snack bar" Notice that will be rendered if any messages are dispatched to `core/notices` store. * `
` - renders the static title "Standalone Block Editor" at the top of the From f1d1b6e2102ead0bc31319e9535ad08d2336ec57 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:33:31 +0100 Subject: [PATCH 50/68] Move assets folder to /docs directory --- .../assets/fancy-quote-in-inspector.png | Bin .../assets/fancy-quote-with-style.png | Bin docs/{how-to-guides => }/assets/inspector.png | Bin .../assets/js-tutorial-console-log-error.png | Bin .../assets/js-tutorial-console-log-success.png | Bin .../assets/js-tutorial-error-blocks-undefined.png | Bin .../plugin-block-settings-menu-item-screenshot.png | Bin .../assets/plugin-more-menu-item.png | Bin .../assets/plugin-post-publish-panel.png | Bin .../assets/plugin-post-status-info-location.png | Bin .../assets/plugin-pre-publish-panel.png | Bin .../assets/plugin-sidebar-closed-state.png | Bin .../assets/plugin-sidebar-more-menu-item.gif | Bin .../assets/plugin-sidebar-open-state.png | Bin .../assets/sidebar-style-and-controls.png | Bin .../assets/sidebar-up-and-running.png | Bin docs/{how-to-guides => }/assets/toolbar-text.png | Bin .../assets/toolbar-with-custom-button.png | Bin 18 files changed, 0 insertions(+), 0 deletions(-) rename docs/{how-to-guides => }/assets/fancy-quote-in-inspector.png (100%) rename docs/{how-to-guides => }/assets/fancy-quote-with-style.png (100%) rename docs/{how-to-guides => }/assets/inspector.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-console-log-error.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-console-log-success.png (100%) rename docs/{how-to-guides => }/assets/js-tutorial-error-blocks-undefined.png (100%) rename docs/{how-to-guides => }/assets/plugin-block-settings-menu-item-screenshot.png (100%) rename docs/{how-to-guides => }/assets/plugin-more-menu-item.png (100%) rename docs/{how-to-guides => }/assets/plugin-post-publish-panel.png (100%) rename docs/{how-to-guides => }/assets/plugin-post-status-info-location.png (100%) rename docs/{how-to-guides => }/assets/plugin-pre-publish-panel.png (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-closed-state.png (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-more-menu-item.gif (100%) rename docs/{how-to-guides => }/assets/plugin-sidebar-open-state.png (100%) rename docs/{how-to-guides => }/assets/sidebar-style-and-controls.png (100%) rename docs/{how-to-guides => }/assets/sidebar-up-and-running.png (100%) rename docs/{how-to-guides => }/assets/toolbar-text.png (100%) rename docs/{how-to-guides => }/assets/toolbar-with-custom-button.png (100%) diff --git a/docs/how-to-guides/assets/fancy-quote-in-inspector.png b/docs/assets/fancy-quote-in-inspector.png similarity index 100% rename from docs/how-to-guides/assets/fancy-quote-in-inspector.png rename to docs/assets/fancy-quote-in-inspector.png diff --git a/docs/how-to-guides/assets/fancy-quote-with-style.png b/docs/assets/fancy-quote-with-style.png similarity index 100% rename from docs/how-to-guides/assets/fancy-quote-with-style.png rename to docs/assets/fancy-quote-with-style.png diff --git a/docs/how-to-guides/assets/inspector.png b/docs/assets/inspector.png similarity index 100% rename from docs/how-to-guides/assets/inspector.png rename to docs/assets/inspector.png diff --git a/docs/how-to-guides/assets/js-tutorial-console-log-error.png b/docs/assets/js-tutorial-console-log-error.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-console-log-error.png rename to docs/assets/js-tutorial-console-log-error.png diff --git a/docs/how-to-guides/assets/js-tutorial-console-log-success.png b/docs/assets/js-tutorial-console-log-success.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-console-log-success.png rename to docs/assets/js-tutorial-console-log-success.png diff --git a/docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png b/docs/assets/js-tutorial-error-blocks-undefined.png similarity index 100% rename from docs/how-to-guides/assets/js-tutorial-error-blocks-undefined.png rename to docs/assets/js-tutorial-error-blocks-undefined.png diff --git a/docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png b/docs/assets/plugin-block-settings-menu-item-screenshot.png similarity index 100% rename from docs/how-to-guides/assets/plugin-block-settings-menu-item-screenshot.png rename to docs/assets/plugin-block-settings-menu-item-screenshot.png diff --git a/docs/how-to-guides/assets/plugin-more-menu-item.png b/docs/assets/plugin-more-menu-item.png similarity index 100% rename from docs/how-to-guides/assets/plugin-more-menu-item.png rename to docs/assets/plugin-more-menu-item.png diff --git a/docs/how-to-guides/assets/plugin-post-publish-panel.png b/docs/assets/plugin-post-publish-panel.png similarity index 100% rename from docs/how-to-guides/assets/plugin-post-publish-panel.png rename to docs/assets/plugin-post-publish-panel.png diff --git a/docs/how-to-guides/assets/plugin-post-status-info-location.png b/docs/assets/plugin-post-status-info-location.png similarity index 100% rename from docs/how-to-guides/assets/plugin-post-status-info-location.png rename to docs/assets/plugin-post-status-info-location.png diff --git a/docs/how-to-guides/assets/plugin-pre-publish-panel.png b/docs/assets/plugin-pre-publish-panel.png similarity index 100% rename from docs/how-to-guides/assets/plugin-pre-publish-panel.png rename to docs/assets/plugin-pre-publish-panel.png diff --git a/docs/how-to-guides/assets/plugin-sidebar-closed-state.png b/docs/assets/plugin-sidebar-closed-state.png similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-closed-state.png rename to docs/assets/plugin-sidebar-closed-state.png diff --git a/docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif b/docs/assets/plugin-sidebar-more-menu-item.gif similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-more-menu-item.gif rename to docs/assets/plugin-sidebar-more-menu-item.gif diff --git a/docs/how-to-guides/assets/plugin-sidebar-open-state.png b/docs/assets/plugin-sidebar-open-state.png similarity index 100% rename from docs/how-to-guides/assets/plugin-sidebar-open-state.png rename to docs/assets/plugin-sidebar-open-state.png diff --git a/docs/how-to-guides/assets/sidebar-style-and-controls.png b/docs/assets/sidebar-style-and-controls.png similarity index 100% rename from docs/how-to-guides/assets/sidebar-style-and-controls.png rename to docs/assets/sidebar-style-and-controls.png diff --git a/docs/how-to-guides/assets/sidebar-up-and-running.png b/docs/assets/sidebar-up-and-running.png similarity index 100% rename from docs/how-to-guides/assets/sidebar-up-and-running.png rename to docs/assets/sidebar-up-and-running.png diff --git a/docs/how-to-guides/assets/toolbar-text.png b/docs/assets/toolbar-text.png similarity index 100% rename from docs/how-to-guides/assets/toolbar-text.png rename to docs/assets/toolbar-text.png diff --git a/docs/how-to-guides/assets/toolbar-with-custom-button.png b/docs/assets/toolbar-with-custom-button.png similarity index 100% rename from docs/how-to-guides/assets/toolbar-with-custom-button.png rename to docs/assets/toolbar-with-custom-button.png From 12fb9aa831a8834c025b94f63a5390e6dfce8742 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:34:52 +0100 Subject: [PATCH 51/68] Update links to general assets --- .../block-tutorial/block-controls-toolbar-and-sidebar.md | 4 ++-- docs/how-to-guides/format-api/2-toolbar-button.md | 2 +- docs/how-to-guides/javascript/extending-the-block-editor.md | 4 ++-- docs/how-to-guides/javascript/loading-javascript.md | 2 +- docs/how-to-guides/javascript/troubleshooting.md | 4 ++-- .../sidebar-tutorial/plugin-sidebar-1-up-and-running.md | 2 +- .../sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md | 2 +- .../slotfills/plugin-block-settings-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-more-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-post-publish-panel.md | 2 +- docs/reference-guides/slotfills/plugin-post-status-info.md | 2 +- docs/reference-guides/slotfills/plugin-pre-publish-panel.md | 2 +- .../slotfills/plugin-sidebar-more-menu-item.md | 2 +- docs/reference-guides/slotfills/plugin-sidebar.md | 2 +- 14 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md index fc049da2f65fe..957104508fdd2 100644 --- a/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md +++ b/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md @@ -4,7 +4,7 @@ To simplify block customization and ensure a consistent experience for users, th ## Block Toolbar -![Screenshot of the rich text toolbar applied to a Paragraph block inside the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/toolbar-text.png) +![Screenshot of the rich text toolbar applied to a Paragraph block inside the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/toolbar-text.png) When the user selects a block, a number of control buttons may be shown in a toolbar above the selected block. Some of these block-level controls are included automatically if the editor is able to transform the block to another type, or if the focused element is a RichText component. @@ -194,7 +194,7 @@ Note that `BlockControls` is only visible when the block is currently selected a ## Inspector -![Screenshot of the inspector panel focused on the settings for a Paragraph block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/inspector.png) +![Screenshot of the inspector panel focused on the settings for a Paragraph block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/inspector.png) The Settings Sidebar is used to display less-often-used settings or settings that require more screen space. The Settings Sidebar should be used for **block-level settings only**. diff --git a/docs/how-to-guides/format-api/2-toolbar-button.md b/docs/how-to-guides/format-api/2-toolbar-button.md index 4c669ed1da1ef..4d64c1e7dcee3 100644 --- a/docs/how-to-guides/format-api/2-toolbar-button.md +++ b/docs/how-to-guides/format-api/2-toolbar-button.md @@ -59,7 +59,7 @@ registerFormatType( Let's check that everything is working as expected. Reload the post/page and select a text block. Make sure that the new button was added to the format toolbar, it uses the [editor-code dashicon](https://developer.wordpress.org/resource/dashicons/#editor-code), and the hover text is what you set in the title: -![Toolbar with custom button](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/toolbar-with-custom-button.png) +![Toolbar with custom button](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/toolbar-with-custom-button.png) You may also want to check that upon clicking the button the `toggle format` message is shown in your browser's console. diff --git a/docs/how-to-guides/javascript/extending-the-block-editor.md b/docs/how-to-guides/javascript/extending-the-block-editor.md index 0609d78aa958e..0a32b380318a8 100644 --- a/docs/how-to-guides/javascript/extending-the-block-editor.md +++ b/docs/how-to-guides/javascript/extending-the-block-editor.md @@ -39,7 +39,7 @@ Add a quote block, and in the right sidebar under Styles, you will see your new Click the Fancy Quote to select and apply that style to your quote block: -![Fancy Quote Style in Inspector](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/fancy-quote-in-inspector.png) +![Fancy Quote Style in Inspector](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/fancy-quote-in-inspector.png) Even if you Preview or Publish the post you will not see a visible change. However, if you look at the source, you will see the `is-style-fancy-quote` class name is now attached to your quote block. @@ -63,4 +63,4 @@ add_action( 'enqueue_block_assets', 'myguten_stylesheet' ); Now when you view in the editor and publish, you will see your Fancy Quote style, a delicious tomato color text: -![Fancy Quote with Style](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/fancy-quote-with-style.png) +![Fancy Quote with Style](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/fancy-quote-with-style.png) diff --git a/docs/how-to-guides/javascript/loading-javascript.md b/docs/how-to-guides/javascript/loading-javascript.md index e89c359fee820..c029d198c08f2 100644 --- a/docs/how-to-guides/javascript/loading-javascript.md +++ b/docs/how-to-guides/javascript/loading-javascript.md @@ -28,7 +28,7 @@ We'll check the JavaScript console in your browser's Developer Tools, to see if If your code is registered and enqueued correctly, you should see a message in your console: -![Console Log Message Success](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/js-tutorial-console-log-success.png) +![Console Log Message Success](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/js-tutorial-console-log-success.png) **Note for Theme Developers:** The above method of enqueuing is used for plugins. If you are extending the block editor for your theme there is a minor difference, you will use the `get_template_directory_uri()` function instead of `plugins_url()`. So for a theme, the enqueue example is: diff --git a/docs/how-to-guides/javascript/troubleshooting.md b/docs/how-to-guides/javascript/troubleshooting.md index 30179342bc5ac..7fe4784bf30ab 100644 --- a/docs/how-to-guides/javascript/troubleshooting.md +++ b/docs/how-to-guides/javascript/troubleshooting.md @@ -19,7 +19,7 @@ To open the JavaScript console, find the correct key combination for your broswe Your first step in debugging should be to check the JavaScript console for any errors. Here is an example, which shows a syntax error on line 6: -![console error](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/js-tutorial-console-log-error.png) +![console error](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/js-tutorial-console-log-error.png) ### Display your message in console log @@ -61,7 +61,7 @@ Add a test message to confirm your JavaScript is loading, add a `console.log("He The console log will show an error if a dependency your JavaScript code uses has not been declared and loaded in the browser. In the JavaScript tutorial example, if `myguten.js` script is enqueued without declaring the `wp-blocks` dependency, the console log will show: - + You can correct by checking your `wp_enqueue_script` function includes all packages listed that are used: diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md index 17fdc3cad62de..0f7a9410b7859 100644 --- a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md @@ -53,4 +53,4 @@ add_action( 'enqueue_block_editor_assets', 'sidebar_plugin_script_enqueue' ); After installing and activating this plugin, there is a new icon resembling a tack in the top-right of the editor. Upon clicking it, the plugin's sidebar will be opened: -![Sidebar Up and Running](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/sidebar-up-and-running.png) +![Sidebar Up and Running](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/sidebar-up-and-running.png) diff --git a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md index 18016e37f0337..841c9f1153446 100644 --- a/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md +++ b/docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md @@ -92,6 +92,6 @@ add_action( 'enqueue_block_assets', 'sidebar_plugin_style_enqueue' ); Reload the editor and open the sidebar: -![Sidebar with style and controls](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/sidebar-style-and-controls.png) +![Sidebar with style and controls](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/sidebar-style-and-controls.png) With the input control and the styling the sidebar looks nicer. This code doesn't let users to store or retrieve data just yet, so the next steps will focus on how to connect it to the meta block field. diff --git a/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md index 302730dfd74a5..0c1e490f60ef1 100644 --- a/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md @@ -27,4 +27,4 @@ registerPlugin( 'block-settings-menu-group-test', { ## Location -![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-block-settings-menu-item-screenshot.png?raw=true "PluginBlockSettingsMenuItem Location") +![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-block-settings-menu-item-screenshot.png?raw=true "PluginBlockSettingsMenuItem Location") diff --git a/docs/reference-guides/slotfills/plugin-more-menu-item.md b/docs/reference-guides/slotfills/plugin-more-menu-item.md index 4656dbde9af93..6a53c029b10dd 100644 --- a/docs/reference-guides/slotfills/plugin-more-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-more-menu-item.md @@ -25,4 +25,4 @@ registerPlugin( 'more-menu-item-test', { render: MyButtonMoreMenuItemTest } ); ## Location -![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-more-menu-item.png?raw=true) +![Location](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-more-menu-item.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-post-publish-panel.md b/docs/reference-guides/slotfills/plugin-post-publish-panel.md index 8dd63661ad448..bc05328f4f554 100644 --- a/docs/reference-guides/slotfills/plugin-post-publish-panel.md +++ b/docs/reference-guides/slotfills/plugin-post-publish-panel.md @@ -21,5 +21,5 @@ registerPlugin( 'post-publish-panel-test', { ## Location -![post publish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-post-publish-panel.png?raw=true) +![post publish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-post-publish-panel.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-post-status-info.md b/docs/reference-guides/slotfills/plugin-post-status-info.md index f1acf64cd7cc5..3cf62b772350c 100644 --- a/docs/reference-guides/slotfills/plugin-post-status-info.md +++ b/docs/reference-guides/slotfills/plugin-post-status-info.md @@ -19,5 +19,5 @@ registerPlugin( 'post-status-info-test', { render: PluginPostStatusInfoTest } ); ## Location -![Location in the Status & visibility panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-post-status-info-location.png?raw=true) +![Location in the Status & visibility panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-post-status-info-location.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-pre-publish-panel.md b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md index 8cd6908adb87d..5c71d43161f61 100644 --- a/docs/reference-guides/slotfills/plugin-pre-publish-panel.md +++ b/docs/reference-guides/slotfills/plugin-pre-publish-panel.md @@ -21,5 +21,5 @@ registerPlugin( 'pre-publish-panel-test', { ## Location -![Prepublish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-pre-publish-panel.png?raw=true) +![Prepublish panel](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-pre-publish-panel.png?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md index 57419296b30e9..8ede72e782b02 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md +++ b/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md @@ -29,4 +29,4 @@ registerPlugin( 'plugin-sidebar-expanded-test', { ## Location -![Interaction](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-sidebar-more-menu-item.gif?raw=true) +![Interaction](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-more-menu-item.gif?raw=true) diff --git a/docs/reference-guides/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md index 71bbead0a3bbf..b557712fda74d 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar.md +++ b/docs/reference-guides/slotfills/plugin-sidebar.md @@ -23,7 +23,7 @@ registerPlugin( 'plugin-sidebar-test', { render: PluginSidebarTest } ); ### Closed State -![Closed State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/assets/plugin-sidebar-closed-state.png?raw=true) +![Closed State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-closed-state.png?raw=true) ### Open State From 14ac7e5dca5ccf7a625e8f05a9ccdc4c609c5e35 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:36:12 +0100 Subject: [PATCH 52/68] Update links to designers assets --- docs/how-to-guides/designers/block-design.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/how-to-guides/designers/block-design.md b/docs/how-to-guides/designers/block-design.md index 818dd4436962d..256516b77215a 100644 --- a/docs/how-to-guides/designers/block-design.md +++ b/docs/how-to-guides/designers/block-design.md @@ -64,11 +64,11 @@ When referring to a block in documentation or UI, use title case for the block t Blocks should have an identifying icon, ideally using a single color. Try to avoid using the same icon used by an existing block. The core block icons are based on [Material Design Icons](https://material.io/tools/icons/). Look to that icon set, or to [Dashicons](https://developer.wordpress.org/resource/dashicons/) for style inspiration. -![A screenshot of the block library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/blocks-do.png) +![A screenshot of the block library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-do.png) **Do:** Use concise block names. -![A screenshot of the block library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/blocks-dont.png) +![A screenshot of the block library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-dont.png) **Don't:** Avoid long, multi-line block names. @@ -84,11 +84,11 @@ Stick to a single imperative sentence with an action + subject format. Examples: - Introduce new sections and organize content to help visitors (and search engines) understand the structure of your content. - Create a bulleted or numbered list. -![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-descriptions-do.png) +![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-do.png) **Do:** Use a short, simple block description. -![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-descriptions-dont.png) +![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-dont.png) **Don't:** Avoid long descriptions and branding. @@ -96,11 +96,11 @@ Avoid long descriptions and branding. If your block requires a user to configure some options before you can display it, you should provide an instructive placeholder state. -![A screenshot of the Gallery block's placeholder](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/placeholder-do.png) +![A screenshot of the Gallery block's placeholder](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-do.png) **Do:** Provide an instructive placeholder state. -![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/placeholder-dont.png) +![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-dont.png) **Don't:** Avoid branding and relying on the title alone to convey instructions. @@ -110,11 +110,11 @@ When unselected, your block should preview its content as closely to the front-e When selected, your block may surface additional options like input fields or buttons to configure the block directly, especially when they are necessary for basic operation. -![A Google Maps block with inline, always-accessible controls required for the block to function](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-controls-do.png) +![A Google Maps block with inline, always-accessible controls required for the block to function](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-do.png) **Do:** For controls that are essential for the operation of the block, provide them directly inside the block edit view. -![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/block-controls-dont.png) +![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-dont.png) **Don't:** Do not put controls that are essential to the block in the sidebar, otherwise the block will appear non-functional to mobile users or desktop users who have dismissed the sidebar. @@ -122,7 +122,7 @@ Do not put controls that are essential to the block in the sidebar, otherwise th The “Block” tab of the Settings Sidebar can contain additional block options and configuration. Keep in mind that a user can dismiss the sidebar and never use it. You should not put critical options in the Sidebar. -![A screenshot of the Paragraph block's advanced settings in the sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/designers/assets/advanced-settings-do.png) +![A screenshot of the Paragraph block's advanced settings in the sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/advanced-settings-do.png) **Do:** Because the Drop Cap feature is not necessary for the basic operation of the block, you can put it to the Block tab as optional configuration. From cdda3873750acf72336bb413b4c61ac68952c726 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:41:51 +0100 Subject: [PATCH 53/68] Update assets links --- docs/how-to-guides/metabox/meta-block-3-add.md | 2 +- docs/how-to-guides/notices/README.md | 4 ++-- docs/reference-guides/slotfills/plugin-sidebar.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/how-to-guides/metabox/meta-block-3-add.md b/docs/how-to-guides/metabox/meta-block-3-add.md index aa138b1418d3c..6dec512aea7ab 100644 --- a/docs/how-to-guides/metabox/meta-block-3-add.md +++ b/docs/how-to-guides/metabox/meta-block-3-add.md @@ -136,6 +136,6 @@ add_action( 'enqueue_block_editor_assets', 'myguten_enqueue' ); You can now edit a draft post and add a Meta Block to the post. You will see your field that you can type a value in. When you save the post, either as a draft or published, the post meta value will be saved too. You can verify by saving and reloading your draft, the form will still be filled in on reload. -![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/metabox/meta-block.png) +![Meta Block](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/metabox/meta-block.png) You can now use the post meta data in a template, or another block. See next section for [using post meta data](/docs/how-to-guides/metabox/meta-block-4-use-data.md). You could also confirm the data is saved by checking the database table `wp_postmeta` and confirm the new post id contains the new field data. diff --git a/docs/how-to-guides/notices/README.md b/docs/how-to-guides/notices/README.md index 85e2aa1acc61a..de9867307b5ac 100644 --- a/docs/how-to-guides/notices/README.md +++ b/docs/how-to-guides/notices/README.md @@ -8,7 +8,7 @@ In the classic editor, notices hooked onto the `admin_notices` action can render In the classic editor, here's an example of the "Post draft updated" notice: -![Post draft updated in the classic editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/notices/classic-editor-notice.png) +![Post draft updated in the classic editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/notices/classic-editor-notice.png) Producing an equivalent "Post draft updated" notice would require code like this: @@ -39,7 +39,7 @@ Importantly, the `admin_notices` hook allows a developer to render whatever HTML In the block editor, here's an example of the "Post published" notice: -![Post published in the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers/developers/tutorials/notices/block-editor-notice.png) +![Post published in the block editor](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/notices/block-editor-notice.png) Producing an equivalent "Post published" notice would require code like this: diff --git a/docs/reference-guides/slotfills/plugin-sidebar.md b/docs/reference-guides/slotfills/plugin-sidebar.md index b557712fda74d..56d87ea1fc1be 100644 --- a/docs/reference-guides/slotfills/plugin-sidebar.md +++ b/docs/reference-guides/slotfills/plugin-sidebar.md @@ -27,4 +27,4 @@ registerPlugin( 'plugin-sidebar-test', { render: PluginSidebarTest } ); ### Open State -![Open State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/designers-developers//assets/plugin-sidebar-open-state.png?raw=true) +![Open State](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/plugin-sidebar-open-state.png?raw=true) From 77e5b087d0bc4d7d977758b2286330bb96dd01e4 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 09:55:05 +0100 Subject: [PATCH 54/68] Update reference guides README --- docs/reference-guides/README.md | 53 +++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md index e69de29bb2d1d..b470e8d8ee455 100644 --- a/docs/reference-guides/README.md +++ b/docs/reference-guides/README.md @@ -0,0 +1,53 @@ +# Reference Guides + +## Block API Reference + +- [Block registration](/docs/reference-guides/block-api/block-registration.md) +- [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) +- [Attributes](/docs/reference-guides/block-api/block-attributes.md) +- [Context](/docs/reference-guides/block-api/block-context.md) +- [Deprecation](/docs/reference-guides/block-api/block-deprecation.md) +- [Supports](/docs/reference-guides/block-api/block-supports.md) +- [Transformations](/docs/reference-guides/block-api/block-transforms.md) +- [Templates](/docs/reference-guides/block-api/block-templates.md) +- [Metadata](/docs/reference-guides/block-api/block-metadata.md) +- [Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Annotations](/docs/reference-guides/block-api/block-annotations.md) +- [Versions](/docs/reference-guides/block-api/versions.md) + +## Filter Reference + +- [Block Filters](/docs/reference-guides/filters/block-filters.md) +- [Editor Filters (Experimental)](/docs/reference-guides/filters/editor-filters.md) +- [Parser Filters](/docs/reference-guides/filters/parser-filters.md) +- [Autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) + +## SlotFills Reference + +- [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) +- [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) +- [PluginDocumentSettingPanel](/docs/reference-guides/slotfills/plugin-document-setting-panel.md) +- [PluginMoreMenuItem](/docs/reference-guides/slotfills/plugin-more-menu-item.md) +- [PluginPostPublishPanel](/docs/reference-guides/slotfills/plugin-post-publish-panel.md) +- [PluginPostStatusInfo](/docs/reference-guides/slotfills/plugin-post-status-info.md) +- [PluginPrePublishPanel](/docs/reference-guides/slotfills/plugin-pre-publish-panel.md) +- [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) +- [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) + +## RichText Reference + +## Component Reference + +## Package Reference + +## Data Module Reference + +- [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) + - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) + - [**core/blocks**: Block Types Data](/docs/reference-guides/data/data-core-blocks.md) + - [**core/block-editor**: The Block Editor’s Data](/docs/reference-guides/data/data-core-block-editor.md) + - [**core/editor**: The Post Editor’s Data](/docs/reference-guides/data/data-core-editor.md) + - [**core/edit-post**: The Editor’s UI Data](/docs/reference-guides/data/data-core-edit-post.md) + - [**core/notices**: Notices Data](/docs/reference-guides/data/data-core-notices.md) + - [**core/nux**: The NUX (New User Experience) Data](/docs/reference-guides/data/data-core-nux.md) + - [**core/viewport**: The Viewport Data](/docs/reference-guides/data/data-core-viewport.md) From 837462756aace5255b9fe803354b9be74f005e95 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:06:09 +0100 Subject: [PATCH 55/68] Update reference guides readme --- docs/reference-guides/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/reference-guides/README.md b/docs/reference-guides/README.md index b470e8d8ee455..39c6733bbb4fd 100644 --- a/docs/reference-guides/README.md +++ b/docs/reference-guides/README.md @@ -1,6 +1,6 @@ # Reference Guides -## Block API Reference +## [Block API Reference](/docs/reference-guides/block-api/README.md) - [Block registration](/docs/reference-guides/block-api/block-registration.md) - [Edit and Save](/docs/reference-guides/block-api/block-edit-save.md) @@ -15,14 +15,14 @@ - [Annotations](/docs/reference-guides/block-api/block-annotations.md) - [Versions](/docs/reference-guides/block-api/versions.md) -## Filter Reference +## [Filter Reference](/docs/reference-guides/filters/README.md) - [Block Filters](/docs/reference-guides/filters/block-filters.md) - [Editor Filters (Experimental)](/docs/reference-guides/filters/editor-filters.md) - [Parser Filters](/docs/reference-guides/filters/parser-filters.md) - [Autocomplete](/docs/reference-guides/filters/autocomplete-filters.md) -## SlotFills Reference +## [SlotFills Reference](/docs/reference-guides/slotfills/README.md) - [MainDashboardButton](/docs/reference-guides/slotfills/main-dashboard-button.md) - [PluginBlockSettingsMenuItem](/docs/reference-guides/slotfills/plugin-block-settings-menu-item.md) @@ -34,13 +34,13 @@ - [PluginSidebar](/docs/reference-guides/slotfills/plugin-sidebar.md) - [PluginSidebarMoreMenuItem](/docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md) -## RichText Reference +## [RichText Reference](/docs/reference-guides/richtext.md) -## Component Reference +## [Component Reference](/packages/components/README.md) -## Package Reference +## [Package Reference](/docs/reference-guides/packages.md) -## Data Module Reference +## [Data Module Reference](/docs/reference-guides/data/README.md) - [**core**: WordPress Core Data](/docs/reference-guides/data/data-core.md) - [**core/annotations**: Annotations](/docs/reference-guides/data/data-core-annotations.md) From 05be39cb444fe5c4aea6a27e22c00b81cbd3f526 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:09:52 +0100 Subject: [PATCH 56/68] Update explanations readme --- docs/explanations/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/explanations/README.md b/docs/explanations/README.md index e69de29bb2d1d..6a0e4899560ac 100644 --- a/docs/explanations/README.md +++ b/docs/explanations/README.md @@ -0,0 +1,12 @@ +# Explanation + +## [Architecture](/docs/explanations/architecture/README.md) + +- [Key Concepts](/docs/explanations/architecture/key-concepts.md) +- [Data Format And Data Flow](/docs/explanations/architecture/data-flow.md) +- [Modularity and WordPress Packages](/docs/explanations/architecture/modularity.md). +- [Block Editor Performance](/docs/explanations/architecture/performance.md). +- What are the decision decisions behind the Data Module? +- [Why is Puppeteer the tool of choice for end-to-end tests?](/docs/explanations/architecture/automated-testing.md) +- [What’s the difference between the different editor packages? What’s the purpose of each package?](/docs/explanations/architecture/modularity.md/#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package) +- [Template and template parts flows](/docs/explanations/architecture/full-site-editing-templates.md) From 0ea24cadc72ba8d215f7bc208c25bfd87cf1cb46 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 10:11:00 +0100 Subject: [PATCH 57/68] Update explanations readme --- docs/explanations/README.md | 2 +- docs/manifest.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/explanations/README.md b/docs/explanations/README.md index 6a0e4899560ac..04d9f8e9e15b5 100644 --- a/docs/explanations/README.md +++ b/docs/explanations/README.md @@ -1,4 +1,4 @@ -# Explanation +# Explanations ## [Architecture](/docs/explanations/architecture/README.md) diff --git a/docs/manifest.json b/docs/manifest.json index 4fcc8896476d7..53c8fd554bf18 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -420,7 +420,7 @@ "parent": "how-to-guides" }, { - "title": "ReferenceGuides", + "title": "Reference Guides", "slug": "reference-guides", "markdown_source": "../docs/reference-guides/README.md", "parent": null From 86cab63ce7b5fd0d07e78debf16712a56d3f026e Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:29:34 +0100 Subject: [PATCH 58/68] Use relative links --- docs/getting-started/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 24d389d05c927..86824cca8561f 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -320,7 +320,7 @@ Blocks are able to provide base structural CSS styles, and themes can add styles Other features, like the new _wide_ and _full-wide_ alignment options, are simply CSS classes applied to blocks that offer this alignment. We are looking at how a theme can opt in to this feature, for example using `add_theme_support`. -This is currently a work in progress and we recommend reviewing the [block based theme documentation](https://developer.wordpress.org/block-editor/tutorials/block-based-theme/) to learn more. +This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-themes/README.md) to learn more. ## What are block variations? Are they the same as block styles? From 8e63b3eb912b48a15d401794043c9c67ec625f38 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:35:04 +0100 Subject: [PATCH 59/68] Rename how-to-guides/block-based-themes to how-to-guides/block-based-theme --- .../developers/tutorials/block-based-theme/README.md | 12 ++++++------ docs/getting-started/faq.md | 2 +- docs/how-to-guides/block-based-theme/README.md | 10 +++++++++- docs/manifest.json | 8 ++++---- docs/toc.json | 4 ++-- 5 files changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/designers-developers/developers/tutorials/block-based-theme/README.md b/docs/designers-developers/developers/tutorials/block-based-theme/README.md index 310ec28a3ec7a..e106ac9d71d5a 100644 --- a/docs/designers-developers/developers/tutorials/block-based-theme/README.md +++ b/docs/designers-developers/developers/tutorials/block-based-theme/README.md @@ -12,11 +12,11 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents - 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-theme/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-theme/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-theme/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) ## What is needed to create a block-based theme? @@ -377,4 +377,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index 86824cca8561f..eb643f4229fac 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -320,7 +320,7 @@ Blocks are able to provide base structural CSS styles, and themes can add styles Other features, like the new _wide_ and _full-wide_ alignment options, are simply CSS classes applied to blocks that offer this alignment. We are looking at how a theme can opt in to this feature, for example using `add_theme_support`. -This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-themes/README.md) to learn more. +This is currently a work in progress and we recommend reviewing the [block based theme documentation](/docs/how-to-guides/block-based-theme/README.md) to learn more. ## What are block variations? Are they the same as block styles? diff --git a/docs/how-to-guides/block-based-theme/README.md b/docs/how-to-guides/block-based-theme/README.md index 310ec28a3ec7a..4cb4bb96cb7e4 100644 --- a/docs/how-to-guides/block-based-theme/README.md +++ b/docs/how-to-guides/block-based-theme/README.md @@ -12,11 +12,19 @@ This tutorial is up to date as of Gutenberg version 9.1. ## Table of Contents +<<<<<<< HEAD 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-themes/README.md#what-is-needed-to-create-a-block-based-theme) 2. [Creating the theme](/docs/how-to-guides/block-based-themes/README.md#creating-the-theme) 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-themes/README.md#creating-the-templates-and-template-parts) 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-themes/README.md#experimental-theme-json-global-styles) 5. [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +======= + 1. [What is needed to create a block-based theme?](/docs/how-to-guides/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) + 2. [Creating the theme](/docs/how-to-guides/block-based-theme/README.md#creating-the-theme) + 3. [Creating the templates and template parts](/docs/how-to-guides/block-based-theme/README.md#creating-the-templates-and-template-parts) + 4. [Experimental-theme.json - Global styles](/docs/how-to-guides/block-based-theme/README.md#experimental-theme-json-global-styles) + 5. [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) +>>>>>>> Rename how-to-guides/block-based-themes to how-to-guides/block-based-theme ## What is needed to create a block-based theme? @@ -377,4 +385,4 @@ Below are the presets and styles combined: } ``` -## [Adding blocks](/docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md) +## [Adding blocks](/docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md) diff --git a/docs/manifest.json b/docs/manifest.json index 53c8fd554bf18..beff69756b36c 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -307,15 +307,15 @@ }, { "title": "Creating a block-based theme", - "slug": "block-based-themes", - "markdown_source": "../docs/how-to-guides/block-based-themes/README.md", + "slug": "block-based-theme", + "markdown_source": "../docs/how-to-guides/block-based-theme/README.md", "parent": "how-to-guides" }, { "title": "Adding blocks to your theme", "slug": "block-based-themes-2-adding-blocks", - "markdown_source": "../docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md", - "parent": "block-based-themes" + "markdown_source": "../docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md", + "parent": "block-based-theme" }, { "title": "Backward Compatibility", diff --git a/docs/toc.json b/docs/toc.json index a76aa93d03210..1fcd886bc3424 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -75,8 +75,8 @@ ] }, { - "docs/how-to-guides/block-based-themes/README.md": [ - { "docs/how-to-guides/block-based-themes/block-based-themes-2-adding-blocks.md": [] } + "docs/how-to-guides/block-based-theme/README.md": [ + { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } ] }, { From e8f721f27b7f22c93aef6c6f6320b5b526b57004 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:51:13 +0100 Subject: [PATCH 60/68] Move the main readme to /docs --- docs/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000..0f91f0036e907 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,42 @@ +# Getting started + +**Gutenberg** is a codename for a whole new paradigm in WordPress site building and publishing, that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. The project is right now in the second phase of a four-phase process that will touch every piece of WordPress -- Editing, **Customization** (which includes Full Site Editing, Block Patterns, Block Directory and Block based themes), Collaboration, and Multilingual -- and is focused on a new editing experience, the block editor (which is the topic of the current documentation). + +![Quick view of the block editor](https://make.wordpress.org/core/files/2021/01/quick-view-of-the-block-editor.png) + +**Legend :** + +1. Block Inserter +2. Block editor content area +3. Settings Sidebar + +Using a system of Blocks to compose and format content, the new block-based editor is designed to create rich, flexible layouts for websites and digital products. Content is created in the unit of blocks instead of freeform text with inserted media, embeds and Shortcodes (there's a Shortcode block though). + +Blocks treat Paragraphs, Headings, Media, and Embeds all as components that, when strung together, make up the content stored in the WordPress database, replacing the traditional concept of freeform text with embedded media and shortcodes. The new editor is designed with progressive enhancement, meaning that it is back-compatible with all legacy content, and it also offers a process to try to convert and split a Classic block into equivalent blocks using client-side parsing. Finally, the blocks offer enhanced editing and format controls. + +The Editor offers rich new value to users with visual, drag-and-drop creation tools and powerful developer enhancements with modern vendor packages, reusable components, rich APIs and hooks to modify and extend the editor through Custom Blocks, Custom Block Styles and Plugins. + +[Learn to use the block editor](https://wordpress.org/support/article/wordpress-editor/) to create media-rich posts and pages. + +## Quick links + +### Create a Block Tutorial + +[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. + +### Develop for the block editor + +Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. + +- [Gutenberg Architecture](/docs/architecture/readme.md) +- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) +- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) +- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) +- [Block API Reference](/docs/reference-guides/block-api/readme.md) +- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) +- [Internationalization](/docs/how-to-guides/internationalization.md) + +### Contribute to the block editor + +Everything you need to know to [start contributing to the block editor](/docs/contributors/readme.md) . Whether you are interested in the design, code, triage, documentation, support or internationalization of the block editor, you will find here guides to help you. + From e71cdd53dd8db40ec1e13b48c824e01237815f92 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:51:45 +0100 Subject: [PATCH 61/68] Update getting started readme --- docs/getting-started/README.md | 44 +++++++--------------------------- 1 file changed, 8 insertions(+), 36 deletions(-) diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 0f91f0036e907..82eb07d95d985 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -1,42 +1,14 @@ -# Getting started +# Getting Started -**Gutenberg** is a codename for a whole new paradigm in WordPress site building and publishing, that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. The project is right now in the second phase of a four-phase process that will touch every piece of WordPress -- Editing, **Customization** (which includes Full Site Editing, Block Patterns, Block Directory and Block based themes), Collaboration, and Multilingual -- and is focused on a new editing experience, the block editor (which is the topic of the current documentation). +## [Tutorials](/docs/getting-started/tutorials/README.md) -![Quick view of the block editor](https://make.wordpress.org/core/files/2021/01/quick-view-of-the-block-editor.png) +- [Development Environment](/docs/getting-started/tutorials/devenv/README.md) +- [Create a Block Tutorial](/docs/getting-started/tutorials/create-block/README.md) -**Legend :** +## [Glossary](/docs/getting-started/glossary.md) -1. Block Inserter -2. Block editor content area -3. Settings Sidebar +## [FAQ](/docs/getting-started/faq.md) -Using a system of Blocks to compose and format content, the new block-based editor is designed to create rich, flexible layouts for websites and digital products. Content is created in the unit of blocks instead of freeform text with inserted media, embeds and Shortcodes (there's a Shortcode block though). - -Blocks treat Paragraphs, Headings, Media, and Embeds all as components that, when strung together, make up the content stored in the WordPress database, replacing the traditional concept of freeform text with embedded media and shortcodes. The new editor is designed with progressive enhancement, meaning that it is back-compatible with all legacy content, and it also offers a process to try to convert and split a Classic block into equivalent blocks using client-side parsing. Finally, the blocks offer enhanced editing and format controls. - -The Editor offers rich new value to users with visual, drag-and-drop creation tools and powerful developer enhancements with modern vendor packages, reusable components, rich APIs and hooks to modify and extend the editor through Custom Blocks, Custom Block Styles and Plugins. - -[Learn to use the block editor](https://wordpress.org/support/article/wordpress-editor/) to create media-rich posts and pages. - -## Quick links - -### Create a Block Tutorial - -[Learn how to create your first block](/docs/getting-started/tutorials/create-block/readme.md) for the WordPress block editor. From setting up your development environment, tools, and getting comfortable with the new development model, this tutorial covers all what you need to know to get started with the block editor. - -### Develop for the block editor - -Whether you want to extend the functionality of the block editor, or create a plugin based on it, [see the developer documentation](/docs/how-to-guides/README.md) to find all the information about the basic concepts you need to get started, the block editor APIs and its architecture. - -- [Gutenberg Architecture](/docs/architecture/readme.md) -- [Block Style Variations](/docs/reference-guides/filters/block-filters.md#block-style-variations) -- [Creating Block Patterns](/docs/reference-guides/block-api/block-patterns.md) -- [Theming for the Block Editor](/docs/how-to-guides/themes/readme.md) -- [Block API Reference](/docs/reference-guides/block-api/readme.md) -- [Block Editor Accessibility](/docs/reference-guides/accessibility.md) -- [Internationalization](/docs/how-to-guides/internationalization.md) - -### Contribute to the block editor - -Everything you need to know to [start contributing to the block editor](/docs/contributors/readme.md) . Whether you are interested in the design, code, triage, documentation, support or internationalization of the block editor, you will find here guides to help you. +## [History](/docs/getting-started/history.md) +## [Outreach](/docs/getting-started/outreach.md) From f442f99d165f6b5ebbd1c039b1fd06bd7ef4683a Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 11:55:12 +0100 Subject: [PATCH 62/68] Update manifest.json --- docs/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index beff69756b36c..d1d1c611fdf2f 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ [ { - "title": "Getting started", + "title": "Getting Started", "slug": "getting-started", "markdown_source": "../docs/getting-started/README.md", "parent": null From 81816e5acb0b1a640d04acb5f1b2af498953023a Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 12:24:01 +0100 Subject: [PATCH 63/68] CS updates on toc.json --- docs/manifest.json | 8 +- docs/toc.json | 386 ++++++++++++++++++++------------------------- 2 files changed, 177 insertions(+), 217 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index d1d1c611fdf2f..099e0bdcc92d3 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,9 +1,15 @@ [ + { + "title": "Getting started", + "slug": "handbook", + "markdown_source": "../docs/readme.md", + "parent": null + }, { "title": "Getting Started", "slug": "getting-started", "markdown_source": "../docs/getting-started/README.md", - "parent": null + "parent": "handbook" }, { "title": "Tutorials", diff --git a/docs/toc.json b/docs/toc.json index 1fcd886bc3424..11045fd3cdb1e 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,221 +1,175 @@ -[{ - "docs/getting-started/README.md": [{ - "docs/getting-started/tutorials/README.md": [{ - "docs/getting-started/tutorials/devenv/README.md": [ - { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } - ] - }, - { - "docs/getting-started/tutorials/create-block/README.md": [ - { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, - { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, - { "docs/getting-started/tutorials/create-block/attributes.md": [] }, - { "docs/getting-started/tutorials/create-block/block-code.md": [] }, - { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } - ] - } - ] - }, +[ + { "docs/readme.md": [ + { "docs/getting-started/README.md": [ + { "docs/getting-started/tutorials/README.md": [ + { "docs/getting-started/tutorials/devenv/README.md": [ + { "docs/getting-started/tutorials/devenv/docker-ubuntu.md": [] } + ] }, + { "docs/getting-started/tutorials/create-block/README.md": [ + { "docs/getting-started/tutorials/create-block/wp-plugin.md": [] }, + { "docs/getting-started/tutorials/create-block/block-anatomy.md": [] }, + { "docs/getting-started/tutorials/create-block/attributes.md": [] }, + { "docs/getting-started/tutorials/create-block/block-code.md": [] }, + { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, + { "docs/getting-started/tutorials/create-block/finishing.md": [] } + ] } + ] }, { "docs/getting-started/glossary.md": [] }, { "docs/getting-started/faq.md": [] }, { "docs/getting-started/history.md": [] }, { "docs/getting-started/outreach.md": [] } - ] - }, - { - "docs/how-to-guides/README.md": [{ - "docs/how-to-guides/javascript/README.md": [ - { "docs/how-to-guides/javascript/plugins-background.md": [] }, - { "docs/how-to-guides/javascript/loading-javascript.md": [] }, - { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, - { "docs/how-to-guides/javascript/troubleshooting.md": [] }, - { "docs/how-to-guides/javascript/versions-and-building.md": [] }, - { "docs/how-to-guides/javascript/scope-your-code.md": [] }, - { "docs/how-to-guides/javascript/js-build-setup.md": [] }, - { "docs/how-to-guides/javascript/esnext-js.md": [] } - ] - }, - { - "docs/how-to-guides/metabox/README.md": [ - { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, - { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, - { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, - { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, - { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } - ] - }, - { "docs/how-to-guides/notices/README.md": [] }, - { - "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, - { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } - ] - }, - { - "docs/how-to-guides/block-tutorial/README.md": [ - { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, - { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, - { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, - { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, - { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, - { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, - { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } - ] - }, - { "docs/how-to-guides/feature-flags.md": [] }, - { - "docs/how-to-guides/themes/README.md": [ - { "docs/how-to-guides/themes/theme-support.md": [] }, - { "docs/how-to-guides/themes/theme-json.md": [] } - ] - }, - { - "docs/how-to-guides/block-based-theme/README.md": [ - { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } - ] - }, - { - "docs/how-to-guides/backward-compatibility/README.md": [ - { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, - { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } - ] - }, - - { - "docs/how-to-guides/format-api/README.md": [ - { "docs/how-to-guides/format-api/1-register-format.md": [] }, - { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, - { "docs/how-to-guides/format-api/3-apply-format.md": [] } - ] - }, - { - "docs/how-to-guides/platform/README.md": [{ - "docs/how-to-guides/platform/custom-block-editor/README.md": [ - { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } - ] - }] - }, - { - "docs/how-to-guides/designers/README.md": [ - { "docs/how-to-guides/designers/block-design.md": [] }, - { "docs/how-to-guides/designers/user-interface.md": [] }, - { "docs/how-to-guides/designers/design-resources.md": [] }, - { "docs/how-to-guides/designers/animation.md": [] } - ] - }, - { "docs/how-to-guides/accessibility.md": [] }, - { "docs/how-to-guides/internationalization.md": [] } - ] - }, - { - "docs/reference-guides/README.md": [{ - "docs/reference-guides/block-api/README.md": [ - { "docs/reference-guides/block-api/block-registration.md": [] }, - { "docs/reference-guides/block-api/block-edit-save.md": [] }, - { "docs/reference-guides/block-api/block-attributes.md": [] }, - { "docs/reference-guides/block-api/block-context.md": [] }, - { "docs/reference-guides/block-api/block-deprecation.md": [] }, - { "docs/reference-guides/block-api/block-supports.md": [] }, - { "docs/reference-guides/block-api/block-transforms.md": [] }, - { "docs/reference-guides/block-api/block-templates.md": [] }, - { "docs/reference-guides/block-api/block-metadata.md": [] }, - { "docs/reference-guides/block-api/block-patterns.md": [] }, - { "docs/reference-guides/block-api/block-annotations.md": [] }, - { "docs/reference-guides/block-api/versions.md": [] } - ] - }, - { - "docs/reference-guides/filters/README.md": [ - { "docs/reference-guides/filters/block-filters.md": [] }, - { "docs/reference-guides/filters/editor-filters.md": [] }, - { "docs/reference-guides/filters/parser-filters.md": [] }, - { "docs/reference-guides/filters/autocomplete-filters.md": [] } - ] - }, - { - "docs/reference-guides/slotfills/README.md": [ - { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, - { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, - { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, - { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } - ] - }, - { "docs/reference-guides/richtext.md": [] }, - { "packages/components/README.md": "{{components}}" }, - { "docs/reference-guides/packages.md": "{{packages}}" }, - { - "docs/reference-guides/data/README.md": [ - { "docs/reference-guides/data/data-core.md": [] }, - { "docs/reference-guides/data/data-core-annotations.md": [] }, - { "docs/reference-guides/data/data-core-blocks.md": [] }, - { "docs/reference-guides/data/data-core-block-editor.md": [] }, - { "docs/reference-guides/data/data-core-editor.md": [] }, - { "docs/reference-guides/data/data-core-edit-post.md": [] }, - { "docs/reference-guides/data/data-core-notices.md": [] }, - { "docs/reference-guides/data/data-core-nux.md": [] }, - { "docs/reference-guides/data/data-core-viewport.md": [] } - ] - } - ] - }, - { - "docs/explanations/README.md": [ - - { - "docs/explanations/architecture/README.md": [ - { "docs/explanations/architecture/key-concepts.md": [] }, - { "docs/explanations/architecture/data-flow.md": [] }, - { "docs/explanations/architecture/modularity.md": [] }, - { "docs/explanations/architecture/performance.md": [] }, - { "docs/explanations/architecture/automated-testing.md": [] }, - { "docs/explanations/architecture/full-site-editing-templates.md": [] } - ] - } - ] - }, - { - "docs/contributors/README.md": [{ - "docs/contributors/code/develop.md": [ - { "docs/contributors/code/getting-started.md": [] }, - { "docs/contributors/code/git-workflow.md": [] }, - { "docs/contributors/code/coding-guidelines.md": [] }, - { "docs/contributors/code/testing-overview.md": [] }, - { "docs/contributors/code/grammar.md": [] }, - { "docs/contributors/code/scripts.md": [] }, - { "docs/contributors/code/managing-packages.md": [] }, - { "docs/contributors/code/release.md": [] }, - { "docs/contributors/code/native-mobile.md": [] }, - { "docs/contributors/code/getting-started-native-mobile.md": [] } - ] - }, - { - "docs/contributors/design/design.md": [ - { "docs/contributors/design/the-block.md": [] }, - { "docs/contributors/design/reference.md": [] } - ] - }, - { - "docs/contributors/documentation/document.md": [ - { "docs/contributors/documentation/copy-guide.md": [] } - ] - }, - { "docs/contributors/triage.md": [] }, - { "docs/contributors/localizing.md": [] }, - { "docs/contributors/accessibility-testing.md": [] }, - { "docs/contributors/repository-management.md": [] }, - { "docs/contributors/folder-structure.md": [] }, - { "docs/contributors/versions-in-wordpress.md": [] }, - { "docs/contributors/roadmap.md": [] } - ] - } + ] } + ] }, + { "docs/how-to-guides/README.md": [ + { "docs/how-to-guides/javascript/README.md": [ + { "docs/how-to-guides/javascript/plugins-background.md": [] }, + { "docs/how-to-guides/javascript/loading-javascript.md": [] }, + { "docs/how-to-guides/javascript/extending-the-block-editor.md": [] }, + { "docs/how-to-guides/javascript/troubleshooting.md": [] }, + { "docs/how-to-guides/javascript/versions-and-building.md": [] }, + { "docs/how-to-guides/javascript/scope-your-code.md": [] }, + { "docs/how-to-guides/javascript/js-build-setup.md": [] }, + { "docs/how-to-guides/javascript/esnext-js.md": [] } + ] }, + { "docs/how-to-guides/metabox/README.md": [ + { "docs/how-to-guides/metabox/meta-block-1-intro.md": [] }, + { "docs/how-to-guides/metabox/meta-block-2-register-meta.md": [] }, + { "docs/how-to-guides/metabox/meta-block-3-add.md": [] }, + { "docs/how-to-guides/metabox/meta-block-4-use-data.md": [] }, + { "docs/how-to-guides/metabox/meta-block-5-finishing.md": [] } + ] }, + { "docs/how-to-guides/notices/README.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md": [ + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-1-up-and-running.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-2-styles-and-controls.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-3-register-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-4-initialize-input.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-5-update-meta.md": [] }, + { "docs/how-to-guides/sidebar-tutorial/plugin-sidebar-6-finishing-touches.md": [] } + ] }, + { "docs/how-to-guides/block-tutorial/README.md": [ + { "docs/how-to-guides/block-tutorial/writing-your-first-block-type.md": [] }, + { "docs/how-to-guides/block-tutorial/applying-styles-with-stylesheets.md": [] }, + { "docs/how-to-guides/block-tutorial/introducing-attributes-and-editable-fields.md": [] }, + { "docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md": [] }, + { "docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md": [] }, + { "docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md": [] }, + { "docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md": [] } + ] }, + { "docs/how-to-guides/feature-flags.md": [] }, + { "docs/how-to-guides/themes/README.md": [ + { "docs/how-to-guides/themes/theme-support.md": [] }, + { "docs/how-to-guides/themes/theme-json.md": [] } + ]}, + { "docs/how-to-guides/block-based-theme/README.md": [ + { "docs/how-to-guides/block-based-theme/block-based-themes-2-adding-blocks.md": [] } + ] }, + { "docs/how-to-guides/backward-compatibility/README.md": [ + { "docs/how-to-guides/backward-compatibility/deprecations.md": [] }, + { "docs/how-to-guides/backward-compatibility/meta-box.md": [] } + ] }, + { "docs/how-to-guides/format-api/README.md": [ + { "docs/how-to-guides/format-api/1-register-format.md": [] }, + { "docs/how-to-guides/format-api/2-toolbar-button.md": [] }, + { "docs/how-to-guides/format-api/3-apply-format.md": [] } + ] }, + { "docs/how-to-guides/platform/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/README.md": [ + { "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] } + ] } + ] }, + { "docs/how-to-guides/designers/README.md": [ + { "docs/how-to-guides/designers/block-design.md": [] }, + { "docs/how-to-guides/designers/user-interface.md": [] }, + { "docs/how-to-guides/designers/design-resources.md": [] }, + { "docs/how-to-guides/designers/animation.md": [] } + ] }, + { "docs/how-to-guides/accessibility.md": [] }, + { "docs/how-to-guides/internationalization.md": [] } + ] }, + { "docs/reference-guides/README.md": [ + { "docs/reference-guides/block-api/README.md": [ + { "docs/reference-guides/block-api/block-registration.md": [] }, + { "docs/reference-guides/block-api/block-edit-save.md": [] }, + { "docs/reference-guides/block-api/block-attributes.md": [] }, + { "docs/reference-guides/block-api/block-context.md": [] }, + { "docs/reference-guides/block-api/block-deprecation.md": [] }, + { "docs/reference-guides/block-api/block-supports.md": [] }, + { "docs/reference-guides/block-api/block-transforms.md": [] }, + { "docs/reference-guides/block-api/block-templates.md": [] }, + { "docs/reference-guides/block-api/block-metadata.md": [] }, + { "docs/reference-guides/block-api/block-patterns.md": [] }, + { "docs/reference-guides/block-api/block-annotations.md": [] }, + { "docs/reference-guides/block-api/versions.md": [] } + ] }, + { "docs/reference-guides/filters/README.md": [ + { "docs/reference-guides/filters/block-filters.md": [] }, + { "docs/reference-guides/filters/editor-filters.md": [] }, + { "docs/reference-guides/filters/parser-filters.md": [] }, + { "docs/reference-guides/filters/autocomplete-filters.md": [] } + ] }, + { "docs/reference-guides/slotfills/README.md": [ + { "docs/reference-guides/slotfills/main-dashboard-button.md": [] }, + { "docs/reference-guides/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-document-setting-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-more-menu-item.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-post-status-info.md": [] }, + { "docs/reference-guides/slotfills/plugin-pre-publish-panel.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar.md": [] }, + { "docs/reference-guides/slotfills/plugin-sidebar-more-menu-item.md": [] } + ] }, + { "docs/reference-guides/richtext.md": [] }, + { "packages/components/README.md": "{{components}}" }, + { "docs/reference-guides/packages.md": "{{packages}}" }, + { "docs/reference-guides/data/README.md": [ + { "docs/reference-guides/data/data-core.md": [] }, + { "docs/reference-guides/data/data-core-annotations.md": [] }, + { "docs/reference-guides/data/data-core-blocks.md": [] }, + { "docs/reference-guides/data/data-core-block-editor.md": [] }, + { "docs/reference-guides/data/data-core-editor.md": [] }, + { "docs/reference-guides/data/data-core-edit-post.md": [] }, + { "docs/reference-guides/data/data-core-notices.md": [] }, + { "docs/reference-guides/data/data-core-nux.md": [] }, + { "docs/reference-guides/data/data-core-viewport.md": [] } + ] } + ] }, + { "docs/explanations/README.md": [ + { "docs/explanations/architecture/README.md": [ + { "docs/explanations/architecture/key-concepts.md": [] }, + { "docs/explanations/architecture/data-flow.md": [] }, + { "docs/explanations/architecture/modularity.md": [] }, + { "docs/explanations/architecture/performance.md": [] }, + { "docs/explanations/architecture/automated-testing.md": [] }, + { "docs/explanations/architecture/full-site-editing-templates.md": [] } + ] } + ] }, + { "docs/contributors/README.md": [ + { "docs/contributors/code/develop.md": [ + { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/git-workflow.md": [] }, + { "docs/contributors/code/coding-guidelines.md": [] }, + { "docs/contributors/code/testing-overview.md": [] }, + { "docs/contributors/code/grammar.md": [] }, + { "docs/contributors/code/scripts.md": [] }, + { "docs/contributors/code/managing-packages.md": [] }, + { "docs/contributors/code/release.md": [] }, + { "docs/contributors/code/native-mobile.md": [] }, + { "docs/contributors/code/getting-started-native-mobile.md": [] } + ] }, + { "docs/contributors/design/design.md": [ + { "docs/contributors/design/the-block.md": [] }, + { "docs/contributors/design/reference.md": [] } + ] }, + { "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/copy-guide.md": [] } + ] }, + { "docs/contributors/triage.md": [] }, + { "docs/contributors/localizing.md": [] }, + { "docs/contributors/accessibility-testing.md": [] }, + { "docs/contributors/repository-management.md": [] }, + { "docs/contributors/folder-structure.md": [] }, + { "docs/contributors/versions-in-wordpress.md": [] }, + { "docs/contributors/roadmap.md": [] } + ] } ] \ No newline at end of file From 931a80a66ef4844b1812a2051cb351611b93a7f1 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 25 Feb 2021 13:09:51 +0100 Subject: [PATCH 64/68] Update toc.json --- docs/manifest.json | 2 +- docs/toc.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/manifest.json b/docs/manifest.json index 099e0bdcc92d3..5b9ef0fe93df1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -2,7 +2,7 @@ { "title": "Getting started", "slug": "handbook", - "markdown_source": "../docs/readme.md", + "markdown_source": "../docs/README.md", "parent": null }, { diff --git a/docs/toc.json b/docs/toc.json index 11045fd3cdb1e..175db6afc83ea 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,5 +1,5 @@ [ - { "docs/readme.md": [ + { "docs/README.md": [ { "docs/getting-started/README.md": [ { "docs/getting-started/tutorials/README.md": [ { "docs/getting-started/tutorials/devenv/README.md": [ From e6ce22e19f175e0960b4170f1a274c6121cb2adb Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 4 Mar 2021 08:03:18 +0100 Subject: [PATCH 65/68] Add new line to the create-block tutorial --- docs/manifest.json | 6 ++++++ docs/toc.json | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index 5b9ef0fe93df1..267fbef45b017 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -71,6 +71,12 @@ "markdown_source": "../docs/getting-started/tutorials/create-block/finishing.md", "parent": "create-block" }, + { + "title": "Share your Block with the World", + "slug": "submitting-to-block-directory", + "markdown_source": "../docs/getting-started/tutorials/create-block/submitting-to-block-directory.md", + "parent": "create-block" + }, { "title": "Glossary", "slug": "glossary", diff --git a/docs/toc.json b/docs/toc.json index 175db6afc83ea..3439f56c77981 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -11,7 +11,8 @@ { "docs/getting-started/tutorials/create-block/attributes.md": [] }, { "docs/getting-started/tutorials/create-block/block-code.md": [] }, { "docs/getting-started/tutorials/create-block/author-experience.md": [] }, - { "docs/getting-started/tutorials/create-block/finishing.md": [] } + { "docs/getting-started/tutorials/create-block/finishing.md": [] }, + { "docs/getting-started/tutorials/create-block/submitting-to-block-directory.md": [] } ] } ] }, { "docs/getting-started/glossary.md": [] }, From c35f89f69d2eaaa130e5610dd470e4d30dc3f800 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 4 Mar 2021 13:00:16 +0100 Subject: [PATCH 66/68] Removed duplicate howto-guides folder --- docs/howto-guides/block-based-theme/README.md | 380 ------------------ .../block-based-themes-2-adding-blocks.md | 55 --- 2 files changed, 435 deletions(-) delete mode 100644 docs/howto-guides/block-based-theme/README.md delete mode 100644 docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md diff --git a/docs/howto-guides/block-based-theme/README.md b/docs/howto-guides/block-based-theme/README.md deleted file mode 100644 index 2e0c8402d3761..0000000000000 --- a/docs/howto-guides/block-based-theme/README.md +++ /dev/null @@ -1,380 +0,0 @@ -# Creating a block-based theme - -The purpose of this tutorial is to show how to create a basic block based theme -and help theme developers transition to full site editing. - -You will learn about the required files, how to combine templates and template parts, -how to add presets for global styles, and how to add blocks and export the templates in the site editor. - -Full site editing is an experimental feature and the workflow in this tutorial is likely to change. - -This tutorial is up to date as of Gutenberg version 9.1. - -## Table of Contents - - 1. [What is needed to create a block-based theme?](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#what-is-needed-to-create-a-block-based-theme) - 2. [Creating the theme](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-theme) - 3. [Creating the templates and template parts](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#creating-the-templates-and-template-parts) - 4. [Experimental-theme.json - Global styles](/docs/designers-developers/developers/tutorials/block-based-theme/README.md#experimental-theme-json-global-styles) - 5. [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) - -## What is needed to create a block-based theme? - -To use a block based theme you need to have Gutenberg installed and full site editing must be enabled. - -Full site editing can be enabled from the Gutenberg experiments menu in the WordPress admin area. - -A block-based theme is built using HTML templates and template parts. Templates are the main files used in the [template hierarchy](https://developer.wordpress.org/themes/basics/template-hierarchy/), for example index, single or archive. Templates can optionally include structural template parts, for example a header, footer or sidebar. - -Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. The block HTML is generated in and exported from the **site editor**. It can also be added to the theme's HTML files manually. - -### Required files and file structure - -A block based theme requires an `index.php` file, an index template file, a `style.css` file, and a `functions.php` file. - -The theme may optionally include an [experimental-theme.json file](/docs/designers-developers/developers/themes/theme-json.md) to manage global styles. You decide what additional templates and template parts to include in your theme. - -Templates are placed inside the `block-templates` folder, and template parts are placed inside the `block-template-parts` folder: - -``` -theme -|__ style.css -|__ functions.php -|__ index.php -|__ experimental-theme.json -|__ block-templates - |__ index.html - |__ single.html - |__ archive.html - |__ ... -|__ block-template-parts - |__ header.html - |__ footer.html - |__ sidebar.html - |__ ... -``` - -## Creating the theme - -Create a new folder for your theme in `/wp-content/themes/`. -Inside this folder, create the `block-templates` and `block-template-parts` folders. - -Create a `style.css` file. The file header in the `style.css` file has [the same items that you would use in a traditional theme](https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/#explanations). - -``` -/* -Theme Name: My first theme -Theme URI: -Author: The WordPress team -Author URI: https://wordpress.org/ -Description: -Tags: -Version: 1.0.0 -Requires at least: 5.0 -Tested up to: 5.4 -Requires PHP: 7.0 -License: GNU General Public License v2 or later -License URI: http://www.gnu.org/licenses/gpl-2.0.html -Text Domain: myfirsttheme - -This theme, like WordPress, is licensed under the GPL. -Use it to make something cool, have fun, and share what you've learned with others. -*/ -``` - -Create a `functions.php` file. - -In this file, you will enqueue the `style.css` file and add any theme support that you want to use. For example colors, wide blocks and featured images. - -_You no longer need to add theme support for the title tag. It is already enabled with full site editing._ - -https://developer.wordpress.org/themes/basics/theme-functions/#what-is-functions-php - -https://developer.wordpress.org/block-editor/developers/themes/theme-support/ - -```php -. - */ - add_theme_support( 'automatic-feed-links' ); - - /** - * Enable support for post thumbnails and featured images. - */ - add_theme_support( 'post-thumbnails' ); - - add_theme_support( 'editor-color-palette', array( - array( - 'name' => __( 'strong magenta', 'myfirsttheme' ), - 'slug' => 'strong-magenta', - 'color' => '#a156b4', - ), - array( - 'name' => __( 'very dark gray', 'myfirsttheme' ), - 'slug' => 'very-dark-gray', - 'color' => '#444', - ), - ) ); - - add_theme_support( 'wp-block-styles' ); - - add_theme_support( 'align-wide' ); -} -endif; // myfirsttheme_setup -add_action( 'after_setup_theme', 'myfirsttheme_setup' ); - -/** - * Enqueue theme scripts and styles. - */ -function myfirsttheme_scripts() { - wp_enqueue_style( 'myfirsttheme-style', get_stylesheet_uri() ); - - if ( is_singular() && comments_open() && get_option( 'thread_comments' ) ) { - wp_enqueue_script( 'comment-reply' ); - } -} -add_action( 'wp_enqueue_scripts', 'myfirsttheme_scripts' ); -``` - -Create an `index.php` file. -This file is used as a fallback if the theme is activated when full site editing is not enabled. -You may leave the file empty for this tutorial. - -Your theme should now include the following files and folders: - -``` -theme - |__ style.css - |__ functions.php - |__ index.php - |__ block-templates - |__ (empty folder) - |__ block-template-parts - |__ (empty folder) -``` - -### Creating the templates and template parts - -Create two template parts called `footer.html` and `header.html` and place them inside the `block-template-parts` folder. You can leave the files empty for now. - -Inside the block-templates folder, create an `index.html` file. - -In `index.html`, include the template parts by adding two HTML comments. - -The HTML comments starts with `wp:template-part` which is the name of the template-part block type. Inside the curly brackets are two keys and their values: The slug of the template part, and the theme name. - -``` - - - -``` - -If you used a different theme name, adjust the value for the theme key. - -Eventually, you will be able to create and combine templates and template parts directly in the site editor. - -### Experimental-theme.json - Global styles - -The purpose of the `experimental-theme.json` file is to make it easier to style blocks by setting defaults. - -It is used to: - * Create CSS variables (also called CSS custom properties) that can be used to style blocks both on the front and in the editor. - * Set global styles. - * Set styles for individual block types. - -[The documentation for global styles contains a list of available block and style combinations.](https://developer.wordpress.org/block-editor/developers/themes/theme-json/) - -Create a file called `experimental-theme.json` and save it inside the main folder. - -CSS variables are generated using **Global presets**. The variables are added to the `:root` on the front, and to the `.editor-styles-wrapper` class in the editor. - -Styles that are added to the themes `style.css` file or an editor style sheet are loaded after global styles. - -Add the following global presets to the `experimental-theme.json` file: - -``` -{ - "global": { - "settings": { - "color": { - "palette": [ - { - "slug": "strong-magenta", - "color": "#a156b4" - }, - { - "slug": "very-dark-gray", - "color": "#444" - }, - ] - }, - "custom": { - "line-height": [ - { - "small": "1.3" - }, - { - "medium": "2" - }, - { - "large": "2.5" - } - ] - } - } - } -} -``` - -This code generates the following variables: -``` - --wp--preset--color--strong-magenta: #a156b4; - --wp--preset--color--very-dark-gray: #444; - - --wp--custom--line-height--small: 1.3; - --wp--custom--line-height--medium: 2; - --wp--custom--line-height--large: 2.5; -``` - -**Global styles** are used to set default values for the website and for the blocks. - -This example will add the dark grey color as the website background color. -Add the code inside the globals, after the presets: -``` - "styles": { - "color": { - "background": "var(--wp--preset--color--very-dark-gray)" - } - } -``` - -**Block styles** sets default values for all blocks of a specific type. - -This example uses the CSS variables to add text color and line height to the H2 heading block, -in combination with a custom font size. - -When adding styles for the headings block, include the heading level, h1 to h6. - -Block styles are separate from global styles. Add the code after the globals, but before the closing brace. - -``` -"core/heading/h2": { - "styles": { - "color": { - "text": "var( --wp--preset--color--strong-magenta )" - }, - "typography": { - "fontSize": "2.5rem", - "lineHeight": "var(--wp--custom--line-height--medium)" - } - } -}, -``` - -CSS variables for font sizes are generated using the `editor-font-sizes` theme support or by adding a global preset. - -https://developer.wordpress.org/block-editor/developers/themes/theme-support/#block-font-sizes - -If the theme does not add any custom font sizes, variables are created using the default sizes. -This example adds the default medium font size to the paragraph block. - -The font sizes are unitless, which is why calc is used: https://developer.mozilla.org/en-US/docs/Web/CSS/calc - -``` -"core/paragraph": { - "styles": { - "typography": { - "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" - } - } -}, -``` - -Using the CSS variables is optional. In this example, the default background color for the group block is changed to white using a color code: - -``` -"core/group": { - "styles": { - "color": { - "background": "#ffffff" - } - } -} -``` - -Below are the presets and styles combined: - -``` -{ - "global": { - "settings": { - "color": { - "palette": [ - { - "slug": "strong-magenta", - "color": "#a156b4" - }, - { - "slug": "very-dark-gray", - "color": "#444" - }, - ] - }, - "custom": { - "line-height": [ - { - "small": "1.3" - }, - { - "medium": "2" - }, - { - "large": "2.5" - } - ] - } - } - }, - - "core/heading/h2": { - "styles": { - "color": { - "text": "var( --wp--preset--color--strong-magenta )" - }, - "typography": { - "fontSize": "2.5rem", - "lineHeight": "var(--wp--custom--line-height--medium)" - } - } - }, - - "core/paragraph": { - "styles": { - "typography": { - "fontSize": "calc(1px * var( --wp--preset--font-size--medium ))" - } - } - }, - - "core/group": { - "styles": { - "color": { - "background": "#ffffff" - } - } - } -} -``` - -## [Adding blocks](/docs/designers-developers/developers/tutorials/block-based-theme/block-based-themes-2-adding-blocks.md) diff --git a/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md b/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md deleted file mode 100644 index c1e5a2d6a4658..0000000000000 --- a/docs/howto-guides/block-based-theme/block-based-themes-2-adding-blocks.md +++ /dev/null @@ -1,55 +0,0 @@ -# Adding blocks to your theme - -Each template or template part contains the [block grammar](https://developer.wordpress.org/block-editor/principles/key-concepts/#blocks), the HTML, for the selected blocks. - -There is more than one way to add blocks to the theme files: - -- Adding and editing blocks in the site editor and exporting the theme. -- Adding block HTML and comments to the HTML files manually. - -## Working with blocks and templates in the site editor - -The beta site editor is available from the WordPress admin area when full site editing is enabled. To use the site editor, a full site editing theme must be installed and active. - -The site editor is similar to the block editor, but is used for the site layout instead of the post and page content. - -Two new menus have been added to the top toolbar of the editor: - -One that shows a list of posts, pages and categories, and indicates the item that is used as the front page. - -![Site editor toolbar page menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-page-menu.png) - -And a list of templates and template parts, that indicates the item that is being edited. Hovering over the parts will show a preview. - -![Site editor toolbar template menu](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-template-menu.png) - -Template parts can be selected and edited directly in the site editor, like other blocks: - -![A selected template part is highlighted. When selected, the template part has a limited set of alignment controls in the block toolbar](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-editor-template-part.png) - -Select the header template part in the menu to view and edit it individually. Add the blocks that you would like in your header, for example a site title block, a navigation block, and an image. - -Next, select the footer template part and add some content, for example widget blocks. - -Select the index template again to view the template parts together in the page context. - -To add a post loop to the index template, add a **query** block. The query block includes the query loop and the query pagination. The default loop displays the post title and post content. The query loop and query pagination are also available as individual blocks. - - -## Saving templates and template parts - -When you have made your changes, click on the **update design** button in the upper right corner, -where you normally publish and update your content. - -Select the templates and template parts that you want to save: - -![The save menu displays a list of templates and template parts with checkboxes](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-save.png) - -When you save changes in the site editor, the files in the active theme are not updated. Instead, the templates and template parts are saved as custom post types, that are accessed via the appearance menu. - -![The template parts view in the admin area displays a list of all saved template parts](https://wordpress.org/gutenberg/files/2020/07/block-based-themes-appearance-template-parts.png) - - -## Exporting changes - -Saved templates and template parts can be exported as a partial theme from the Tools menu in the site editor. The block HTML code can then be copied to the theme that you are editing. From 2022ef440ee2e243460909323cafda84a61da491 Mon Sep 17 00:00:00 2001 From: JustinyAhin Date: Thu, 4 Mar 2021 16:50:40 +0100 Subject: [PATCH 67/68] Update contributors readme file --- docs/contributors/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributors/readme.md b/docs/contributors/readme.md index 03d6da96ab333..548fdaac0d5cc 100644 --- a/docs/contributors/readme.md +++ b/docs/contributors/readme.md @@ -30,4 +30,4 @@ The Gutenberg project uses Github for managing code and tracking issues. Please ## Guidelines -See the [Contributing Guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/CONTRIBUTING.md) for the rules around contributing: This includes the code of conduct and licensing information. +See the [Contributing Guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/CONTRIBUTING.md) for the rules around contributing: This includes the code of conduct and licensing information. \ No newline at end of file From 13d671cfdf5e1e9106c2b5cdff4244281cc649ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Justin=20S=C3=A8gb=C3=A9dji=20Ahinon?= Date: Thu, 4 Mar 2021 16:53:11 +0100 Subject: [PATCH 68/68] Rename readme.md to README.md --- docs/contributors/{readme.md => README.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename docs/contributors/{readme.md => README.md} (99%) diff --git a/docs/contributors/readme.md b/docs/contributors/README.md similarity index 99% rename from docs/contributors/readme.md rename to docs/contributors/README.md index 548fdaac0d5cc..03d6da96ab333 100644 --- a/docs/contributors/readme.md +++ b/docs/contributors/README.md @@ -30,4 +30,4 @@ The Gutenberg project uses Github for managing code and tracking issues. Please ## Guidelines -See the [Contributing Guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/CONTRIBUTING.md) for the rules around contributing: This includes the code of conduct and licensing information. \ No newline at end of file +See the [Contributing Guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/CONTRIBUTING.md) for the rules around contributing: This includes the code of conduct and licensing information.