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

[Feature]: Ensure Documentation Aligns with Releases #759

Closed
garrettmflynn opened this issue Apr 19, 2024 · 0 comments · Fixed by #763
Closed

[Feature]: Ensure Documentation Aligns with Releases #759

garrettmflynn opened this issue Apr 19, 2024 · 0 comments · Fixed by #763
Assignees
Labels
enhancement New feature or request

Comments

@garrettmflynn
Copy link
Member

What would you like to see added to the NWB GUIDE?

Some users have complained about inconsistencies between the current Read the Docs publication (from main) and the latest release on Github (triggered manually, usually from main).

A few options are available to fix this:

  1. Always align documentation with the latest release (e.g. create a latest branch that triggers a release of both the app and the documentation and/or a separate docs branch that allows for minor revisions)
  2. Allow for swapping between different version of the documentation (see Pydantic)

It sounds like we've agreed on Option 2 and have a separate issue that provides a changelog-focused justification for this decision.

Do you have any interest in helping implement the feature?

Yes.

Code of Conduct

Yes

Did you confirm this feature was not already reported?

Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants