Style Guide Checks

You can configure article checks against corporate rules. They will appear in each editor's app.

The style guide module supports two rule engines: LanguageTool and LLM.

  • LLM checks are configured via plain-text rule descriptions and executed by LLM.

  • LanguageTool checks grammar/spelling/style and uses XML rules.

Configure rules

  1. In space settings open Modules → Style guide.

  2. On first setup, default rules will be available to enable.

  3. Enable existing rules or create new ones.

LanguageTool rules

  1. Add a rule in the LanguageTool rules section.

  2. Create XML rule definition.

  3. Specify text types to which the rule applies.

  4. Add and run tests.

  5. Save changes.

LLM rules

  1. Add a rule in the LLM rules section.

  2. Enter rule name.

  3. Write LLM prompt in the "Description" field.

  4. Specify applicable text types.

  5. Add and run tests.

  6. Save changes.

Download rules from Gramax

  1. In space settings, open the Style guide tab and download the settings file.

  2. It will include all rules: enabled and disabled, along with their test results.

Import rules from Gramax Check

  1. Open Gramax Check and go to rule settings.

  2. Configure rules and download settings file.

  3. In space settings open Style guide tab and upload the file.

Settings example

Check an article

Open any article and choose Check against style guide in the article menu.