XS✔ ◾ improving heading sizes

[sethdaily]

1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

✏️ i want to see if it looks better

2. What was changed?

✏️

3. Did you do pair or mob programming (list names)?

✏️

[github-actions]

PR Metrics

✔ Thanks for keeping your pull request small.
✔ Thanks for adding tests.

	Lines
Product Code	-
Test Code	-
Subtotal	-
Ignored Code	42
Total	42

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

[github-actions]

Hi @sethdaily,

We found some markdown suggestions for your Pull Request:

File	Error	Rule
rules/rest-api-design/rule.md	Line 32 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: top-level headings in the same document	Rule MD025
rules/rest-api-design/rule.md	Line 36 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: levels should only increment by one level at a time	Rule MD001
rules/rest-api-design/rule.md	Line 127 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: top-level headings in the same document	Rule MD025
rules/rest-api-design/rule.md	Line 131 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: levels should only increment by one level at a time	Rule MD001

Please review and update your Markdown files accordingly.

[jeoffreyfischer]

❌ Not Done - as Tiago told me in the past, we should only have a single h1 per page to improve SEO.
For rules, the h1 is used for the title.
So the largest heading size you can use for rule sections is an h2

[tiagov8]

Hey @sethdaily

As per @jeoffreyfischer
We should not use H1 in content: https://www.ssw.com.au/rules/rules-to-better-technical-documentation/#1-headings-paragraphs-and-blockquotes

We should also aim to follow the hierarchy... so an h4 only comes after/under a h3, etc

I've made several small changes to your PR... to reflect the above + for consistency and readability

I will leave it for someone else to approve because of my own changes.

[github-actions]

Howzit @sethdaily,

This PR has been here a while.

Did you know you should avoid merge debt?

1. Please action (e.g. get a review) and merge or close

Thanks!

[jeoffreyfischer]

LGTM