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

Platform docs: Add a page to explain how to render HTML from a list of blocks #55140

Merged
merged 2 commits into from Oct 9, 2023

Conversation

youknowriad
Copy link
Contributor

Related #53874

What?

This PR add a small documentation page explaining how to possibly render a block list edited using the Gutenberg Block Editor.

It is very basic at the moment, and also it's not complete since we're missing the work in #54047

Test the documentation website

cd platform-docs
npm install
npm start

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Oct 6, 2023
@youknowriad youknowriad self-assigned this Oct 6, 2023
@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Flaky tests detected in 602bf35.
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: https://github.com/WordPress/gutenberg/actions/runs/6453722676
📝 Reported issues:

Copy link
Contributor

@andrewserong andrewserong left a comment

Choose a reason for hiding this comment

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

Looks like a good place to begin to me! Thanks for flagging in the docs that including all styles is a "to do" item for now.

If needed, we could always list each of the block supports that aren't yet supported, but I imagine we probably don't need to go into that level of detail just yet?

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.

LGTM

Left a tiny nit in addition to Ramon's.

platform-docs/docs/basic-concepts/rendering.md Outdated Show resolved Hide resolved
Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>
Co-authored-by: Ramon <ramonjd@users.noreply.github.com>
@youknowriad
Copy link
Contributor Author

If needed, we could always list each of the block supports that aren't yet supported, but I imagine we probably don't need to go into that level of detail just yet?

Putting myself on a third-party dev mode, I feel it's not really necessary but I think it'd be helpful to note in #54047 which should clarify the remaining work.

@youknowriad youknowriad enabled auto-merge (squash) October 9, 2023 07:45
@youknowriad youknowriad merged commit cd0035d into trunk Oct 9, 2023
49 checks passed
@youknowriad youknowriad deleted the docs/add-rendering-page branch October 9, 2023 08:24
@github-actions github-actions bot added this to the Gutenberg 16.9 milestone Oct 9, 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.

None yet

4 participants