chore: add api docs in mkdocs build

[dreamorosi]

Summary

Changes

Please provide a summary of what's being changed

This PR adds a new mkdocs-typedoc plugin to our docs so that when running mkdocs serve (local dev) or mkdocs build (CI) it builds the API reference using TypeDoc in addition to the main docs.

This will simplify the CI setup (I updated the workflow) but most importantly it also improves the authoring experience which now requires a single command to run everything.

As part of the PR, I also moved the API reference link in the main header, so it's more prominent.

Finally, I have tweaked the mkdocs.yml configuration so that whenever we update any (and mkdocs serve is running), it'll trigger an automatic reload - this was not the case for snippets and API reference before.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #3714

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud