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

StartAcquisition diagram doesn't explain what Frame is #19

Closed cjsha closed 2 months ago

cjsha commented 3 months ago

What is Frame? image

<see cref="oni.Frame"> doesn't work

https://github.com/open-ephys/onix-bonsai-onix1/blob/7ac700fb8a696d4d9f8d97c9d1b85765b9951ca6/OpenEphys.Onix1/StartAcquisition.cs#L51

cjsha commented 3 months ago

<see cref="oni.Frame"> as invalid cref also referenced in this issue

https://github.com/open-ephys/onix-bonsai-onix1/issues/208

jonnew commented 3 months ago

To do this correctly, clroni should be its own repo and have its own documentation site. Its a bit of work do do this but its probably a good idea because clroni should have automated builds and packaging anyway. I think until then, we should leave this issue alone.

https://github.com/open-ephys/liboni/issues/27

jonnew commented 2 months ago

This will be handled in external repos: