Skip to content

Add video for accessing Bonsai's help panel #238

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions articles/getting-started/workflow-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,13 @@ help browser is opened. For example, without selecting anything, <kbd>F1</kbd>
opens the [official Bonsai docs Workflow Editor
page](https://bonsai-rx.org/docs/articles/editor.html). If a node in the
workflow or a module in the Toolbox is selected, <kbd>F1</kbd> opens
documentation about that operator. For example, this is
how it looks when the <xref:OpenEphys.Onix1.ConfigureBreakoutBoard> documentation is
open in the embedded Documentation browser:
documentation about that operator.

![documentation browser screenshot](../../images/documentation-browser.png){width=80%}

The ConfigureBreakoutBoard documentation exists on this website. You can also navigate
to it from [here](xref:OpenEphys.Onix1.ConfigureBreakoutBoard).
^^^
<video controls style="width:100%">
<source src="../../images/bonsai-help-panel.webm" type="video/webm">
</video>
^^^ This video demonstrates how to copy/paste example workflows from Open Ephys's online documentation in Bonsai. Pressing <kbd>Ctrl+E</kbd> focuses the Toolbox and pressing <kbd>F1</kbd> while ConfigureBreakoutBoard is selected in the Toolbox opens the [ConfigureBreakoutBoard page](xref:OpenEphys.Onix1.ConfigureBreakoutBoard) on this website. The example workflow can be navigated to from the ConfigureBreakoutBoard page and copied/pasted into the workflow editor. Yellow circles around the cursor indicate left-clicks; red circles around the cursor indicate right-clicks.

## Starting the Workflow

Expand Down
Binary file added images/bonsai-help-panel.webm
Binary file not shown.