Add optional readability score

Created on 10 July 2025, 3 months ago

Problem/Motivation

SiteImprove has an API to get the readability of a page - https://api.siteimprove.com/v2/documentation#/Content/get_content_checks.... Let’s add that to Editoria11y_SI so it can be displayed on the page.

Steps to reproduce

n/a

Proposed resolution

Add score to the page

There are multiple readability scores out there, but https://readable.com/readability/flesch-reading-ease-flesch-kincaid-grad... is the default for SiteImprove so that seems good to start from. We would aim for a score of 8 (per recommendation online), but would allow for sites to tweak this grade level as needed.

If the page's score is greater than the score that is desired, the error will show on the page.

Keep this optional

Some people may not want this functionality. There will be an option in the admin form to enable/disable this check.

Remaining tasks

* Code
* Review
* Merge

User interface changes

n/a

API changes

n/a

Data model changes

n/a

✨ Feature request
Status

Active

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States nmillin

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Production build 0.71.5 2024