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

Docs versioning #422

Open
artberger opened this issue Feb 27, 2025 · 1 comment
Open

Docs versioning #422

artberger opened this issue Feb 27, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@artberger
Copy link

Summary:

  • As a user, I want to quickly review the docs for the particular version that I have.
  • As a contributor, I want to be able to document the way that a feature works without overwriting the steps that were accurate for a past release.

Initial approach:

  • Try out the MkDocs Material theme's versioning capability
  • Figure out how to integrate versioned docs into the doc build process

More resources:

@danehans
Copy link
Contributor

danehans commented Feb 27, 2025

@artberger I have assigned this issue to you. It would be great if this issue can be resolved in time for the v0.2.0 release. Track the milestones for upcoming details on the release date. cc: @ahg-g in case this issue should be added to #362.

@danehans danehans added the documentation Improvements or additions to documentation label Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants