tectonic icon indicating copy to clipboard operation
tectonic copied to clipboard

Add versioning to your documentation

Open HealthyPear opened this issue 11 months ago • 2 comments

It seems to me that the documentation (read: "the book") always points to the latest development version.

This can lead to issues like #1243 where a user reads something in the documentation, tries to use it and fails because the version installed was the latest release.

I would suggest to,

  1. deploy the documentation on a public service that allows for versioning (like e.g. ReadTheDocs
  2. add a automatic changelog to your documentation

HealthyPear avatar Jan 20 '25 10:01 HealthyPear

Another issue opened due to this: #1225

CraftSpider avatar Feb 12 '25 19:02 CraftSpider

I was about to open an issue myself due to this. Until versioning is introduced, perhaps a banner should be introduced on the docs indicating that they reflect the current development status, not necessarily the latest release.

archanyhm avatar Oct 14 '25 20:10 archanyhm