docs: fix several headings

brigadecore / brigade

Event-driven scripting for Kubernetes

Apache License 2.0

2.41k stars 246 forks source link

The main fix in this PR is that a superfluous h1 heading is removed from the top of most doc pages. Documents should have only one top-level heading and Hugo automatically uses the title found in the front matter to generate an h1 heading, so in most cases, we had duplicate or near duplicate text. The stylesheet is clever about changing the stying of a second h1, but it's still superfluous and afaik breaks the rules of semantic HTML.

There are other various heading-related fixes here, too, and I'll drop some comments in-line to explain wherever warranted.

brigadecore / brigade

docs: fix several headings #1842