Validation - arduino/help-center-content GitHub Wiki

An validation job will run checks against a number of rules. A passing output will look like this:

🕵️ Validating 396 articles...
✅ No issues found.

If there is one or more failed check, information will be printed in the output.

Rules

Front matter

  • No line may have trailing spaces
  • Title must be surrounded by quotes
  • Max title length limit of 140 characters.

Headings

  • The opening (first) heading needs to be level 2
  • No heading may have more than 60 characters

Images

  • All references images must exist
  • No image has an absolute path