Add api docs diff to the PR

[ST-DDT]

Clear and concise description of the problem

Currently it is hard to review where in the api-docs a change takes place.

Suggested solution

Add a CI step posting a list of changed modules/methods (in the api-docs).

MVP: A simple list

Ideas for extensions:

• Post a visual diff (collapsed by default)
• Make possible to preview docs of a PR on demand via netlify-preview #815

Alternative

Commit all generated docs to git.

Additional context

This idea came up again in #1752 (comment)
I remember discussing this somewhere before, but couldn't find an open issue related to it.

[ST-DDT]

Commit all generated docs to git.

These files are very long and ugly, so they are potentially hard to review:

Review Preview

Currently

Prettified

So IMO it is best to just list where to look (and maybe what to look for).

[ST-DDT]

I created a first script to create checksums and compare diffs:

https://next--serene-sprite-f3ef50.netlify.app/api-diff-index.json

Unfortunately, there is always a diff in:

{
  Date: [ 'between', 'betweens', 'future', 'past', 'recent', 'soon' ],
  Git: [ 'commitDate' ]
}

Due to the missing refDate in the docs generation.

Blocked by #859

[ST-DDT]

Why do I keep finding new issues? 😢