MDS058: required-mentions

Heading-bounded sections must contain every configured substring.

The rule walks every heading in the document. For each heading the rule joins the plain text of paragraphs in the section’s line range. The range runs from the heading down to the next heading at the same or shallower level, including nested sub-sections.

Each entry in mentions: is checked against the joined text. Missing mentions emit one diagnostic at the section’s heading line. Under a schema scope override , the per-scope filter keeps only diagnostics inside the scope’s range.

# Settings

# Config

Document-wide:

rules:
  required-mentions:
    mentions: ["scope: production"]

Per-section (via schema scope):

kinds:
  runbook:
    schema:
      sections:
        - heading: "Rollback"
          rules:
            required-mentions:
              mentions: ["forward reference"]

Disable:

rules:
  required-mentions: false

# Examples

# Good

# Title

Deploy to production after the smoke test passes.

# Bad

# Title

Deploy to staging.

# Meta-Information

• ID: MDS058
• Name: required-mentions
• Status: ready
• Default: disabled
• Fixable: no
• Implementation: source
• Category: prose