WordPress / Documentation-Issue-Tracker

Issue Tracker for the WordPress Documentation team.
https://make.wordpress.org/docs/
Other
76 stars 38 forks source link

Details block page review #1088

Open katmoody opened 10 months ago

katmoody commented 10 months ago

Issue Description

This is part of the Block pages review, and we're checking for the following items:

URL of the Page with the Issue

https://wordpress.org/documentation/article/details-block/

Section of Page with the issue

Add a title to the "how to add the block" section, so it is easier for those who scan the content to find. We also want to add a little more context to the section on how to add the block to the page.

Why is this a problem?

This will make the page easier to scan and read.

Suggested Fix

Add a title to the section on how to add the block to the page, which follows the two screenshots showing the closed and open states of the Details block.

How to add a Details block

Update the content:

To add a Details block, open the Block Inserter tool by clicking the Block Inserter + icon in the top toolbar. Look for the Details block by using the search bar to find the right block to add. Then, click the icon to insert it into the editor.

Alternatively, click the Block Inserter (+) icon in the editor, then choose the Details block in the pop-up window.

You can also use a (/) slash command by typing /details in the editor.

github-actions[bot] commented 10 months ago

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

katmoody commented 10 months ago

It's worth considering whether the "Closed state" and "Open state" headings should actually be headings or just bolded. I didn't include that in my notes, but It might be worth using the heading style instead of just bolded text.

I also didn't note this but it's worth considering - the 'how to add this block' section is further down the content on this page than it is on most other block pages. Should that section be moved up on this page to follow the same structure throughout?