Allow documentation versioning

[capjamesg]

trafficstars

[github-actions[bot]]

Hello there, thank you for opening an Issue ! 🙏🏻 The team was notified and they will get back to you asap.

[capjamesg]

I really like this idea! You can use mike to retain multiple versions of documentation. I'm setting it up for another project right now. Note that mike replaces mkdocs commands, so there would be slight changes in how we deploy the docs.

Happy to implement this if we want it!

[SkalskiP]

Hi, @capjamesg 👋🏻! As I understand it, mike is built on top of mkdocs. So our docs would visually look the same?

[capjamesg]

@SkalskiP Yep! They would look the same. mike would add a dropdown for versions.

[SkalskiP]

@capjamesg Awesome! Can you work on a PR for the supervision-0.14.0 release?

[capjamesg]

Yep! I'll do this in addition to the CONTRIBUTING.md updates before the next release!

[SkalskiP]

Awesome! In that case, I'll add it to our plan for supervision-0.14.0

[hardikdava]

Can we also add how to modify documentation in case of modifying existing feature and adding a new feature?

[capjamesg]

I'm working on this. I'm having a problem getting the version dropdown to show in the docs navigation bar. I'll keep working on it!

[SkalskiP]

@capjamesg Can't wait to see that! Any chance we could create docs for previous versions of supervision? We have git tags for all previous releases.

[onuralpszr]

Today we deploy multi version via mike and also deploy old versions as well.

@SkalskiP thank you for your administration help.