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 versioning to the docs website #73

Open
brettfiedler opened this issue Nov 21, 2024 · 0 comments
Open

add versioning to the docs website #73

brettfiedler opened this issue Nov 21, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@brettfiedler
Copy link
Contributor

It'd be good, as we build in versioning for the scenerystack npm package, to make sure the documentation aligns in version. Material for Mkdocs supports versioning with mike. https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

This was, if we move from, e.g., scenerystack 1.0 to 1.1 and need to change the documentation, then anyone still on 1.0 could have the relevant documentation.

Need to implement when we're ready to call the npm package complete.

Will add the dependencies to the requirements.txt and update the mkdocs.yml. Including an override that will alert viewers when they are not on the latest version.

@brettfiedler brettfiedler self-assigned this Nov 21, 2024
@brettfiedler brettfiedler added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 21, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant