Skip to content

Commit

Permalink
Some edits to TOCs and section headings
Browse files Browse the repository at this point in the history
- Add descriptions for top level icon links
- Switch tutorial and reference top level section order to match icon
  links
- Add a note indicating that tutorials are wip
- Simplify some section headings
  • Loading branch information
jonnew committed Oct 5, 2024
1 parent e869faa commit 43a330d
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion articles/getting-started/install-configure-bonsai.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
uid: install-configure-bonsai
title: Bonsai Installation and Configuration
title: Installation
---

## Install Bonsai
Expand Down
2 changes: 1 addition & 1 deletion articles/getting-started/start-workflow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
uid: start-workflow
title: Start Workflow
title: Starting the Workflow
---

Once all operators have been placed and linked correctly, and all **Configuration** properties have been set, it is now possible to run a workflow. Note that some aspects of Bonsai are only available in specific contexts; for instance, the GUIs mentioned above can only be opened when a workflow is not running. Once a workflow is running, these GUIs are not accessible, but visualizers for certain operators can be opened to view the streaming data.
Expand Down
1 change: 0 additions & 1 deletion articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
- href: getting-started/initialize-oni-context.md
- href: getting-started/start-workflow.md
- href: getting-started/visualize-data.md
- href: getting-started/next-steps.md

- name: Hardware Guides
href: hardware/index.md
Expand Down
6 changes: 4 additions & 2 deletions articles/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ uid: tutorials
title: Tutorials
---

This section of the docs contains tutorials that extend beyond using specific Open Ephys hardware, including:
- How to manage memory and latencies
> [!Note]
> This section will contains tutorials that demonstrate how to make the most of
> the Bonsai library by combining ONIX with third party tools, tuning closed loop
> response times, etc.
1 change: 0 additions & 1 deletion articles/tutorials/toc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
- href: index.md
items:
- href: buffers-memory-usage.md
7 changes: 4 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@ uid: index
title: OpenEphys.Onix1
---

`OpenEphys.Onix1` is a [Bonsai](https://bonsai-rx.org/) library that can be used to control the [ONIX PCIe Acquisition System](https://open-ephys.org/onix/oeps-9006), which provides:
`OpenEphys.Onix1` is a [Bonsai](https://bonsai-rx.org/) library that can be used to control the [ONIX PCIe Acquisition System](https://open-ephys.org/onix/oeps-9006). It provides:

* Support for a variety of tools such as [Neuropixels (all
variants)](https://www.neuropixels.org/),
[Miniscopes](https://open-ephys.org/miniscope-v4/miniscope-v4), [Intan-based
headstages](https://open-ephys.org/onix/oeps-7741), and more
* Automatic hardware synchronization of all data streams.
* Torque-free commutation of ultra-thin (down to ~0.2mm diameter) tethers
* High performance closed-loop control (100 usec feedback loop times)
* High performance closed-loop performance (100 usec feedback loop times)

<br>
<div class="quick-links">

| <xref:getting-started> | [Operator Reference](xref:OpenEphys.Onix1) | <xref:tutorials> | [Hardware Guide](https://open-ephys.github.io/onix-docs/) |
| [User Guide](xref:getting-started) | [Operator Reference](xref:OpenEphys.Onix1) | <xref:tutorials> | [Hardware Guide](https://open-ephys.github.io/onix-docs/) |
|:----:|:----:|:----:|:----:|
| [![User Guide](images/running.svg){width=150}](xref:getting-started) | [![Operator Reference](images/books.svg){width=150}](xref:OpenEphys.Onix1) | [![Tutorials](images/beaker.svg){width=150}](xref:tutorials) |[![Tutorials](images/screwdriver.svg){width=150}](https://open-ephys.github.io/onix-docs/)|
| Start here for usage instructions. | Detailed information on library components. | How to make the most of ONIX in Bonsai. | Go to the hardware documentation site. |

</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions toc.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- name: User Guide
href: articles/
- name: Tutorials
href: articles/tutorials/
- name: Reference
href: api/
href: api/
- name: Tutorials
href: articles/tutorials/

0 comments on commit 43a330d

Please sign in to comment.