chore(Documentation): Update documentation to use the ADI Harmonic theme

[glen-anderson]

Description

Closes #1149 and moves the needle a bit on #1148

Update the documentation to better follow ADI guidelines:

• Update the doc theme to use the harmonic-mkdocs-theme theme
• Break the monolithic USERGUIDE.md into smaller top-level markdown files
• Remove the generated doxygen files from the repo since they're generated at build time
• Remove doxygen build steps from .github/workflows/build-docs.yml since they're taken care of in Documentation/build.py
• Refactor Documentation/build.py to be a bit easier to maintain
• Add markdownlint config to catch inconsistencies. I recommend the VS Code plugin
• Fix and normalized all the markdown to follow lint rules

Happy to take feedback on this and update/modify as necessary.

Testing

Best to start from a clean workspace but it should work regardless.

git clean -dfx
python -m venv venv
source venv/bin/activate # or venv\Scripts\activate on Windows
pip install -r Documentation/requirements.txt
python Documentation/build.py
mkdocs serve

Checklist Before Requesting Review

• PR Title follows correct guidelines.
• Description of changes and all other relevant information.
• (Optional) Link any related GitHub issues using a keyword
• (Optional) Provide info on any relevant functional testing/validation. For API changes or significant features, this is not optional.

[sihyung-maxim]

Looks good - definitely nice to see the user guide partitioned out which makes it easier to navigate.

Double-check me on the "???+ ..." formatting though.

[sihyung-maxim]

Might be the way GitHub displays markdown files in the PR reviews, but it looks off. Good idea to double check me:

And in VS code preview:

[glen-anderson]

Thanks @sihyung-maxim, this syntax is specific to the theme we're using and renders like this:

[sihyung-maxim]

Your thoughts on removing these files, @lorne-maxim?

It helps with navigation and provides some other information if users prefer going through this route, but the files are outdated. If we keep these, then they need to be updated as well - though I'm not sure what resources are available for this.

[glen-anderson]

Ping @lorne-maxim

[sihyung-maxim]

typical **development** cycle typically sounds redundant.

[sihyung-maxim]

MSDK works on Windows 11 as well now.

[sihyung-maxim]

The This software is proprietary to Analog Devices, Inc. and its licensors. line can be deleted. This line should have also been removed from most other files within the MSDK due to the permissive licensing of the MSDK.

[github-actions]

This pull request is stale because it has been open for 30 days with no activity. Remove stale label, commit, or comment or this will be closed in 7 days.