Page 1 of 1

Versioning of Documentation

Posted: Thu May 15, 2025 5:48 am
by hiran
As the project proceeds changes accumulate in the code, and partly they also get visible to users when handling the game.
Thus once in a while the documentation is updated.

In the past there was outdated PDF documentation shipped with the installers. This is fixed.
But you may still run into the question which of two documents is newer? Especially if you print it there is no but the hard way to spot differences.

Well - no longer. This is to let you know....
When Oolite is built on Github, the installers ship PDF documentation based on the latest .odt files in the repository, plus the Oolite version is stamped on the page footers. This way it takes only a brief glance at two documents to tell them apart or decide for the newer one.

Re: Versioning of Documentation

Posted: Fri May 16, 2025 5:22 am
by user2357
Excellent! Brilliant! Thanks, hiran. :D

Re: Versioning of Documentation

Posted: Fri May 16, 2025 8:24 am
by Cholmondely
So if I could work out how to download an old version from GitHub, then I'd get inaccurate "futuristic" documentation with it?

Re: Versioning of Documentation

Posted: Fri May 16, 2025 10:04 pm
by hiran
That's the beauty of version control:
If an old version would get built on Github it would get packaged with the matching old version of the documentation.

That's the consistency of version control:
If an old version would get built on Github it would get built using the old build procedure - which does not stamp version numbers on the page footers.

But under no circumstance expect old Oolite with new documentation.