Versioned GitHub repository links from our docs

emilk commented 6 months ago

We link to files on GitHub quite often in our docs.

For instance, we link to https://github.com/rerun-io/rerun/blob/main/examples/python/log_file/main.py The problem is that that file is gone. We should have linked to https://github.com/rerun-io/rerun/blob/0.15.0/examples/python/log_file/main.py instead

So how do we solve this?

Unclear

If we use /blob/main/ the file may change or disappear
If we use /blob/latest/ the file may also change or disappear, and the CI may be green just before a release, but the link in the release is wrong
If we hard-code tags in our links (/blob/0.15.0/) our docs will link to old code

Immediate problems for 0.16 release

(Fixed in https://github.com/rerun-io/rerun/pull/6331)

examples/cpp/external_data_loader/README.md
3:python: https://github.com/rerun-io/rerun/tree/latest/examples/python/external_data_loader/main.py

examples/rust/external_data_loader/README.md
3:python: https://github.com/rerun-io/rerun/tree/latest/examples/python/external_data_loader/main.py

examples/python/external_data_loader/README.md
3:python: https://github.com/rerun-io/rerun/tree/latest/examples/python/external_data_loader/main.py

docs/content/reference/sdk-operating-modes.md
93:Check out our [dedicated example](https://github.com/rerun-io/rerun/tree/latest/examples/python/stdio/main.py).

docs/content/getting-started/data-in/python.md
16:At any time, you can checkout the complete code listing for this tutorial [here](https://github.com/rerun-io/rerun/tree/latest/examples/python/dna/main.py) to better keep track of the overall picture.

rerun-io / rerun

Versioned GitHub repository links from our docs #6077

So how do we solve this?

Immediate problems for 0.16 release

Related