Update documentation for style consistency

[ADubhlaoich]

Proposed changes

This commit updates most of the documentation set to adhere to some contemporary documentation style standards:

• Sentence case for titles and headings
• Initial headings for how-to guides as "Overview" and "Before you begin"
• Moving any frontmatter descriptions to the body of text
• Removing unnecessary frontmatter data altogether
• Removing unnecessary custom style tag (Incorporated into the theme by default)

It also collapses a few single document directories (Adding an unnecessary "hop" for users) and re-orders some sections.

Closes #1609

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have checked that all unit tests pass after adding my changes
• I have updated necessary documentation
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

[ADubhlaoich]

pre-commit.ci autofix

[mjang]

Question: why do we add Overview at the start of each page? I don't see it (or "Introduction) at the start of most software documentation

[mjang]

Question: why do we add Overview at the start of each page? I don't see it (or "Introduction) at the start of most software documentation

Oh... I think I see it in the templates.

[ADubhlaoich]

pre-commit.ci autofix

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.76%. Comparing base (d76d8eb) to head (c061a53).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2256   +/-   ##
=======================================
  Coverage   87.76%   87.76%           
=======================================
  Files          96       96           
  Lines        6793     6793           
  Branches       50       50           
=======================================
  Hits         5962     5962           
  Misses        774      774           
  Partials       57       57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ADubhlaoich]

@sjberman Generating the API docs removes the empty line between the Overview and the following paragraph.

No idea how to fix it.

[sjberman]

@ADubhlaoich Oh that's strange...I guess if it doesn't fail the pipeline, then no big deal.