Update README.md disclaimer wording and formatting#703
Merged
colorful-tones merged 2 commits intoWordPress:trunkfrom Aug 28, 2024
Merged
Update README.md disclaimer wording and formatting#703colorful-tones merged 2 commits intoWordPress:trunkfrom
colorful-tones merged 2 commits intoWordPress:trunkfrom
Conversation
colorful-tones
added
the
documentation
mikachan
reviewed
Aug 16, 2024
Member
mikachan
left a comment
mikachan
left a comment
There was a problem hiding this comment.
These changes look good to me, thank you! I like the use of [!IMPORTANT].
Should we make a similar update to the readme.txt file as well? As that's the text used on the wp.org plugin directory page.
colorful-tones
force-pushed
the
update/readme-disclaimer
branch
from
8c833b0 to
30d556b
Compare
Member
Author
I added the updated disclaimer in the plugin's |
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
3 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.
I've wrapped the Disclaimer in the
READMEwith markdown[!IMPORTANT]to highlight the callout for new visitors and updated the description to try to streamline understanding of potential damage.We could consider utilizing
[!NOTE],[!TIP],[!WARNING], or[!CAUTION]instead. See previews of each here: https://github.com/orgs/community/discussions/16925Here is the link to the rich diff for previewing these changes (although the purple coloring of the
[!IMPORTANT]is not rendered in the preview): https://github.com/WordPress/create-block-theme/pull/703/files?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5