Versioned Documentation

[crowcpp]

Versioned Documentation

[The-EDev]

Here's a compromise I thought of: Instead of having different versions of the documentation, an alternative would be to tag any features with which version they were introduced in. I've seen it done in multiple places (wireshark is one example).

[The-EDev]

There is already a tool to do this with mkdocs called mike. The way it works is that you use mike instead of mkdocs to generate documentation, you just need to specify a version and if it already exists, it will be overwritten. This means that the whole thing with deleting everything in gh-pages branch would no longer be necessary.

CI can handle building docs for latest or master while individual versions can be made manually (although it would be best if they were incorporated into CI)

[The-EDev]

I'm very sorry to anyone who is running an older version of Crow and wants accurate documentation. I've been putting this task off for very long, partially because I hate myself every time I have to deal with mkdocs and doxygen..

v0.3 is very very long overdue, so I would like to be able to make that release without going through this issue. I'm also hoping to release patches whenever needed (for example the file serving issue with v0.2 that's been fixed in master for months).

If anyone wants to take on the challenge (and call me a quitting loser in the process), I will gladly share any info or advice or even some work you may need to get this issue closed.