Skip to content

doc: enable first-heading-level remark-lint rule

Rodrigo Muino Tomonari requested to merge github/fork/ChALkeR/first-heading-level into master
Checklist
  • make -j4 test (UNIX), or vcbuild test nosign (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, tools

Description of change

This makes sure that the first heading in all markdown files is h1.

Only three files needed to be changed to conform:

  1. BUILDING.md
  2. CODE_OF_CONDUCT.md
  3. doc/onboarding-extras.md

Also, .remarkrc is updated to include the first-heading-level: 1 rule in order to catch similar issues in the future.

This change could be controversial, as it changes the actual look of the Code of Conduct document, so I made a stand-alone PR for it to be reviewed separately. I'm not sure if the new header levels are the best choice, and I'm open for any suggestions here.

/cc @nodejs/documentation, @nodejs/inclusivity, @trott, @addaleax.

Merge request reports