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

Add docs site version switcher #79

Merged
merged 15 commits into from
Jan 3, 2025

Conversation

dskarbrevik
Copy link
Contributor

Changes

  • adds a version switcher to the langfair docsite
  • added instructions to the contributing.md file to guide the process of updating the docs site after a new release

Screenshots

image

Notes

  • this PR does not add past versions of langfair doc (v0.1 and v0.2)
  • version switch entries will be added for minor or major revisions going forward

@dylanbouchard dylanbouchard self-requested a review December 23, 2024 20:36
Copy link
Collaborator

@dylanbouchard dylanbouchard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks David. It looks like there is 'aetna' in the url for the contributing guide and in the dropdown in my local preview, I'm not seeing v0.3.0. Would you mind confirming that the built site displays the current version and updating the url? thanks!

image

@dskarbrevik
Copy link
Contributor Author

Updated the contributing.md (I'll make a separate PR to update it on develop branch).

For the version switcher it needs to reference a static file that tells it which version is where, but because this PR isn't merged that file doesn't exist at the indicated path: https://cvs-health.github.io/langfair/versions.json. From my testing the code will work as is but we can't know for sure until the code is committed and deployed.

@dylanbouchard
Copy link
Collaborator

dylanbouchard commented Jan 2, 2025

Updated the contributing.md (I'll make a separate PR to update it on develop branch).

For the version switcher it needs to reference a static file that tells it which version is where, but because this PR isn't merged that file doesn't exist at the indicated path: https://cvs-health.github.io/langfair/versions.json. From my testing the code will work as is but we can't know for sure until the code is committed and deployed.

Ah ok, got it. I think some conflicts need to be resolved since I ran the build for v0.3.1. I will approve and merge after they are resolved. Thanks David!

@dskarbrevik
Copy link
Contributor Author

Done :)

@dylanbouchard dylanbouchard self-requested a review January 3, 2025 15:15
@dylanbouchard dylanbouchard merged commit 2a34dee into cvs-health:gh-pages Jan 3, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants