Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the block editor handbook table of content #28665

Merged
merged 79 commits into from
Mar 9, 2021
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
66b7e42
Create an appendix folder and add its files
JustinyAhin Feb 2, 2021
1d1a5f5
Move full site editing templates under developer chapter
JustinyAhin Feb 2, 2021
b783d60
Move platform folder under tutorials chapter
JustinyAhin Feb 2, 2021
e1f5f90
Update the appendix folder readme
JustinyAhin Feb 2, 2021
51a02fb
Move plateform folder to developers folder
JustinyAhin Feb 8, 2021
f0f19d8
Update packages reference paths
JustinyAhin Feb 8, 2021
96b06b4
Update toc.json
JustinyAhin Feb 8, 2021
9983a81
Update toc.json
JustinyAhin Feb 8, 2021
a78f5a1
Update versions-in-wordpress.md with master
JustinyAhin Feb 8, 2021
d866781
Update toc structure
JustinyAhin Feb 8, 2021
884e081
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Feb 23, 2021
5c504f8
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Feb 24, 2021
f84de0e
Update manifest.json and toc.json
JustinyAhin Feb 24, 2021
11a2040
Update the folder structure of docs/ following toc.json
JustinyAhin Feb 24, 2021
809031c
Update links in the documentation after changing the folder structure
JustinyAhin Feb 24, 2021
740c43a
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Feb 25, 2021
fa812c3
Update links for contributor section
JustinyAhin Feb 25, 2021
4312e07
Move architecture folder under explanation
JustinyAhin Feb 25, 2021
7f3604a
Replace occurence of howto-guides with how-to-guides
JustinyAhin Feb 25, 2021
d953969
Use relative link for slotfills README
JustinyAhin Feb 25, 2021
5a5d731
Move assets folder to /docs directory
JustinyAhin Feb 25, 2021
216848c
Update links to general assets
JustinyAhin Feb 25, 2021
d504dc4
Update links to designers assets
JustinyAhin Feb 25, 2021
b8bdf8d
Update assets links
JustinyAhin Feb 25, 2021
5b06965
Update reference guides README
JustinyAhin Feb 25, 2021
330f795
Update reference guides readme
JustinyAhin Feb 25, 2021
e1fc163
Update explanations readme
JustinyAhin Feb 25, 2021
939f8ac
Update explanations readme
JustinyAhin Feb 25, 2021
ddc805d
Use relative links
JustinyAhin Feb 25, 2021
2aa06c0
Rename how-to-guides/block-based-themes to how-to-guides/block-based-…
JustinyAhin Feb 25, 2021
eecc010
Move the main readme to /docs
JustinyAhin Feb 25, 2021
3460f07
Update getting started readme
JustinyAhin Feb 25, 2021
c2d7ebc
Update manifest.json
JustinyAhin Feb 25, 2021
1bdb7e4
CS updates on toc.json
JustinyAhin Feb 25, 2021
8c4e58c
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Feb 25, 2021
d77eb48
Update toc.json
JustinyAhin Feb 25, 2021
fe0b6de
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Feb 26, 2021
2c5e721
Merge branch 'master' into block-editor-handbook-toc
JustinyAhin Mar 3, 2021
1d0f49b
Add new line to the create-block tutorial
JustinyAhin Mar 4, 2021
a0ff55f
Create an appendix folder and add its files
JustinyAhin Feb 2, 2021
107b6d5
Move full site editing templates under developer chapter
JustinyAhin Feb 2, 2021
7154948
Move platform folder under tutorials chapter
JustinyAhin Feb 2, 2021
1e9cd43
Update the appendix folder readme
JustinyAhin Feb 2, 2021
f3965f7
Move plateform folder to developers folder
JustinyAhin Feb 8, 2021
63b36d7
Update packages reference paths
JustinyAhin Feb 8, 2021
487a3cb
Update toc.json
JustinyAhin Feb 8, 2021
c324cae
Update toc.json
JustinyAhin Feb 8, 2021
3660284
Update toc structure
JustinyAhin Feb 8, 2021
48a9600
Update manifest.json and toc.json
JustinyAhin Feb 24, 2021
907a3ca
Update the folder structure of docs/ following toc.json
JustinyAhin Feb 24, 2021
72eefd7
Update links in the documentation after changing the folder structure
JustinyAhin Feb 24, 2021
a566a6f
Update links for contributor section
JustinyAhin Feb 25, 2021
e8e4678
Move architecture folder under explanation
JustinyAhin Feb 25, 2021
eeb7e45
Replace occurence of howto-guides with how-to-guides
JustinyAhin Feb 25, 2021
657c877
Use relative link for slotfills README
JustinyAhin Feb 25, 2021
f1d1b6e
Move assets folder to /docs directory
JustinyAhin Feb 25, 2021
12fb9aa
Update links to general assets
JustinyAhin Feb 25, 2021
14ac7e5
Update links to designers assets
JustinyAhin Feb 25, 2021
cdda387
Update assets links
JustinyAhin Feb 25, 2021
77e5b08
Update reference guides README
JustinyAhin Feb 25, 2021
8374627
Update reference guides readme
JustinyAhin Feb 25, 2021
05be39c
Update explanations readme
JustinyAhin Feb 25, 2021
0ea24ca
Update explanations readme
JustinyAhin Feb 25, 2021
86cab63
Use relative links
JustinyAhin Feb 25, 2021
8e63b3e
Rename how-to-guides/block-based-themes to how-to-guides/block-based-…
JustinyAhin Feb 25, 2021
e8f721f
Move the main readme to /docs
JustinyAhin Feb 25, 2021
e71cdd5
Update getting started readme
JustinyAhin Feb 25, 2021
f442f99
Update manifest.json
JustinyAhin Feb 25, 2021
81816e5
CS updates on toc.json
JustinyAhin Feb 25, 2021
931a80a
Update toc.json
JustinyAhin Feb 25, 2021
e6ce22e
Add new line to the create-block tutorial
JustinyAhin Mar 4, 2021
94b0865
Merge branch 'block-editor-handbook-toc' of https://github.com/Justin…
JustinyAhin Mar 4, 2021
011d87c
Merge branch 'trunk' into block-editor-handbook-toc
JustinyAhin Mar 4, 2021
c35f89f
Removed duplicate howto-guides folder
JustinyAhin Mar 4, 2021
2022ef4
Update contributors readme file
JustinyAhin Mar 4, 2021
13d671c
Rename readme.md to README.md
JustinyAhin Mar 4, 2021
04c533f
Merge branch 'trunk' into block-editor-handbook-toc
JustinyAhin Mar 8, 2021
ea92dac
Merge branch 'trunk' into block-editor-handbook-toc
JustinyAhin Mar 8, 2021
f3e5ab1
Merge branch 'trunk' into block-editor-handbook-toc
JustinyAhin Mar 9, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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:

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
File renamed without changes.
18 changes: 0 additions & 18 deletions docs/designers-developers/developers/block-api/README.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/designers-developers/developers/data/README.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/designers-developers/developers/tutorials/readme.md

This file was deleted.

This file was deleted.

Empty file added docs/explanations/README.md
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 8 additions & 8 deletions docs/readme.md → docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading