-
Notifications
You must be signed in to change notification settings - Fork 414
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
docs: add versioning #1974
docs: add versioning #1974
Conversation
ion-elgreco
commented
Dec 14, 2023
•
edited
Loading
edited
- Adds versioning to the docs
I think this will break the url though. |
@ion-elgreco - what kind of versioning? Like different docs pages for v0.14 and v0.15? |
@MrPowers yes, different docs pages for each version, see example below: |
@ion-elgreco - let's chat about this one on a call. Lots of factors to consider for this one in particular. This is an issue I have thought about extensively. Lots of pros/cons to the different approaches. |
@MrPowers sure, maybe next week? |
@ion-elgreco I'm not sure if this versioning is going to work as expected because the versioning is used to build the docs but it is not aware of the deployment location so effectively will always show the same content, that dropdown will be used only as a label. Ahh, ok, so this will be deploying into some sub-folder? This will likely be a problem for tabbed Rust/Python code snippets as they rely on a fixed URL in the docs config (pointing to API location) so you may end up with a newer version pointing to current/main docs API references (although I don't think we are using those snippets extensively atm) |
@r3stl355 I checked, the tabbed code snippets still works. If you change the code snippet it doesn't affect the previous doc versions. |
Yes @ion-elgreco the snippets will work but the links about those code snippets will be pointing to the main docs only, this is driven by a single config value in the |
@r3stl355 Ah I see what you mean now, yeah those should be dynamic.. |