Skip to content
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

Use mkdocs mike for multi-version docs #1885

Open
1 task done
Tracked by #833
meatballhat opened this issue Apr 27, 2024 · 0 comments
Open
1 task done
Tracked by #833

Use mkdocs mike for multi-version docs #1885

meatballhat opened this issue Apr 27, 2024 · 0 comments
Labels
area/v3 relates to / is being considered for v3 kind/documentation describes a documentation update

Comments

@meatballhat
Copy link
Member

Checklist

  • Did you perform a search about this feature? Here's the GitHub guide about searching.

What problem does this solve?

This would remove the need for multiple major version documentation trees within each major maintenance branch.

Solution description

Rework the docs to use the mkdocs mike tool as described here.

Describe alternatives you've considered

Hosting documentation at readthedocs would include support for something similar. We could not switch to mike and continue the in-tree multiple dirs approach.

@meatballhat meatballhat added kind/documentation describes a documentation update area/v3 relates to / is being considered for v3 labels Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/v3 relates to / is being considered for v3 kind/documentation describes a documentation update
Projects
None yet
Development

No branches or pull requests

1 participant