Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require an introductory paragraph in docs pages #43222

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Commits on Oct 17, 2024

  1. Require an introductory paragraph in docs pages

    Add a vale rule that requires there to be a paragraph between the second
    frontmatter document separator (`---`) and the first H2-level heading of
    a docs page. Introductory paragraphs are common omissions in docs pages,
    but are important to help readers determine whether a guide is
    appropriate for their use case.
    ptgott committed Oct 17, 2024
    Configuration menu
    Copy the full SHA
    e0ba9e1 View commit details
    Browse the repository at this point in the history