WordPress / wporg-documentation-2022

15 stars 6 forks source link

Establish consistency with notices and callouts #89

Open ndiego opened 8 months ago

ndiego commented 8 months ago

Notices and callouts throughout the content of the Documentation section are inconsistent, and I have not found any that use the built-in Notice block.

Example 1 Example 2
image image
Example 3 Example 4
image image

The Notice block provides four different options (tip, notice, alert, warning) and uses the approved colors and iconography. We should update all notices and callouts to use the Notice block and update any Docs procedures to remind contributors to use the Notice block.

Here is a quick edit demonstrating the update. During this process, we should also try to ensure the Notice block is used sparingly. There are pages that have 10+ notices/callouts that may or may not be needed.

Before After
image image
estelaris commented 8 months ago

@ndiego is this something can be changed with code or do we need to change them manually?

ndiego commented 8 months ago

It would be a manual process. But I don't think it would take more than an hour or so. I am happy to do it. More importantly, we just need to make sure the Notice block is used for all future notices/callouts.