Learn how rulesets work and how to customize them using the rule editor.


Scroll Content Quality enables you to create custom rules for maintaining content quality standards across different use cases. For each activated space, a customizable set of rules is defined. This article will give you an overview of how these rulesets work and how you can customize them using the rule editor.

Rule Editor

Open the rule editor by selecting Scroll Content Quality in your space sidebar and clicking the Configure rule button (given you have activated the app in that space).

YAML syntax

The rule editor dialog is a text editor that uses the YAML syntax. After activating Scroll Content Quality in a space for the first time, this editor will display the preset rules. Delete, rewrite, or add new ones to create your own custom set of rules.

New to YAML?
We recommend reading this article before getting started, see YAML Tutorial: Everything You Need to Get Started in Minutes.

Rule Settings

For each rule, five settings should be configured:

1: Rule type

Specifies the core function of your rule. Each rule type has a unique name that cannot be changed. You can create multiple rules of the same rule type in a single rule set. At the moment, Scroll Content Quality supports these rule types:

Rule type

Description

external-link

Check links to external websites.

image-alt-text

Check that images have an alternative text description.

legacy-scroll-macros

Confirm that no legacy Scroll Macros are used.

macros

Control which macros can be used by either allow- or block-listing macros.

text-replacement

Check for specific words and recommend an alternative that should be used instead.

text-capitalization

Check for capitalization in various contexts (in headings, for example).

2: Description

Defines the overall intention of the rule in a few words.

The rule description is used as the title for each problem in your page report. Try to be as concise and clear as possible so your teammates are able understand the problem at first glance.

3: Level

This setting marks the level of severity and how quality issues of this rule should be handled. There are three levels that can be set for each rule:

🔴 Critical: Critical or technical quality issue. Fix is required.

🟠 Major: Quality issue will most likely alter the page's content quality. Fix is highly recommended.

🔵 Minor: Quality issue depends on the use case. Fix is optional.

4: Ignore label

Each rule type has its own unique ignore label. Use these labels to ignore rules on a page.

5: Config options

The configuration options depend on the rule type. Some types you can only turn on and off, while others can be scoped and configured for multiple use cases. Learn how to configure each rule type along with some examples and tips in the upcoming rule type articles.

Save Settings

Click on the Save button to apply the new set of rules to your space. Be aware that each page needs to be checked again after doing so.