Versioned docs do not redirect all links correctly

[ml-evs]

In a few places we have linked to e.g. https://optimade.org/optimade-python-tools/CHANGELOG, which currentl 404s.

I would like this to be redirected to https://optimade.org/optimade-python-tools/latest/CHANGELOG, in the same way that the base URL is.

Tagging @CasperWA but can also take a look at this myself when I get time.

[ml-evs]

NB: this affects all absolute links in the README - we could try to change these to relative links but then they would fail in the actual GitHub rendering of the README

[CasperWA]

NB: this affects all absolute links in the README - we could try to change these to relative links but then they would fail in the actual GitHub rendering of the README

"This can be solved in post" ...

Meaning, I've set up in other repo's another pre-commit hook that copies over the README.md file to docs/index.md, updating various things under the way, meaning the README.md file becomes the truth/source, but the repo will be slightly larger (instead of having a symlink, it'll be an almost identical copy in the docs folder).

It's a solution - it's not extremely elegant, but it works. And then the hook only runs if the README.md file is changed :)

[CasperWA]

Relevant links:

pre-commit hook: https://github.com/Materials-Consortia/optimade-gateway/blob/main/.pre-commit-config.yaml#L55-L62
actual invoke task doing the job: https://github.com/Materials-Consortia/optimade-gateway/blob/main/tasks.py#L181-L199

And then it needs to be run (the invoke task) in the docs release workflows whenever the create-api-reference task is also run, essentially. And the docs/index.md file should be added to some bash if-sentences.

[ml-evs]

This seems to be resolved, or at least I can't spot any broken links anymore (maybe this was fixed within mike/mkdocs?)