Skip to content

Restrict mdlint to rules that are needed for ensuring no nav issues happen

Nizar requested to merge nizar/friendlier-mdlint into master

Description

Makes mdlint more non-developer friendly by restricting the warnings/errors to rules that ensure the navigation issue that was resolved in !226 (merged) doesn't happen again.

Supporting information

  • Jira Ticket: SE-4149

Testing instructions

  • Check the sandbox and verify everything is working as expected.
  • Check the pipeline and make sure the markdown quality check passes.
  • If you want to go the extra mile, do the following:
    • Test adding two header 1s to the same file - that shouldn't be possible.
    • Test adding a header 1 and a header 3 consecutively, without the header 2.
    • Run make quality-markdown and you should get two violations.

Merge request reports