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

Should we add a version number to documentation pages? #170

Open
bparks13 opened this issue Dec 20, 2024 · 0 comments
Open

Should we add a version number to documentation pages? #170

bparks13 opened this issue Dec 20, 2024 · 0 comments
Labels
discussion Proposed modification or content

Comments

@bparks13
Copy link
Member

Would it be helpful to place a version tag on some of the documentation pages to note which version the documentation is guaranteed to be correct for? For instance, any of the pages under User Guide -> Hardware Guides that are generated via manual markdown pages (e.g., Neuropixels GUI documentation) might benefit from having an explicit tag. That way, if we forget to update any of the images or content after a new release, it will be more clear to users to know that specific information might be outdated but the overall content should be correct as of a specific version number.

This could also be automatically tagged in the API documentation based on the current version number, that way we have a consistent theme on each page for what information is being presented.

@bparks13 bparks13 added the discussion Proposed modification or content label Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Proposed modification or content
Projects
None yet
Development

No branches or pull requests

1 participant