open-ephys / commutator-docs

Documentation for Open Ephys Commutators
https://open-ephys.github.io/commutator-docs/
Creative Commons Attribution Share Alike 4.0 International
3 stars 1 forks source link

Add acquisition system to section titles and intros within "Automating Commutation" #2

Closed ChucklesOnGitHub closed 1 year ago

ChucklesOnGitHub commented 1 year ago

image

It would be useful at this menu level to know for what acq system each guide is, besides the source of orientation data and acquisition software. e.g. "Automate Commutation with Bonsai and UCLA Miniscope v4" could be ONIX or Miniscope DAQ

Since the ONIX docs already have the commutator section, maybe the decision here is to either a) Link from commutator docs to onix docs -> then add this link to current commutator docs b) Link from onix docs to commutator docs -> move sections from onix docs to commutator docs and add link to onix docs

jonnew commented 1 year ago

I want to move the commutator docs from ONIX into this docs website. I plan to just turn that page into a links into the commutator docs.

cjsha commented 1 year ago

It sounds like Jon is going with option b presented by Ceci then

I agree, the user's acquisition hardware is arguably more important than the software. Is something like "Automate Commutation with Onix and UCLA Miniscope v4" more adequate then? And then I can break it down by software (Bonsai or Miniscope-DAQ-QT-GUI) on the page with that label?

jonnew commented 1 year ago

Whatever the solution is, I think the top of each page should have picture of the relevant hardware. e.g. a daq and miniscope, a breakout and miniscope, breakout and hs-64, etc.

ChucklesOnGitHub commented 1 year ago

yes Cris, I think it might easier to find things that way 1: I have this acq hardware (when the SPI commutator comes, there will be additional ones) 2: I have this headstage 3: I want to use this software

cjsha commented 1 year ago

You're right. What do you think of each guide having the format: "Automate Commutation with [orientation source hardware] and [acquisition hardware]"? Most guides will just have instructions for Bonsai, but the ones involving the miniscope will also have instructions for Miniscope GUI. This software info isn't explicit in the title which shortens the titles and sort of reduces redundancy.

If we reorganize as suggested above, I think it would also solve issue #3

ChucklesOnGitHub commented 1 year ago

yep, that's what I meant, i think it would work

cjsha commented 1 year ago

I addressed this issue in the recent commit/push. Please check it out and let me know what you think

ChucklesOnGitHub commented 1 year ago

This is super clear, awesome!

ChucklesOnGitHub commented 1 year ago

A note: I think when we get to the stage of populating the section "ONIX and Computer Vision", it will actually be applicable to computer vision with commutators in general, and not tied to a particular acquisition system. I sugges figuring it out when that time comes.

cjsha commented 1 year ago

I think for this particular case when the entire page is identical for spi commutator and and coax commutator, I think we make one file that the coax commutator doc and the spi commutator doc each pulls from using the ..include:: directive. Then edits to this one file will be reflected in both commutator docs