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

Code block page review #1085

Open
5 of 8 tasks
katmoody opened this issue Aug 24, 2023 · 1 comment
Open
5 of 8 tasks

Code block page review #1085

katmoody opened this issue Aug 24, 2023 · 1 comment
Labels
[Status] To do Issue marked as Todo

Comments

@katmoody
Copy link

katmoody commented Aug 24, 2023

Issue Description

This is part of the Block pages review, and we're checking for the following items (unchecked items still need to be done):

  • 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

URL of the Page with the Issue

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

Section of Page with the issue

  • The style of the block name - Code - needs to be updated from italic to bold throughout the page.
  • A title should be added before the section that details how to add the code block to the page (after the code example in the beginning of the article).
  • when referencing a slash (/) command, the command needs to be monospaced

Why is this a problem?

The styles (the block name being bolded and the slash command being monospaced) need to be updated for better assessability. The title should be added so the page is easier to skim for relevant information.

Suggested Fix

Update the slash command style to be monospaced. Update the block name style throughout the page.
Add a title before the 'how to add this block' section (after the code example):

How to add the Code block

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] To do Issue marked as Todo
Projects
None yet
Development

No branches or pull requests

1 participant