-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Docs: Overhaul the Development Environment section of the Block Editor Handbook #54395
Conversation
@ndiego I have created the following diagram and shared some videos to share my thoughts. https://excalidraw.com/#json=Y3QKUa0x85sIkUwYAutSA,oej4myPLor2dTxSTnIu_lg |
Thanks @juanmaguitar, I have addressed all feedback in the most recent commit! |
What about changing the name of the folder |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added a few comments but preemptively approved this PR so you're not blocked to move forward with it.
What?
The PR aims to update the Development Environment section of the Block Editor Handbook and provide a more streamlined developer onboarding experience using
wp-env
orwp-now
.Why?
The current section is not up to date and does not provide an optimal developer experience. It also does not cover
wp-now
.How?
To begin, the main Development Environment page is simplified. It now provides an overview of what you need to set up a dev environment for JavaScript development and provides brief explanations of "why" you need a code editor, Node.js dev tools, and a local WordPress environment.
The section covering Node.js dev tools is broken out into its own page, providing more details and installation information.
The section on creating a local WordPress environment has also been broken out into two additional guides, one for
wp-env
and another forwp-now
. Since these are the two tools currently maintained by WordPress itself, this is why they were chosen. This structure allows additional guides to be added in the future depending on community interest.Finally, the current How to setup local WordPress environment on Ubuntu doc has been removed, and that content is now part of the Troubleshooting section of the new "Guide to using wp-env".