search

open-ephys / bonsai-onix1

Bonsai library for the Open Ephys Onix Acquisition System
https://open-ephys.github.io/onix1-bonsai-docs
MIT License
4 stars 3 forks source link

Improve documentation for MutliDeviceFactories #276

Closed jonnew closed 4 weeks ago

jonnew commented 1 month ago
cjsha commented 4 weeks ago

In each of the hubs, in the top-level remarks, you added these nice bulleted list of devices and their corresponding features. It might help to refer to your bulleted list as a list of devices in the device group because the summary for MultiDeviceFamily's Process method (which is going to be the next thing in the page after I change the template according to previous conversations), it says "Configure all devices in the device group". This implicitly defines what a device group is.

cjsha commented 4 weeks ago

I like what you're calling the headstages, they're following a format: Headstage-Abc (i.e. Headstage-NeuropixelsV2e). I think there's practicality in this uniformity. Though I'm not sure we need hyphens when it comes to human-readable content that goes in docs and store. And I think Headstage-NeuropixelsV2e-Beta should be Headstage-NeuropixelsV2eBeta instead