Skip to main content
On this page

Gitorial Authoring - Validation

Validation

How validation works

These rules are evaluated when creating the PR-ready structure and surfaced inline during authoring to keep steps consistent.

Section

Section must change README

SectionMustChangeReadme
ERROR

A Section step must modify README content.

Section changes README only

SectionMustChangeReadmeOnly
ERROR

A Section step must only modify README.

Template & Solution

Template must be followed by Solution

TemplateMustBeFollowedBySolution
ERROR

Any Template step must be immediately followed by a Solution step.

Solution must follow Template or Action

SolutionMustFollowTemplateOrAction
ERROR

A Solution step must immediately follow a Template or an Action step.

README

Exactly one README step

ReadmeMustBeOne
ERROR

The tutorial must contain exactly one README step.

README must be last

ReadmeMustBeLast
ERROR

The README step must be the final step in the tutorial.