chore/ci/docs: detect outdated TS API reference

[mateuszlampert]

Description

This PR necessary scripts and CI workflows to handle autogenerated API-reference docs. Currently, any change to the Typescript API changes all references files because SHA in urls changes - as a result PRs are hard to review and some bugs/discrepancies in docs can be merged more easily.

This PR:

• adds CI workflow that checks if TS API-reference is up-to-date with TypeDocs from code
• configures TypeDoc so urls point to main branch instead of specific SHAs and so external references are excluded
• adds script for building versioned docs that build specific version of docs and replaces all main occurences in reference URLs to appropriate SHAs (we want to truncate the history there and point to specific point in history instead of main branch)
• rebuilds docs with new configuration

Introduces a breaking change?

• Yes
• No

Type of change

• Bug fix (change which fixes an issue)
• New feature (change which adds functionality)
• Documentation update (improves or adds clarity to existing documentation)
• Other (chores, tests, code style improvements etc.)

Tested on

N/A

Testing instructions

1. Script for building specific version of docs

Run:

cd docs
yarn docs:version 0.8.x 

and verify if main was changed to valid SHA in all reference urls (so urls for specific version are truncated to some point in history instead of latest main)

2. Github Action for detecting outdated api reference

Check results of actions for commits 7133ca4 and 2a4247c:

• the first commit introduces some changes to typescript api, but docs were not built on purpose - as a result Check if API reference is up-to-date workflow failed
• the first commit reverts this change, so generated api reference is up-to-date with typedocs - as a result Check if API reference is up-to-date workflow succeeded

3. Start docs locally and check if everything (exceptionally API-reference) works

Screenshots

Related issues

#790

Checklist

• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have updated the documentation accordingly
• My changes generate no new warnings

Additional notes

[msluszniak]

@mateuszlampert should CI for generated documentation fail?

[mateuszlampert]

@msluszniak oh, I forgot to change script name for prettier in the workflow code - now it's fixed and all tests passed :)

[msluszniak]

@chmjkb I saw that the only files that contain real changes are the ones related to image segmentation. Could you check if these are correct?

[chmjkb]

the image segmentation reference looks good 👍🏻