acquire-project / acquire-docs

https://acquire-project.github.io/acquire-docs/
0 stars 3 forks source link

Versioned Docs #67

Closed dgmccart closed 4 months ago

dgmccart commented 11 months ago

We'd like to introduce versioned docs since new releases may introduce breaking changes. Read the docs may be an option for hosting versioned docs for free using a tag on the docs to assign the version. @melissawm will explore if mkdocs is compatible with read the docs.

melissawm commented 11 months ago

Material for MkDocs suggests using mike. This is a reasonable approach and should work with our current website deployment workflow (in github pages) but it might involve one extra step in the release process for Acquire.

melissawm commented 10 months ago

Ok, here's a proof of concept using mike as described above: https://melissawm.github.io/acquire-docs

The 0.3.0 and dev versions are exactly the same, this is mostly to show how the dropdown would look and the basic functionality (keeping the same page across versions etc) For example, if you go to https://melissawm.github.io/acquire-docs/dev/tutorials/trigger/ and change the version to 0.3.0, this will redirect to https://melissawm.github.io/acquire-docs/0.3.0/tutorials/trigger/

Please let me know if this looks reasonable, and maybe we need design to decide on the switcher? I went with a minimalistic look to match the rest of the theme. Note that the link above is my own personal fork; when we have decided on the look and feel I can submit a PR to this repo.

dgmccart commented 8 months ago

I synced with Janeece about this, and using a dropdown with the browser-default styling is appropriate in this case, so we can move forward with implementing, @melissawm