Skip to content
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

Add more documentation for @wordpress/env #19194

Merged
merged 6 commits into from Dec 20, 2019
Merged

Add more documentation for @wordpress/env #19194

merged 6 commits into from Dec 20, 2019

Conversation

@noisysocks
Copy link
Member

noisysocks commented Dec 17, 2019

Quick attempt at fleshing out some of our documentation for the @wordpress/env tool. These are the docs that are shown here:

https://developer.wordpress.org/block-editor/packages/packages-env/

When #18986 is merged, we can also update docs/contributors/getting-started.md to instruct users to use wp-env instead of npm run env.

cc. @epiqueras @mapk

packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
packages/env/README.md Outdated Show resolved Hide resolved
@gziolo

This comment has been minimized.

Copy link
Member

gziolo commented Dec 17, 2019

When #18986 is merged, we can also update docs/contributors/getting-started.md to instruct users to use wp-env instead of npm run env.

What’s wrong with having npm run env command in scripts section which acts like a documentation for node users?

noisysocks and others added 5 commits Dec 19, 2019
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-Authored-By: Enrique Piqueras <epiqueras@users.noreply.github.com>
Copy link
Contributor

ZebulanStanphill left a comment

One minor comment, but everything else looks way more clear and helpful than what's currently in master. 👍

packages/env/README.md Show resolved Hide resolved
@noisysocks noisysocks merged commit cf8413c into master Dec 20, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@noisysocks noisysocks deleted the add/wp-env-docs branch Dec 20, 2019
@youknowriad youknowriad added this to the Gutenberg 7.2 milestone Jan 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.