Skip to content

/ gutenberg

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

Jump to bottom

Update Quick Start GIF for Create Block Docs #27602

Open
zzap opened this issue Dec 9, 2020 · 2 comments
Open

Update Quick Start GIF for Create Block Docs #27602

zzap opened this issue Dec 9, 2020 · 2 comments
Labels
[Package] Create Block [Type] Documentation [Type] Enhancement

Comments

@zzap
Copy link
Member

@zzap zzap commented Dec 9, 2020 •
edited

This is not really a bug but there's no type for updating the docs (maybe create one :) ).

In .gif animation for create block package readme file we still have this command for creating a block:

npm init @wordpress/block todo-list

However, code snippet below is up to date and show different command:

npx @wordpress/create-block todo-list

Also, animation clearly shows this command should be executed in plugins folder:

cd wp-content/plugins

This is not mentioned anywhere in text and I think it should be.
@gziolo
Copy link
Member

@gziolo gziolo commented Dec 10, 2020 •
edited

To be clear, both commands work exactly the same. npm init @wordpress/block is shorter but for some reasons we use npx @wordpress/create-block now in the documentation. This demo is hosted on nake.wordpress.org so it could be updated there if it isn't used in some old post. Otherwise we should still upload it to make.wordpress.org and update the reference in the README file.

Next week we are publishing packages to npm so we could record new demo just after it happens to have the latest version.
@zzap
Copy link
Member Author

@zzap zzap commented Dec 10, 2020 •
edited

Next week we are publishing packages to npm so we could record new demo just after it happens to have the latest version.

Awesome. Thank you.

By the way, I love that we recommend npx over npm even though the end result is the same.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
[Package] Create Block [Type] Documentation [Type] Enhancement
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@gziolo @zzap @annezazu
You can’t perform that action at this time.