[Docs: Getting Started / Block Development Environment] Updates on the text to improve clarity and preciseness #54563
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juanmaguitar
requested review from
ajitbohra,
ryanwelcher,
fabiankaegy and
ndiego
as code owners
juanmaguitar
added
the
[Type] Developer Documentation
ndiego
approved these changes
Sep 18, 2023
| @@ -32,7 +32,7 @@ The list goes on. While modern JavaScript development can be challenging, WordPr | |||
|
|
|||
| **The recommended Node.js version for block development is [Active LTS](https://nodejs.dev/en/about/releases/) (Long Term Support)**. However, there are times when you need to to use different versions. A Node.js version manager tool like `nvm` is strongly recommended and allows you to easily change your `node` version when required. You will also need Node Package Manager (`npm`) and the Node Package eXecute (`npx`) to work with some WordPress packages. Both are installed automatically with Node.js. | |||
|
|
|||
| To install Node.js development tools and learn more about each, refer to the links below. | |||
| To be able to use the [Node.js tools and packages provided by WordPress](https://github.com/WordPress/gutenberg/tree/trunk/packages) for block development you'll need to set a proper Node.js runtime environment in your machine. To learn more about how to do this, refer to the links below. | |||
There was a problem hiding this comment.
To be able to use the Node.js tools and packages provided by WordPress for block development, you'll need to set a proper Node.js runtime environment on your machine.
| @@ -13,7 +13,7 @@ The Node Package eXecute ([`npx`](https://docs.npmjs.com/cli/v10/commands/npx)) | |||
|
|
|||
| It's recommended that you use [Node Version Manager](https://github.com/nvm-sh/nvm) (`nvm`) to install Node.js. This allows you to install and manage specific versions of `node`, which are installed locally in your home directory, avoiding any global permission issues. | |||
|
|
|||
| Here are the quick instructions for installing `node` using `nvm`. See the [complete installation guide](https://github.com/nvm-sh/nvm#installing-and-updating) for more details. | |||
| Here are the quick instructions for installing `node` using `nvm` and set the recommended Node version for block development. See the [complete installation guide](https://github.com/nvm-sh/nvm#installing-and-updating) for more details. | |||
There was a problem hiding this comment.
Here are the quick instructions for installing
nodeusingnvmand setting the recommended Node.js version for block development.
|
I have added more changes to this PR that include:
@ndiego let me know your thoughts |
juanmaguitar
deleted the
docs/minor-adjustments-develop-environment-section
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Minor changes to some texts of the "Getting Started / Block Development Environment" section to improve clarity and preciseness
Why?
To avoid confusion and have a more coherent narrative that helps developers understand and process this information faster.