diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9381a3cd9f2af5..09423bf3e011a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,13 +4,13 @@ Welcome to WordPress' Gutenberg project! We hope you join us in creating the fut ## How can I contribute? -To learn all about contributing to the Gutenberg project, see the [Contributor Guide](/docs/contributors/readme.md). The handbook includes all the details you need to get setup and start shaping the future of web publishing. +To learn all about contributing to the Gutenberg project, see the [Contributor Guide](/docs/contributors/README.md). The handbook includes all the details you need to get setup and start shaping the future of web publishing. -- Code? See the [developer section](/docs/contributors/develop.md). +- Code? See the [developer section](/docs/contributors/code/code.md). -- Design? See the [design section](/docs/contributors/design.md). +- Design? See the [design section](/docs/contributors/design/design.md). -- Documentation? See the [documentation section](/docs/contributors/document.md). +- Documentation? See the [documentation section](/docs/contributors/documentation/documentation.md). - Triage? We need help reviewing existing issues to make sure they’re relevant and actionable. Triage is an important contribution because it allows us to work on the highest priority issues. To learn more, please see the [triaging issues section](docs/contributors/triage.md). diff --git a/README.md b/README.md index ab5258f17a996b..3f6d7d36199325 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Get hands on: check out the [block editor live demo](https://wordpress.org/guten Extending and customizing is at the heart of the WordPress platform, this is no different for the Gutenberg project. The editor and future products can be extended by third-party developers using plugins. -Review the [Create a Block tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the fastest way to get started extending the block editor. See the [Developer Documentation](https://developer.wordpress.org/block-editor/developers/) for extensive tutorials, documentation, and API references. +Review the [Create a Block tutorial](/docs/getting-started/tutorials/create-block/README.md) for the fastest way to get started extending the block editor. See the [Developer Documentation](https://developer.wordpress.org/block-editor/developers/) for extensive tutorials, documentation, and API references. ### Contribute to Gutenberg diff --git a/docs/README.md b/docs/README.md index 0f91f0036e9073..2b4f4f9ec7c7a8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,21 +22,21 @@ 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/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. +[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) +- [Gutenberg Architecture](/docs/explanations/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) +- [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. +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. diff --git a/docs/contributors/README.md b/docs/contributors/README.md index 03d6da96ab333e..7ce973af207fc2 100644 --- a/docs/contributors/README.md +++ b/docs/contributors/README.md @@ -8,11 +8,11 @@ Gutenberg is a sub-project of Core WordPress. Please see the [Core Contributor H Find the section below based on what you are looking to contribute: -- **Code?** See the [developer section](/docs/contributors/develop.md). +- **Code?** See the [developer section](/docs/contributors/code/code.md). -- **Design?** See the [design section](/docs/contributors/design.md). +- **Design?** See the [design section](/docs/contributors/design/design.md). -- **Documentation?** See the [documentation section](/docs/contributors/document.md) +- **Documentation?** See the [documentation section](/docs/contributors/documentation/documentation.md) - **Triage Support?** See the [triaging issues section](/docs/contributors/triage.md) diff --git a/docs/contributors/accessibility-testing.md b/docs/contributors/accessibility-testing.md index d7b56d715bcfcb..4e6e915222e80d 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/code/getting-started.md). +Make sure you have set up your local environment following the instructions on [Getting Started](/docs/contributors/code/getting-started-with-code-contribution.md). ## Keyboard Testing diff --git a/docs/contributors/code/develop.md b/docs/contributors/code/code.md similarity index 91% rename from docs/contributors/code/develop.md rename to docs/contributors/code/code.md index ae1d8df2d69fc0..53637b380ca65d 100644 --- a/docs/contributors/code/develop.md +++ b/docs/contributors/code/code.md @@ -16,7 +16,7 @@ Browse [the issues list](https://github.com/wordpress/gutenberg/issues) to find ## Contributor Resources -* [Getting Started](/docs/contributors/code/getting-started.md) documents getting your development environment setup, this includes your test site and developer tools suggestions. +* [Getting Started](/docs/contributors/code/getting-started-with-code-contribution.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. diff --git a/docs/contributors/code/coding-guidelines.md b/docs/contributors/code/coding-guidelines.md index 70959b81aad420..23f16e0f740c5d 100644 --- a/docs/contributors/code/coding-guidelines.md +++ b/docs/contributors/code/coding-guidelines.md @@ -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/code/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-with-code-contribution.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/getting-started.md b/docs/contributors/code/getting-started-with-code-contribution.md similarity index 98% rename from docs/contributors/code/getting-started.md rename to docs/contributors/code/getting-started-with-code-contribution.md index b8d7cd9f087809..f5384b1bd05874 100644 --- a/docs/contributors/code/getting-started.md +++ b/docs/contributors/code/getting-started-with-code-contribution.md @@ -1,12 +1,12 @@ -# Getting Started +# Getting Started With Code Contribution -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. +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/getting-started/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/getting-started/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/code/native-mobile.md b/docs/contributors/code/native-mobile.md index e62ba1254d32e1..91f4927a1fa6c2 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/code/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-with-code-contribution-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,7 +21,7 @@ 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/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) +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-with-code-contribution-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/). diff --git a/docs/contributors/code/testing-overview.md b/docs/contributors/code/testing-overview.md index 377e5276833c2b..6c682fe6083bdf 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/code/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-with-code-contribution.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/code/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-with-code-contribution.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/code/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-with-code-contribution.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/code/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-with-code-contribution.md#local-environment), you can run the PHP tests locally using this command: ```bash npm run test-php diff --git a/docs/contributors/documentation/document.md b/docs/contributors/documentation/documentation.md similarity index 98% rename from docs/contributors/documentation/document.md rename to docs/contributors/documentation/documentation.md index 857b2487c6b48e..061ab751101476 100644 --- a/docs/contributors/documentation/document.md +++ b/docs/contributors/documentation/documentation.md @@ -67,7 +67,7 @@ This way they will be properly handled in all three aforementioned contexts. Use the full directory and filename from the Gutenberg repository, not the published path; the Block Editor Handbook creates short URLs—you can see this in the tutorials section. Likewise, the `readme.md` portion is dropped in the handbook, but should be included in links. -An example, the link to this page is: `/docs/contributors/document.md` +An example, the link to this page is: `/docs/contributors/documentation/documentation.md` ### Code Examples @@ -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/code/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-with-code-contribution.md) for complete details. An example config for using Visual Studio Code and the Prettier extensions: diff --git a/docs/explanations/architecture/README.md b/docs/explanations/architecture/README.md index c0b214d6147fed..3ae16794dfa4ff 100644 --- a/docs/explanations/architecture/README.md +++ b/docs/explanations/architecture/README.md @@ -2,12 +2,12 @@ Let’s look at the big picture and the architectural and UX principles of the block editor and the Gutenberg repository. -- [Key Concepts](/docs/architecture/key-concepts.md) -- [Data Format And Data Flow](/docs/architecture/data-flow.md) -- [Understand the repository folder structure](/docs/architecture/folder-structure.md). -- [Modularity and WordPress Packages](/docs/architecture/modularity.md). -- [Block Editor Performance](/docs/architecture/performance.md). +- [Key Concepts](/docs/explanations/architecture/key-concepts.md) +- [Data Format And Data Flow](/docs/explanations/architecture/data-flow.md) +- [Understand the repository folder structure](/docs/contributors/folder-structure.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/architecture/automated-testing.md) -- [What's the difference between the different editor packages? What's the purpose of each package?](/docs/architecture/modularity.md#whats-the-difference-between-the-different-editor-packages-whats-the-purpose-of-each-package) -- [Template and template parts flows](/docs/architecture/fse-templates.md) +- [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/fse-templates.md) diff --git a/docs/explanations/architecture/full-site-editing-templates.md b/docs/explanations/architecture/full-site-editing-templates.md index 7c19996eaa699f..11e8728ba1aa3f 100644 --- a/docs/explanations/architecture/full-site-editing-templates.md +++ b/docs/explanations/architecture/full-site-editing-templates.md @@ -1,4 +1,6 @@ -### Template and template part flows +# Full Site Editing Templates + +## Template and template part flows > 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. diff --git a/docs/explanations/architecture/key-concepts.md b/docs/explanations/architecture/key-concepts.md index 080e2c5803f755..1aca3b60ff1ee8 100644 --- a/docs/explanations/architecture/key-concepts.md +++ b/docs/explanations/architecture/key-concepts.md @@ -37,7 +37,7 @@ Given a block type, a block variation is a predefined set of its initial attribu **More on Blocks** - **[Block API](/docs/reference-guides/block-api/README.md)** -- **[Tutorial: Building A Custom Block](/docs/getting-started/tutorials/create-block/readme.md)** +- **[Tutorial: Building A Custom Block](/docs/getting-started/tutorials/create-block/README.md)** ## Reusable Blocks diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md index d4ca067e40c377..aba712e9b0b17d 100644 --- a/docs/getting-started/faq.md +++ b/docs/getting-started/faq.md @@ -324,7 +324,7 @@ This is currently a work in progress and we recommend reviewing the [block based ## What are block variations? Are they the same as block styles? -No, [block variations](/docs/designers-developers/developers/block-api/block-variations.md) 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. +No, [block variations](/docs/reference-guides/block-api/block-variations.md) 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/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. diff --git a/docs/getting-started/tutorials/README.md b/docs/getting-started/tutorials/README.md index 57a4d2557461fd..7dea27c0fd2355 100644 --- a/docs/getting-started/tutorials/README.md +++ b/docs/getting-started/tutorials/README.md @@ -1,14 +1,14 @@ # Tutorials -- 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. +- 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/how-to-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. +- 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/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. +- 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/how-to-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/how-to-guides/notices/README.md) to learn how to display informational UI at the top of the editor. diff --git a/docs/getting-started/tutorials/create-block/README.md b/docs/getting-started/tutorials/create-block/README.md index 653f14fca869fc..75719ca9a85e6a 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/getting-started/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 diff --git a/docs/getting-started/tutorials/create-block/wp-plugin.md b/docs/getting-started/tutorials/create-block/wp-plugin.md index 269ac279251e19..d7185538fdee97 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/getting-started/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 diff --git a/docs/getting-started/tutorials/devenv/README.md b/docs/getting-started/tutorials/devenv/README.md index 05ae80c3da4fbd..fa510dfbd62df4 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/code/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-with-code-contribution.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/how-to-guides/README.md b/docs/how-to-guides/README.md index fee7fdf2657bb9..8cc028f7b2e59f 100644 --- a/docs/how-to-guides/README.md +++ b/docs/how-to-guides/README.md @@ -1,4 +1,4 @@ -# Developer Documentation +# How-to Guides The new editor is highly flexible, like most of WordPress. You can build custom blocks, modify the editor's appearance, add special plugins, and much more. @@ -6,7 +6,7 @@ The new editor is highly flexible, like most of WordPress. You can build custom 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. +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 @@ -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/how-to-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). diff --git a/docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md b/docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md index e0ea9b69502335..b2b4c9efb89308 100644 --- a/docs/how-to-guides/block-tutorial/generate-blocks-with-wp-cli.md +++ b/docs/how-to-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/getting-started/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/how-to-guides/format-api/README.md b/docs/how-to-guides/format-api/README.md index bc028f4f073172..dfaafaf2206e54 100644 --- a/docs/how-to-guides/format-api/README.md +++ b/docs/how-to-guides/format-api/README.md @@ -4,7 +4,7 @@ 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/how-to-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 diff --git a/docs/how-to-guides/javascript/js-build-setup.md b/docs/how-to-guides/javascript/js-build-setup.md index b3b4eeaf035ec3..15bcf85f4914c4 100644 --- a/docs/how-to-guides/javascript/js-build-setup.md +++ b/docs/how-to-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/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. +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-with-code-contribution.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. @@ -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/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. +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. diff --git a/docs/how-to-guides/metabox/meta-block-1-intro.md b/docs/how-to-guides/metabox/meta-block-1-intro.md index 4e13ac7a7d3d08..1b01662588eb75 100644 --- a/docs/how-to-guides/metabox/meta-block-1-intro.md +++ b/docs/how-to-guides/metabox/meta-block-1-intro.md @@ -4,9 +4,9 @@ Typically, blocks store their attribute values in the serialised block HTML. How In this short tutorial you will create one of these blocks, which will prompt a user for a single value, and save it as post meta. -For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/architecture/key-concepts.md) of the handbook. +For background around the thinking of blocks as the interface, please see the [key concepts section](/docs/explanations/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/how-to-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 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 6dec512aea7ab4..034de8a6c913a3 100644 --- a/docs/how-to-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/how-to-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). diff --git a/docs/manifest.json b/docs/manifest.json index 267fbef45b0177..f93908967b9bef 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -5,17 +5,11 @@ "markdown_source": "../docs/README.md", "parent": null }, - { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/getting-started/README.md", - "parent": "handbook" - }, { "title": "Tutorials", "slug": "tutorials", "markdown_source": "../docs/getting-started/tutorials/README.md", - "parent": "getting-started" + "parent": "handbook" }, { "title": "Development Environment", @@ -81,28 +75,28 @@ "title": "Glossary", "slug": "glossary", "markdown_source": "../docs/getting-started/glossary.md", - "parent": "getting-started" + "parent": "handbook" }, { "title": "Frequently Asked Questions", "slug": "faq", "markdown_source": "../docs/getting-started/faq.md", - "parent": "getting-started" + "parent": "handbook" }, { "title": "History", "slug": "history", "markdown_source": "../docs/getting-started/history.md", - "parent": "getting-started" + "parent": "handbook" }, { "title": "Outreach", "slug": "outreach", "markdown_source": "../docs/getting-started/outreach.md", - "parent": "getting-started" + "parent": "handbook" }, { - "title": "Developer Documentation", + "title": "How-to Guides", "slug": "how-to-guides", "markdown_source": "../docs/how-to-guides/README.md", "parent": null @@ -497,6 +491,12 @@ "markdown_source": "../docs/reference-guides/block-api/block-metadata.md", "parent": "block-api" }, + { + "title": "Block Variations", + "slug": "block-variations", + "markdown_source": "../docs/reference-guides/block-api/block-variations.md", + "parent": "block-api" + }, { "title": "Block Patterns", "slug": "block-patterns", @@ -1740,7 +1740,7 @@ "parent": "architecture" }, { - "title": "FullSiteEditingTemplates", + "title": "Full Site Editing Templates", "slug": "full-site-editing-templates", "markdown_source": "../docs/explanations/architecture/full-site-editing-templates.md", "parent": "architecture" @@ -1753,69 +1753,69 @@ }, { "title": "Code Contributions", - "slug": "develop", - "markdown_source": "../docs/contributors/code/develop.md", + "slug": "code", + "markdown_source": "../docs/contributors/code/code.md", "parent": "contributors" }, { - "title": "Getting Started", - "slug": "getting-started", - "markdown_source": "../docs/contributors/code/getting-started.md", - "parent": "develop" + "title": "Getting Started With Code Contribution", + "slug": "getting-started-with-code-contribution", + "markdown_source": "../docs/contributors/code/getting-started-with-code-contribution.md", + "parent": "code" }, { "title": "Git Workflow", "slug": "git-workflow", "markdown_source": "../docs/contributors/code/git-workflow.md", - "parent": "develop" + "parent": "code" }, { "title": "Coding Guidelines", "slug": "coding-guidelines", "markdown_source": "../docs/contributors/code/coding-guidelines.md", - "parent": "develop" + "parent": "code" }, { "title": "Testing Overview", "slug": "testing-overview", "markdown_source": "../docs/contributors/code/testing-overview.md", - "parent": "develop" + "parent": "code" }, { "title": "Block Grammar", "slug": "grammar", "markdown_source": "../docs/contributors/code/grammar.md", - "parent": "develop" + "parent": "code" }, { "title": "Scripts", "slug": "scripts", "markdown_source": "../docs/contributors/code/scripts.md", - "parent": "develop" + "parent": "code" }, { "title": "Managing Packages", "slug": "managing-packages", "markdown_source": "../docs/contributors/code/managing-packages.md", - "parent": "develop" + "parent": "code" }, { "title": "Gutenberg Release Process", "slug": "release", "markdown_source": "../docs/contributors/code/release.md", - "parent": "develop" + "parent": "code" }, { "title": "React Native based mobile Gutenberg", "slug": "native-mobile", "markdown_source": "../docs/contributors/code/native-mobile.md", - "parent": "develop" + "parent": "code" }, { "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" + "parent": "code" }, { "title": "Design Contributions", @@ -1837,15 +1837,15 @@ }, { "title": "Documentation Contributions", - "slug": "document", - "markdown_source": "../docs/contributors/documentation/document.md", + "slug": "documentation", + "markdown_source": "../docs/contributors/documentation/documentation.md", "parent": "contributors" }, { "title": "Copy Guidelines", "slug": "copy-guide", "markdown_source": "../docs/contributors/documentation/copy-guide.md", - "parent": "document" + "parent": "documentation" }, { "title": "Triage", diff --git a/docs/reference-guides/block-api/block-registration.md b/docs/reference-guides/block-api/block-registration.md index 31cadb9c74de7b..5ac9d2a3e78bb3 100644 --- a/docs/reference-guides/block-api/block-registration.md +++ b/docs/reference-guides/block-api/block-registration.md @@ -224,7 +224,7 @@ example: { - **Type:** `Object[]` -Similarly to how the block's style variations can be declared, a block type can define block variations that the user can pick from. The difference is that, rather than changing only the visual appearance, this field provides a way to apply initial custom attributes and inner blocks at the time when a block is inserted. See the [Block Variations API](/docs/designers-developers/developers/block-api/block-variations.md) for more details. +Similarly to how the block's style variations can be declared, a block type can define block variations that the user can pick from. The difference is that, rather than changing only the visual appearance, this field provides a way to apply initial custom attributes and inner blocks at the time when a block is inserted. See the [Block Variations API](/docs/reference-guides/block-api/block-variations.md) for more details. diff --git a/docs/reference-guides/slotfills/README.md b/docs/reference-guides/slotfills/README.md index da88e6cb7661e2..130b058c5db657 100644 --- a/docs/reference-guides/slotfills/README.md +++ b/docs/reference-guides/slotfills/README.md @@ -1,9 +1,9 @@ # SlotFills Reference Slot and Fill are components that have been exposed to allow developers to inject items into some predefined places in the Gutenberg admin experience. -Please see the [SlotFill component docs](https://wordpress.org/gutenberg/handbook/designers-developers/developers/components/slot-fill/) for more details. +Please see the [SlotFill component docs](https://wordpress.org/gutenberg/handbook/reference-guides/components/slot-fill/) for more details. -In order to use them, we must leverage the [@wordpress/plugins](https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-plugins/) api to register a plugin that will inject our items. +In order to use them, we must leverage the [@wordpress/plugins](https://wordpress.org/gutenberg/handbook/reference-guides/packages/packages-plugins/) api to register a plugin that will inject our items. ## Usage overview diff --git a/docs/toc.json b/docs/toc.json index c1d037c5605000..9d064bd84402f3 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -1,26 +1,24 @@ [ { "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/tutorials/create-block/submitting-to-block-directory.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/glossary.md": [] }, - { "docs/getting-started/faq.md": [] }, - { "docs/getting-started/history.md": [] }, - { "docs/getting-started/outreach.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/tutorials/create-block/submitting-to-block-directory.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": [] }, @@ -99,6 +97,7 @@ { "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-variations.md": [] }, { "docs/reference-guides/block-api/block-patterns.md": [] }, { "docs/reference-guides/block-api/block-annotations.md": [] }, { "docs/reference-guides/block-api/versions.md": [] } @@ -146,8 +145,8 @@ ] } ] }, { "docs/contributors/README.md": [ - { "docs/contributors/code/develop.md": [ - { "docs/contributors/code/getting-started.md": [] }, + { "docs/contributors/code/code.md": [ + { "docs/contributors/code/getting-started-with-code-contribution.md": [] }, { "docs/contributors/code/git-workflow.md": [] }, { "docs/contributors/code/coding-guidelines.md": [] }, { "docs/contributors/code/testing-overview.md": [] }, @@ -162,7 +161,7 @@ { "docs/contributors/design/the-block.md": [] }, { "docs/contributors/design/reference.md": [] } ] }, - { "docs/contributors/documentation/document.md": [ + { "docs/contributors/documentation/documentation.md": [ { "docs/contributors/documentation/copy-guide.md": [] } ] }, { "docs/contributors/triage.md": [] }, diff --git a/packages/block-editor/src/components/inner-blocks/README.md b/packages/block-editor/src/components/inner-blocks/README.md index 1466c8a59a095e..8cae0693f60fb3 100644 --- a/packages/block-editor/src/components/inner-blocks/README.md +++ b/packages/block-editor/src/components/inner-blocks/README.md @@ -85,7 +85,7 @@ While this prop doesn't change any styles for the inner blocks themselves, it do * **Type:** `Array>` The template is defined as a list of block items. Such blocks can have predefined attributes, placeholder, content, etc. Block templates allow specifying a default initial state for an InnerBlocks area. -More information about templates can be found in [template docs](/docs/designers-developers/developers/block-api/block-templates.md). +More information about templates can be found in [template docs](/docs/reference-guides/block-api/block-templates.md). ```jsx const TEMPLATE = [ [ 'core/columns', {}, [ @@ -114,7 +114,7 @@ If false the selection should not be updated when child blocks specified in the ### `templateLock` * **Type:** `String|Boolean` -Template locking of `InnerBlocks` is similar to [Custom Post Type templates locking](/docs/designers-developers/developers/block-api/block-templates.md#locking). +Template locking of `InnerBlocks` is similar to [Custom Post Type templates locking](/docs/reference-guides/block-api/block-templates.md#locking). Template locking allows locking the `InnerBlocks` area for the current template. *Options:* diff --git a/packages/block-editor/src/components/inspector-controls/README.md b/packages/block-editor/src/components/inspector-controls/README.md index ac1520de6975b4..3369cc8002c9f2 100644 --- a/packages/block-editor/src/components/inspector-controls/README.md +++ b/packages/block-editor/src/components/inspector-controls/README.md @@ -1,6 +1,6 @@ # InspectorControls -inspector +inspector Inspector Controls appear in the post settings sidebar when a block is being edited. The controls appear in both HTML and visual editing modes, and thus should contain settings that affect the entire block. diff --git a/packages/components/src/CONTRIBUTING.md b/packages/components/src/CONTRIBUTING.md index 3fa27beddfa31f..166def00030865 100644 --- a/packages/components/src/CONTRIBUTING.md +++ b/packages/components/src/CONTRIBUTING.md @@ -37,7 +37,7 @@ Once the team has discussed and approved the change, it's time to start implemen 1. **Provide a rationale**: Explain how your component will add value to the system and the greater product ecosystem. Be sure to include any user experience and interaction descriptions. 2. **Draft documentation**: New components need development, design, and accessibility guidelines. Additionally, if your change adds additional behavior or expands a component’s features, those changes will need to be fully documented as well. Read through existing component documentation for examples. Start with a rough draft, and reviewers will help polish documentation. -3. **Provide working code**: The component or enhancement must be built in React. See the [developer contribution guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/develop.md). +3. **Provide working code**: The component or enhancement must be built in React. See the [developer contribution guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/code/code.md). 4. **Create a design spec**: Create sizing and styling annotations for all aspects of the component. This spec should provide a developer with everything they need to create the design in code. [Figma automatically does this for you](https://help.figma.com/article/32-developer-handoff). 5. **Create a Figma component**: Any new components or changes to existing components will be mirrored in the [WordPress Components Figma library](https://www.figma.com/file/ZtN5xslEVYgzU7Dd5CxgGZwq/WordPress-Components?node-id=735%3A0), so we’ll need to update the Figma library and publish the changes. Please follow the [guidelines](https://www.figma.com/file/ZtN5xslEVYgzU7Dd5CxgGZwq/WordPress-Components?node-id=746%3A38) for contributing to the Figma libraries. diff --git a/packages/components/src/toolbar-button/README.md b/packages/components/src/toolbar-button/README.md index 1ddccac0c75fa0..6595b98c10d447 100644 --- a/packages/components/src/toolbar-button/README.md +++ b/packages/components/src/toolbar-button/README.md @@ -1,6 +1,6 @@ # ToolbarButton -ToolbarButton can be used to add actions to a toolbar, usually inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +ToolbarButton can be used to add actions to a toolbar, usually inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). It has similar features to the [Button](/packages/components/src/button/README.md) component. Using `ToolbarButton` will ensure the correct styling for a button in a toolbar, and also that keyboard interactions in a toolbar are consistent with the [WAI-ARIA toolbar pattern](https://www.w3.org/TR/wai-aria-practices/#toolbar). @@ -27,7 +27,7 @@ function MyToolbar() { ### Inside BlockControls -If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). +If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). ```jsx import { BlockControls } from '@wordpress/block-editor'; diff --git a/packages/components/src/toolbar-item/README.md b/packages/components/src/toolbar-item/README.md index 1df563778a0e11..16ce9ff7a414d8 100644 --- a/packages/components/src/toolbar-item/README.md +++ b/packages/components/src/toolbar-item/README.md @@ -1,6 +1,6 @@ # ToolbarItem -A ToolbarItem is a generic headless component that can be used to make any custom component a [Toolbar](/packages/components/src/toolbar/README.md) item. It should be inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md). +A ToolbarItem is a generic headless component that can be used to make any custom component a [Toolbar](/packages/components/src/toolbar/README.md) item. It should be inside a [Toolbar](/packages/components/src/toolbar/README.md) or [ToolbarGroup](/packages/components/src/toolbar-group/README.md) when used to create general interfaces. If you're using it to add controls to your custom block, you should consider using [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md). ## Usage @@ -49,7 +49,7 @@ function MyToolbar() { ### Inside BlockControls -If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/designers-developers/developers/tutorials/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). +If you're working on a custom block and you want to add controls to the block toolbar, you should use [BlockControls](/docs/how-to-guides/block-tutorial/block-controls-toolbar-and-sidebar.md) instead. Optionally wrapping it with [ToolbarGroup](/packages/components/src/toolbar-group/README.md). ```jsx import { BlockControls } from '@wordpress/block-editor'; diff --git a/packages/create-block-tutorial-template/README.md b/packages/create-block-tutorial-template/README.md index dc9ff76c11fd7c..cb689139aeebd2 100644 --- a/packages/create-block-tutorial-template/README.md +++ b/packages/create-block-tutorial-template/README.md @@ -1,6 +1,6 @@ # Create Block Tutorial Template -This is a template for [`@wordpress/create-block`](/packages/create-block/README.md) that is the finished version of the block in the official [WordPress Tutorial](/docs/designers-developers/developers/tutorials/create-block/readme.md) for the block editor. +This is a template for [`@wordpress/create-block`](/packages/create-block/README.md) that is the finished version of the block in the official [WordPress Tutorial](/docs/getting-started/tutorials/create-block/README.md) for the block editor. ## Usage diff --git a/packages/create-block-tutorial-template/package.json b/packages/create-block-tutorial-template/package.json index 4b0fd09ff18206..09d45b5526cfd3 100644 --- a/packages/create-block-tutorial-template/package.json +++ b/packages/create-block-tutorial-template/package.json @@ -9,7 +9,7 @@ "create block", "block template" ], - "homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/docs/designers-developers/developers/tutorials/create-block", + "homepage": "https://github.com/WordPress/gutenberg/tree/HEAD/docs/getting-started/tutorials/create-block", "repository": { "type": "git", "url": "https://github.com/WordPress/gutenberg.git", diff --git a/packages/notices/README.md b/packages/notices/README.md index 497f10042e2555..dd44b0fb8e5050 100644 --- a/packages/notices/README.md +++ b/packages/notices/README.md @@ -20,6 +20,6 @@ When imported, the notices module registers a data store on the `core/notices` n For more information about consuming from a data store, refer to [the `@wordpress/data` documentation on _Data Access and Manipulation_](/packages/data/README.md#data-access-and-manipulation). -For a full list of actions and selectors available in the `core/notices` namespace, refer to the [_Notices Data_ Handbook page](/docs/designers-developers/developers/data/data-core-notices.md). +For a full list of actions and selectors available in the `core/notices` namespace, refer to the [_Notices Data_ Handbook page](/docs/reference-guides/data/data-core-notices.md).

Code is Poetry.

diff --git a/packages/scripts/README.md b/packages/scripts/README.md index f846cce6384171..4eddc4f55bffc1 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -44,7 +44,7 @@ _Example:_ } ``` -It might also be a good idea to get familiar with the [JavaScript Build Setup tutorial](/docs/designers-developers/developers/tutorials/javascript/js-build-setup.md) for setting up a development environment to use ESNext syntax. It gives a very in-depth explanation of how to use the [build](#build) and [start](#start) scripts. +It might also be a good idea to get familiar with the [JavaScript Build Setup tutorial](/docs/how-to-guides/javascript/js-build-setup.md) for setting up a development environment to use ESNext syntax. It gives a very in-depth explanation of how to use the [build](#build) and [start](#start) scripts. ## Updating to New Release