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 heading level curation documentation #66076

Merged
merged 2 commits into from
Oct 11, 2024

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Oct 11, 2024

Fixes #65706

What?

This PR updates the Curating the Editor docs with reference to the heading level curation method that is now available in Gutenberg and will soon be included in WordPress 6.7.

Why?

While this will be detailed in a dev note, having this information in the Curating the Editor documentation makes it more discoverable.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Oct 11, 2024
@ndiego ndiego self-assigned this Oct 11, 2024
Copy link

github-actions bot commented Oct 11, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ndiego <ndiego@git.wordpress.org>
Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@ndiego ndiego enabled auto-merge (squash) October 11, 2024 19:36
@@ -6,6 +6,37 @@ This page is dedicated to the many ways you can disable specific functionality i

There might be times when you don’t want access to a block at all to be available for users. To control what’s available in the inserter, you can take two approaches: [an allow list](/docs/reference-guides/filters/block-filters.md#using-an-allow-list) that disables all blocks except those on the list or a [deny list that unregisters specific blocks](/docs/reference-guides/filters/block-filters.md#using-a-deny-list).

## Curate heading levels
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if it's the right place for this documentation. It might be but I feel there's a lot of similar APIs that we need to surface in a consistent way (together). "allowedBlocks" attribute, "templateLock" attribute, "placeholder" attribute. (Attributes that "control" the behavior of blocks but not their output)

Copy link
Member Author

Choose a reason for hiding this comment

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

It might be but I feel there's a lot of similar APIs that we need to surface in a consistent way (together).

💯 these attributes are not documented well. I'll add this to my to-do list.

@ndiego ndiego merged commit b6c9a42 into trunk Oct 11, 2024
74 checks passed
@ndiego ndiego deleted the docs/add-heading-level-curation-documentation branch October 11, 2024 19:57
@github-actions github-actions bot added this to the Gutenberg 19.5 milestone Oct 11, 2024
ciampo pushed a commit that referenced this pull request Oct 14, 2024
* Add heading level curation documentation.

Co-authored-by: ndiego <ndiego@git.wordpress.org>
Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
karthick-murugan pushed a commit to karthick-murugan/gutenberg that referenced this pull request Nov 13, 2024
* Add heading level curation documentation.

Co-authored-by: ndiego <ndiego@git.wordpress.org>
Co-authored-by: ryanwelcher <welcher@git.wordpress.org>
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.

Add information about heading level curation to the Curating the Editor docs
3 participants