-
Notifications
You must be signed in to change notification settings - Fork 13
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
Deprecate Bonsai.Onix Library #62
Conversation
- Add deprecation-notice.rst to every page in the Bonsai.ONIX directory - Modify TOC to put Bonsai.ONIX as last entry, mark it as deprecated, and replace with OpenEphys.Onix1 - Add page for OpenEphys.Onix1 with example workflow for easy navigation
- There are a few parts of the Hardware Guide that need to be updated for the OpenEphys.Onix1 0.1.0 release: - Add a note that the headstage voltages are set automatically by the new library (unless manually specified otherwise) - Add a deprecation note where the Bonsai installation process is described - Add a note that double-clicking the OniContext node applies to the deprecated Bonsai.Onix package
- Improved clarity of descriptions and ordering of presentation of software options
- Getting started, warnings, etc.
- A couple mentions of the new library, but largely agnostic
- Some small text edits too
I suggest the top level Bonsai section in the Software Guide is changed to Bonsai OpenEphys.Onix1 so that further referencing to that section makes more sense. It could also include a section to the new docs so the linkout is more immediate (in the menu). |
For some reason I can't comment directly on Ceci's post. I think it's not clear that OpenEphys.Onix1 is what people are looking for if they want to use Bonsai with ONIX. Under the presumption that people are looking for something related to Bonsai when navigating the software TOC, I understand why Jon would want to put an entry in the TOC that's just "Bonsai" or something like that. But we can still change the hyperlink so that it says:
instead of
|
to be clear: my suggestion was "Bonsai OpenEphys.Onix1" - refer to the language plus library, since it is not a standalone application like the GUI. And this would bring it closer hierarchically/visually-wise to the old "Bonsai.ONIX" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll push the commit to fix my comments on this PR.
@ChucklesOnGitHub With respect to renaming the software landing page from Bonsai -> OpenEphys.Onix1, I see your point but I think I disagree. The idea of the software page is a page for directing users to various software options for ONIX. There are a couple :ref: I think @cjsha is doing that now. |
Just to clarify, my suggestion is changing the software landing page from Bonsai -> Bonsai OpenEphys.Onix1 since this software option is not independent of the library. |
- Also: "library" -> "package" - Restructure the Bonsai page to create references to a OpenEphys.Onix1 section of the Bonsai page to address concerns about OpenEphys.Onix1 not being enough of a first-class citizen like Bonsai.Onix was
What I understand @ChucklesOnGitHub is that OpenEphys.Onix1 isn't enough of a first-class citizen like Bonsai.Onix was. I made the subheader as you mentioned which I think helps, and created some direct references to that header. I think this at least starts to alleviate some of your concerns. I've committed and pushed those changes I described (along with some typo fixes). This isn't a perfect solution, but I feel like it does the job. So, if there is urgency to getting these deprecation notices up, I can merge these changes to main so they deploy, as well as raise an issue if we want to continue discussing. |
Ceci said I could merge. I've raised an issue #64 to continue discussing these details if we want to. |
I name the "OpenEphys.Onix1" TOC entry "Onix Bonsai Library" because otherwise there is no indication that
OpenEphys.Onix1
is for Bonsai.I would even consider the Bonsa.ONIX entry in the TOC under its another dropdown named "Deprecated", "Deprecated Libraries" or something like that.
I figure the Neuropixels2 is a good workflow example to put on the onix1.rst page