-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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 "block-selectors" docs to TOC and manifest. #49471
Conversation
Flaky tests detected in 1dbd073. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4563528141
|
Good catch! This is a new feature that won’t be available in WordPress core until 6.3 (late August), what would be the best way to highlight it in https://github.com/WordPress/gutenberg/blob/trunk/docs/reference-guides/block-api/block-selectors.md? |
@@ -179,6 +179,9 @@ | |||
{ | |||
"docs/reference-guides/block-api/block-registration.md": [] | |||
}, | |||
{ | |||
"docs/reference-guides/block-api/block-selectors.md": [] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it sorted by name?
Thanks for fixing this up @gziolo 👍
In some of the components package readmes where there are experimental components, they use a callout alert at the top of the readme. Perhaps we could do something here in Something like adding the following beneath the title: <div class="callout callout-alert">
This API was stabilized in Gutenberg 15.5 and is planned for core release
in WordPress 6.3. To use this prior to WordPress 6.3, you will need to install
and activate Gutenberg >= 15.5.
</div>
<br /> |
It’s actually @Soean 😃
That would work until it’s released in WordPress core 👍 It would be also good in general to always include a paragraph next to the page title explaining when the feature becomes available in WordPress core. I didn’t think about it before. |
🤦 So it is. Clearly my caffeine levels had dipped too low ☕
I've taken the liberty to push a commit adding a callout that the selectors API won't be released in core until WordPress 6.3. I hope that's okay @Soean! Feel free to tweak the wording if desired. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent, that looks great now 🙌🏻
in WordPress 6.3. To use this prior to WordPress 6.3, you will need to | ||
install and activate Gutenberg >= 15.5. | ||
</div> | ||
<br /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see a line break added in other places, but we can verify once the handbook updates.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took the <br />
from the components package examples. IIRC, when testing it locally, without the line break the text moved up with no space between it and the callout. That could have been just previewing the markdown though 🤔
I opened #49792 with improvements for the block editor handbook. I also remove the |
What?
Fixes #49469
Adds block selectors docs to the TOC file and adds the generated manifest.
After merging, it should be available via: https://developer.wordpress.org/block-editor/reference-guides/block-api/block-selectors/