-
-
Notifications
You must be signed in to change notification settings - Fork 382
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Versioned Documentation #78
Comments
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 CI can handle building docs for |
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. |
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). |
Basically have a folder for every crow version + a latest folder, update only the latest folder, then a release rename latest to version name.
The text was updated successfully, but these errors were encountered: