-
Notifications
You must be signed in to change notification settings - Fork 3
Added ephys socket tutorial #204
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
Conversation
- When linking to external webpages that are not explicitly cross-referenced, use the webpage URL without the `xref:` in front of it
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.
This is a great start! I think it will be very useful for describing how to use the ephys socket. That being said, I do think there are some changes that need to be made before we can publish it.
I did go through and fix the merge conflicts, as well as fixed the broken xrefs and files. For external references, such as those for the OE GUI docs, you don't need to use xref: before the link.
I also added a hard wrap to the file at 100 characters so that it is easier to visualize and review. I am using the Rewrap extension in VS Code to make this easier to track.
|
yeah you have to be careful with rewrap bc it kills notes, tips, etc. and maybe workflow containers |
|
feedback:
in addition to this feedback, I made a commit in |
- Tried to streamline and clarify text - Please replace the first image with something that summarizes the end result of the tutorial
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.
This is great. I committed some changes. Some comments:
- Image of signal chain on opening page needs to be explained and given more context. TBH I didn't know what it was at first because it does not have much of the characteristic OE GUI design elements to help situate it. Its also not really described via caption or sounding text. At this point i would show a picture of the end result: the whole bonsai editor running and the whole OE GUI with data streaming probe visualizer to give the user an idea of the target.

- Avoid floating sentences. The limited customization of the docfx site makes these littel sentences appear to be floating around in the background. If you have a one line statement to make, it should probably go in in admonition

- The
TCPServernodes are namedSpikeSocketandLFPSocket. Ive changed these to toSpikeServerandLFPServeras that is more descriptive.
Additionally: - Add some images - Fix typos
|
OK, this is probably good enough to merge. A major issue for all of the images in these docs is the following: One major issue we are having with the docs is simply getting pictures of things operating a way that indicates there functionality when used for a real experiment. Its not reassuring to look at example images of data streaming but the data looks like noise or simply a malfunctioning acquisition system. For example we are writing a tutorial on how to stream data to the GUI from bonsai and this is the example of "success": but it looks like a malfunctioning system. We know its due to a floating probe, maybe that somebody was tapping, but its not reassuring to the user. |
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.
Although my previous comments were addressed in theory, these images are not reassuring:
Because the data they show does not look like best-case or even normal scenario for a functional workflow in an experiment. We need to find a way to create images that illustrate what the user should be aiming for.
Per jon's feedback: - Remove random colon and put period. - Remove link to data-elements page and adjust those sentences accordingly
To merge-in the submodule pointer which fixes broken refs




Addresses #121
@cjsha if you could especially check how I handled the scale and offest parameters. Also, the video didn't play on my local build, I'd appreciate help with that.
@bparks13 this is about using what you programmed, I hope it explains it as intended