Make all heading levels consistent

[jirijakes]

With this change, all documents have a single level-1 heading (document title), all other headings are at least level 2.

Additionally, linter is introduced to enforce the heading consistency.

Rationale

I wish to export documents to other formats (using pandoc). Unfortunately, levels of headings were used inconsistently across the documents, which made automated export quite complicated. This change makes all headings consistent with 00-introduction.md and 01-messaging.md.

Headings were shifted down by one level, a few did not require any change. Links to sections remain the same, therefore no references to the bolts and their sections should be broken.

[ProofOfKeags]

Concept ACK

Seems like you should also specify this requirement in the CONTRIBUTING.md

Also this is the type of thing you probably need a GitHub workflow to enforce, it's hard to review PR's at a glance and ensure they meet this requirement

[jirijakes]

Seems like you should also specify this requirement in the CONTRIBUTING.md Also this is the type of thing you probably need a GitHub workflow to enforce

Thanks, @ProofOfKeags , good ideas. I will look into it.

[jirijakes]

Changes:

• rebased
• added to style guide
• added linting workflow + simple script
  • uses https://github.com/DavidAnson/markdownlint-cli2
  • checks only what this PR is solving, other checks might be added gradually
  • tested on https://github.com/jirijakes/bolts/actions/runs/8026298250/job/21928515820

[jirijakes]

Rebased.

Linter run: https://github.com/jirijakes/bolts/actions/runs/9318710058/job/25651599958