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

Update README.md disclaimer wording and formatting #703

Merged

Conversation

colorful-tones
Copy link
Member

@colorful-tones colorful-tones commented Aug 15, 2024

I've wrapped the Disclaimer in the README with 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/16925

Here 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

@colorful-tones colorful-tones added the documentation Improvements or additions to documentation label Aug 15, 2024
@colorful-tones colorful-tones enabled auto-merge (squash) August 15, 2024 18:53
Copy link
Member

@mikachan mikachan left a comment

Choose a reason for hiding this comment

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

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 colorful-tones force-pushed the update/readme-disclaimer branch from 8c833b0 to 30d556b Compare August 26, 2024 20:39
@colorful-tones
Copy link
Member Author

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.

I added the updated disclaimer in the plugin's readme.txt as well.

Copy link
Contributor

@matiasbenedetto matiasbenedetto left a comment

Choose a reason for hiding this comment

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

LGTM

@colorful-tones colorful-tones merged commit 61a3d8d into WordPress:trunk Aug 28, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants