Docs: Use consistent content formatting for experimental packages#73212
Merged
Conversation
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Member
Author
|
Pinging for reviews based on |
Mamaduka
approved these changes
Nov 12, 2025
Member
Mamaduka
left a comment
Mamaduka
left a comment
There was a problem hiding this comment.
although as a separate observation it would be nice if we could use GitHub Flavored Markdown alerts syntax.
Thant would be fantastic! Thanks, @aduth!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Updates package READMEs which specified experimental status in their headings to instead include this as part of the README's content.
Why?
@wordpress/uireference on the Developer Resources site currently has no indication that it's experimentalHow?
Shift experimental label from title to content.
Uses
<div class="callout callout-warning">to format as alert. This is consistent with other packages, although as a separate observation it would be nice if we could use GitHub Flavored Markdown alerts syntax. I traced this behavior back to the Jetpack plugin Markdown parser, which is what's used on WordPress.org sites. I opened an issue for this enhancement at Automattic/jetpack#45907 .Testing Instructions
Review README content for accuracy.