Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Getting Started Docs: Update to use `wp-env` #20044
There's apparently a build step currently missing from the Getting Started docs.
How has this been tested?
If you just follow the current Getting Started instructions up until
None of the suggestions listed there actually work. Instead, you have to
(Adding that I'm seeing this on Linux, but it's probably not OS specific -- I don't think Noah is using Linux?)
Types of changes
Can you point me to up-to-date instructions on how to run Gutenberg locally?
Are you saying that that isn't the most obvious getting started doc?
npx wp-env start ✔ Started WordPress@master. (in 87s 449ms)
I'll keep this PR open, since I didn't see https://github.com/WordPress/gutenberg/blob/master/packages/env/README.md linked anywhere from the root level README, nor the trail I was describing. We can use it to properly update docs to point to the @wp/env README.
* Update main project README Update main project repository reamde with various updates that bring it current for now and down the line. First organized it into a more general getting started recognizing the three levels that people might be coming to the project: as a User, as a Devleoper, and as a Contributor For User - added links to the user documentation, support forums, and how to report an issue For Develoepr - added links to the developer documentation For Contributor - simplifed the contributor sections and links to the contributors guide I removed the links at the bottom since those are mostly dated from when the project was starting out and justifying itself. These links can be included elsewhere for background and context, and not necessary on the welcoming page. * Use capitalize Block Editor, rework sentence * Update plugin readme.txt * Restore Code is Potery * Titlecase title * Updated intro paragraphs * Update Gutenberg screenshot * Text edit - tone down the revolution * Apply suggestions from code review Thanks for the updates
👍Co-Authored-By: Chris Van Patten <firstname.lastname@example.org> * Add link for Getting Started guide, from #20044 Co-authored-by: Chris Van Patten <email@example.com>