chore(docs): restructuring of API documentation

[butler54]

Types of changes

• Hot fix (emergency fix and release)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Documentation (change which affects the documentation site)
• Breaking change (fix or feature that would cause existing functionality to change)
• Release (develop -> main)

Quality assurance (all should be covered).

• My code follows the code style of this project.
• Documentation for my change is up to date?
• My PR meets testing requirements.
• All new and existing tests passed.
• All commits are signed-off.

Summary

• Users no longer need to update mkdocs to add a page.
• All pages have been moved to be in the same relative path for SEO
• Social previews will now be generated
• Descriptions for SEO
• Flavicons

More work needs to be done.

Key links:

• Sonar coverage

Before you merge

• Ensure it is a 'squash commit' if not a release.
• Ensure CI is currently passing
• Check sonar. If you are working for a fork a maintainer will reach out, if required.

[butler54]

@jpower432 / @degenaro a first pass review here would be helpful. All the descriptions (Where BANANAS has been put to have a key to replace) need to be updated.

Highlights:

1. Tree structure automatically creates the website
2. No need to update mkdocs.yaml to add a file. In 90% of locations this will happen automatically.

[jpower432]

LGTM

Deployed locally and reviewed the changes. I don't see any issues with the changes made.

[degenaro]

@butler54 I see you've already delivered. I pulled develop branch and doc serves works for me. Hopefully Reference -> API will be improved with future code restructuring.