Skip to content

IntroHeadings

FieldValue
TypeSkill Resource
Source~/.copilot/skills/technical-writing/references/vale-styles/TechnicalWriting/IntroHeadings.yml
DescriptionNot specified

Source Content

extends: existence
message: "Section-intro heading '%s' — the heading should name what follows, not announce that an introduction exists."
# warning, not error: scripts/markdown_lint.py already enforces this
# exact rule at WARNING severity — this rule stays consistent with that
# rather than giving Vale a stricter opinion than the rest of the system
# on a rule the other tool already owns.
level: warning
scope: heading
ignorecase: true
raw:
- '^(Introduction|Overview|Summary|Preface|Foreword|Background|About)\s*$'