Skip to content

Commit 6eac970

Browse files
shail-mehtashail-mehtaMamaduka
authored andcommitted
Fix broken links in docs (WordPress#83545)
* Fix handbook links in docs * Fix handbook links in docs Co-authored-by: shail-mehta <shailu25@git.wordpress.org> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
1 parent 52e9b55 commit 6eac970

11 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎docs/contributors/code/coding-guidelines.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This living document serves to prescribe coding guidelines specific to the Guten
66

77
### Naming
88

9-
To avoid class name collisions, class names **must** adhere to the following guidelines, which are loosely inspired by the [BEM (Block, Element, Modifier) methodology](https://en.bem.info/methodology/).
9+
To avoid class name collisions, class names **must** adhere to the following guidelines, which are loosely inspired by the [BEM (Block, Element, Modifier) methodology](https://bem.info/en/methodology/).
1010

1111
All class names assigned to an element must be prefixed with the name of the package, followed by a dash and the name of the directory in which the component resides. Any descendent of the component's root element must append a dash-delimited descriptor, separated from the base by two consecutive underscores `__`.
1212

@@ -812,7 +812,7 @@ For class components, there is no recommendation for documenting the props of th
812812
We use
813813
[`phpcs` (PHP_CodeSniffer)](https://github.com/PHPCSStandards/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.
814814

815-
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`.
815+
The easiest way to use PHPCS is [local environment](/docs/contributors/code/getting-started-with-code-contribution.md#local-wordpress-environment). Once that's installed, you can check your PHP by running `npm run lint:php`.
816816

817817
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`.
818818

‎docs/contributors/code/getting-started-with-code-contribution.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The following guide is for setting up your local environment to contribute to th
77
- Node.js
88
Gutenberg is a JavaScript project that requires [Node.js](https://nodejs.org/). The project is currently built using Node.js v24 and npm v11. Though best efforts are made to always use the Active LTS version of Node.js, this will not always be the case. For more details, please refer to the [Node.js release schedule](https://github.com/nodejs/Release#release-schedule).
99

10-
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/devenv/README.md#development-tools) or the Nodejs site for additional installation instructions.
10+
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/devenv/README.md#node-js-development-tools) or the Nodejs site for additional installation instructions.
1111

1212
- Git
1313
Gutenberg is using git for source control. Make sure you have an updated version of git installed on your computer, as well as a GitHub account. You can read the [Git Workflow](/docs/contributors/code/git-workflow.md) to learn more about using git and GitHub with Gutenberg

‎docs/contributors/code/testing-overview.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ End-to-end tests use [Playwright](https://playwright.dev/) as the testing framew
600600

601601
### Using wp-env
602602

603-
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:
603+
If you're using the built-in [local environment](/docs/contributors/code/getting-started-with-code-contribution.md#local-wordpress-environment), you can run the e2e tests locally using this command:
604604

605605
```bash
606606
npm run test:e2e
@@ -650,7 +650,7 @@ A test is considered to be **flaky** when it can pass and fail across multiple r
650650

651651
## PHP testing
652652

653-
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:
653+
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-wordpress-environment), you can run the PHP tests locally using this command:
654654

655655
```bash
656656
npm run test:php

‎docs/explanations/user-interface/block-design.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Check how your block looks, feels, and works on as many devices and screen sizes
144144

145145
### Support Gutenberg's dark background editor scheme
146146

147-
Check how your block looks with [dark backgrounds](/docs/how-to-guides/themes/theme-support.md#dark-backgrounds) in the editor.
147+
Check how your block looks with [dark backgrounds](/docs/how-to-guides/themes/theme-support.md#basic-colors) in the editor.
148148

149149
## Examples
150150

‎docs/getting-started/faq.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ This is currently a work in progress and we recommend reviewing the [block based
125125

126126
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.
127127

128-
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.
128+
Meanwhile, [block styles](/docs/reference-guides/block-api/block-styles.md) 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.
129129

130130
### How do editor styles work?
131131

‎docs/reference-guides/block-api/block-metadata.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ See [the variations documentation](/docs/reference-guides/block-api/block-variat
515515

516516
Block Hooks is an API that allows a block to automatically insert itself next to all instances of a given block type, in a relative position also specified by the "hooked" block. That is, a block can opt to be inserted before or after a given block type, or as its first or last child (i.e. to be prepended or appended to the list of its child blocks, respectively). Hooked blocks will appear both on the frontend and in the editor (to allow for customization by the user).
517517

518-
The key is the name of the block (`string`) to hook into, and the value is the position to hook into (`string`). Take a look at the [Block Hooks documentation](/docs/reference-guides/block-api/block-registration.md#block-hooks-optional) for more info about available configurations.
518+
The key is the name of the block (`string`) to hook into, and the value is the position to hook into (`string`). Take a look at the [Block Hooks documentation](/docs/reference-guides/block-api/block-registration.md#blockhooks-optional) for more info about available configurations.
519519

520520
### Editor script
521521

‎docs/reference-guides/block-api/block-registration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can use the functions documented on this page to register a block with JavaS
1212

1313
- **Type:** `Function`
1414

15-
Every block starts by registering a new block type definition. To register, you use the `registerBlockType` function from the [`wp-blocks` package](/packages/blocks/README.md#registerBlockType). The function takes two arguments, a block `name` and a block configuration object.
15+
Every block starts by registering a new block type definition. To register, you use the `registerBlockType` function from the [`wp-blocks` package](/packages/blocks/README.md#registerblocktype). The function takes two arguments, a block `name` and a block configuration object.
1616

1717
### Block Name
1818

‎docs/reference-guides/block-api/block-supports.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ supports: {
401401

402402
_**Note:** Deprecated since WordPress 6.3._
403403

404-
This property has been replaced by [`filter.duotone`](#filterduotone).
404+
This property has been replaced by [`filter.duotone`](#filter-duotone).
405405

406406
### color.gradients
407407

@@ -1042,7 +1042,7 @@ When the block declares support for `shadow`, the attributes definition is exten
10421042
- `padding`: type `boolean` or `array`, default value `false`
10431043
- `blockGap`: type `boolean` or `array`, default value `false`
10441044

1045-
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).
1045+
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#spacing-control).
10461046

10471047
```js
10481048
supports: {

‎docs/reference-guides/block-api/block-templates.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ registerBlockType( 'myplugin/template', {
5959
} );
6060
```
6161

62-
See the [Meta Block Tutorial](/docs/how-to-guides/metabox.md#step-4-finishing-touches) for a full example of a template in use.
62+
See the [Meta Block Tutorial](/docs/how-to-guides/metabox.md#step-4-use-block-templates-optional) for a full example of a template in use.
6363

6464
## Block attributes
6565

‎docs/reference-guides/block-api/block-transforms.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ To switch between variations of a block that is *already* of the target type, de
116116

117117
**Example: from Paragraph block to Heading block**
118118

119-
To declare this transformation we add the following code into the heading block configuration, which uses the `createBlock` function from the [`wp-blocks` package](/packages/blocks/README.md#createBlock).
119+
To declare this transformation we add the following code into the heading block configuration, which uses the `createBlock` function from the [`wp-blocks` package](/packages/blocks/README.md#createblock).
120120

121121
```js
122122
transforms: {
@@ -407,7 +407,7 @@ transforms: {
407407

408408
**Example: shortcode with wrapped content to block with InnerBlocks**
409409

410-
Shortcodes that wrap inner content (e.g. `[example]<p>Inner.</p>[/example]`) can be transformed into a block with InnerBlocks by passing `match.shortcode.content` through [`rawHandler`](/packages/blocks/README.md#rawHandler) inside `transform`.
410+
Shortcodes that wrap inner content (e.g. `[example]<p>Inner.</p>[/example]`) can be transformed into a block with InnerBlocks by passing `match.shortcode.content` through [`rawHandler`](/packages/blocks/README.md#rawhandler) inside `transform`.
411411

412412
```js
413413
transforms: {

0 commit comments

Comments
 (0)