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

List Block Docs Page Review #1076

Open
7 of 8 tasks
katmoody opened this issue Aug 24, 2023 · 4 comments
Open
7 of 8 tasks

List Block Docs Page Review #1076

katmoody opened this issue Aug 24, 2023 · 4 comments
Assignees
Labels

Comments

@katmoody
Copy link

katmoody commented Aug 24, 2023

Issue Description

I'd recommend adding an additional heading at the top of the page (after the first paragraph) called 'How to add the List block' and revising this section for additional context/clarity.

URL of the Page with the Issue

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

Section of Page with the issue

After the first paragraph.

Why is this a problem?

Each of the 'Blocks' pages under Documentation / Customization / (block) should include clear information on what the block is and how to add it to the page, along with other customization details.

It's also important to have a clear hierarchy in headlines for those who scan pages to find the specific information they need. "How to add this block" would be a good additional headline.
Each of the 'Blocks' pages under Documentation / Customization / (block) should include clear information on what the block is and how to add it to the page, along with other customization details.

Page Review Items to Check

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

  • Page should include info on 'How to add the block'
  • Page should include info on all toolbar controls
  • Page should include info on all block settings
  • Page should include a Changelog
  • Block names in bolded, not italicized
  • Headings should use Headings (H2, H3), not be bolded
  • Each relevant section should have a Heading
  • Use monospaced style for slash commands

Suggested Fix

Revise current text (below):

In order to add a List Block, click on the add block button and select the List Block.

You can also type /list and hit enter in a new paragraph block to add one quickly.

Consider adding this text instead:

Open the Block Inserter tool by clicking the Block Inserter + icon in the top toolbar or in the block editor. Look for the List block by using the search bar, then click the icon to insert it into the editor.

You can also click the Block Inserter (+) icon in the editor and then choose the List block in the pop-up window.

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

@katmoody katmoody added the [Status] To do Issue marked as Todo label Aug 24, 2023
@github-actions
Copy link

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

@katmoody
Copy link
Author

/assign

@github-actions
Copy link

Hey @katmoody, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

@katmoody
Copy link
Author

katmoody commented Aug 24, 2023

It's also worth a quick clarification as to what should be bolded. We want to bold the name of the block, but is "block" part of the name of the block?

Should it be List Block or List block?

@estelaris or @zzap ?

*I'm asking because this page uses the first option while other pages have used the second option. It should be the same for each page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant