Skip to content

Commit

Permalink
change: readme and changelog (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
troychaplin authored Jul 21, 2024
1 parent 9b2cbe0 commit 02a453b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Prefix the change with one of these keywords:

## [Unreleased]

## Added
### Added

- Script helpers for block invalidations, checks and getting blocks in editor
- Higher order component to wrap invalid blocks
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,14 @@ This repo uses [@wordpress/env](https://github.com/WordPress/gutenberg/tree/HEAD

TODO: add git issue templates

---
# Block Checks and Modifications

## Block Checks
The following is a list of checks that are happening on core blocks.

The following is a list of checks that are happening on core blocks:

### Heading

- `Prevent using an H1 in the content area` - Best practices show that there should only be one unique H1 used per page, which is typically used for the page title
| Block | Description |
| ----- | ----------- |
| core/button | Checks for text and link on each individual button |
| core/heading | Prevents the usage of an level one heading in the content |
| core/image | Checks for alternative text on an image |
| core/image | Adds a toggle to confirm image use as decorative allowing for bypass a11y check |
| core/table | Checks for a table header row on each individual table block |

0 comments on commit 02a453b

Please sign in to comment.