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

Documentation: Add a first block type page to the platform docs #56109

Merged
merged 3 commits into from
Nov 15, 2023

Conversation

youknowriad
Copy link
Contributor

Related #53874

What?

This just bootstrap the "create block type" tutorial for the "Gutenberg as a framework" docs. It starts by using the same example from the WordPress specific docs without all the WordPress specific jargon and APIs.

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Nov 14, 2023
@youknowriad youknowriad self-assigned this Nov 14, 2023
@youknowriad youknowriad requested review from priethor, a team and mikachan and removed request for a team November 14, 2023 09:49
Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff. Just left some minor suggestions.

Thank you!

platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking pretty good to me. I also left a couple of other minor suggestions.

Thanks!

registerBlockType( 'create-block/gutenpride', {
// This is just a flag that tells the block editor that this block
// is using the API version 3 (the latest block type API).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: How will the "latest block type API" comment age in these docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming that we will always encourage folks to use the latest apiVersion, so I expect a lookup for apiVersion within our markdown files every time we add a new version.

platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
platform-docs/docs/create-block/first-block-type.md Outdated Show resolved Hide resolved
Co-authored-by: Ramon <ramonjd@users.noreply.github.com>
Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
@youknowriad youknowriad enabled auto-merge (squash) November 15, 2023 07:13
@youknowriad youknowriad merged commit b7f2740 into trunk Nov 15, 2023
@youknowriad youknowriad deleted the add/create-block-type-platform-docs branch November 15, 2023 10:49
@github-actions github-actions bot added this to the Gutenberg 17.1 milestone Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants