open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package
https://open-ephys.github.io/bonsai-onix1-docs/
Creative Commons Attribution Share Alike 4.0 International
0 stars 2 forks source link

Operators TOC Structure #9

Closed cjsha closed 1 month ago

cjsha commented 2 months ago

Proposed TOC Structure

OpenEphys.Onix1
|
└─── Core Operators
│   │   createContext
│   │   startAcquisition
│   
└─── Configuration Operators
│   │   configureBreakoutBoard
│   │   configureHeadstageAbc
│   │   configureHeadstageXyz
│   │   ...
│
└─── Data I/O Operators
│   │   abcData
│   │   xyzData
│   │   ...
│
└─── Other
    |
    └─── Developer Operators (not recommended for Open Ephys hardware)
         |
         └─── Device Configuration Operators
            │   
            │   configureDeviceAbc
            │   configureDeviceXyz
            │   ...

Additional Information and Considerations

This is the current structure: image

cjsha commented 2 months ago

This is another idea. The Operator Inputs/Outputs is optional, if we want to put ContextTask, DataFrames, etc. in the TOC.

OpenEphys.Onix1
|
└─── Core Operators
│   │   createContext
│   │   startAcquisition
│   
└─── Configuration Operators
│   │   configureBreakoutBoard
│   │   configureHeadstageAbc
│   │   configureHeadstageXyz
│   │   ...
│
└─── Data I/O Operators
│   │   abcData
│   │   xyzData
│   │   ...
│
└─── Other
    │
    └─── Device Configuration Operators
    │   │   
    │   │   configureDeviceAbc
    │   │   configureDeviceXyz
    │   │   ...
    │
    └─── Operator Inputs/Outputs
        │   
        │   ContextTask
        │   AbcDataFrame
        │   XyzDataFrame