Skip to content

Commit 9be19e3

Browse files
committed
Flatten TOC hierarchy and update landing page
1 parent 77079ed commit 9be19e3

3 files changed

Lines changed: 46 additions & 54 deletions

File tree

articles/intro.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

articles/toc.yml

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,24 @@
1-
- name: About
2-
items:
3-
- name: What is Harp
4-
href: about.md
1+
- name: Get started
2+
- name: Basic Concepts
3+
href: about.md
4+
- name: Quick Start
5+
href: ../index.md
56
- name: Protocol
6-
items:
7-
- name: Binary Protocol
8-
href: ~/protocol/BinaryProtocol-8bit.md
9-
- name: Common Registers
10-
href: ~/protocol/Device.md
11-
- name: Synchronization Clock
12-
href: ~/protocol/SynchronizationClock.md
7+
- name: Binary Protocol
8+
href: ../protocol/BinaryProtocol-8bit.md
9+
- name: Common Registers
10+
href: ../protocol/Device.md
11+
- name: Synchronization Clock
12+
href: ../protocol/SynchronizationClock.md
1313
- name: Control Interface
14-
items:
15-
- name: Quickstart
16-
href: intro.md
17-
- name: Operators
18-
href: operators.md
19-
- name: Firmware
20-
href: firmware.md
21-
- name: Logging
22-
href: logging.md
23-
- name: Message Manipulation
24-
href: message-manipulation.md
14+
- name: Operators
15+
href: operators.md
16+
- name: Firmware
17+
href: firmware.md
18+
- name: Logging
19+
href: logging.md
20+
- name: Message Manipulation
21+
href: message-manipulation.md
2522
- name: Data Interface
26-
items:
27-
- name: Python
28-
href: python.md
23+
- name: Python
24+
href: python.md

index.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,29 @@
1-
# **Harp** Documentation
1+
Quick Start
2+
===========
23

3-
[!include[what-is-harp](./articles/what-is-harp.md)]
4+
Harp is a standardized solution for:
5+
- Automatic [sub-millisecond synchronization](./protocol/SynchronizationClock.md) across devices
6+
- A [binary protocol](./protocol/BinaryProtocol-8bit.md) for communication between devices and PC
7+
- [Hardware templates](./protocol/Device.md) for developing new devices
48

5-
## Quick Start
9+
All [Harp Devices](./protocol/whoami.md) implement the [Harp Protocol](./protocol/BinaryProtocol-8bit.md) to communicate with an host PC. The `Bonsai.Harp` library provides an implementation of the Harp protocol that can be used to interface with any Harp device.
610

7-
* [What is Harp](./articles/about.md)
8-
* [Binary Protocol](./protocol/BinaryProtocol-8bit.md)
9-
* [Bonsai Interface](./articles/intro.md)
11+
## How to install
1012

11-
> [!Warning]
12-
> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/orgs/harp-tech/discussions) or following the links saying **Improve this Doc**.
13+
1. [Install Bonsai](https://bonsai-rx.org)
14+
2. [Install FTDI D2XX Drivers](https://ftdichip.com/wp-content/uploads/2021/08/CDM212364_Setup.zip)
15+
3. Install `Bonsai.Harp.Design` using the [Bonsai package manager](https://bonsai-rx.org/docs/articles/packages.html).
16+
17+
## Device specific packages
18+
19+
A high-level interface will usually be available for the specific Harp device you are using. To install them, first change the package manager **Package source** to `nuget.org`. Then, in the search bar, look for your device by typing: `harp.<device>`. For instance, for the [Harp Behavior](xref:Harp.Behavior) board, you should find the following package:
20+
21+
<img alt="Installing a Harp device package" src="~/images/behavior-package.png" style="max-height:450px;object-fit:contain" />
22+
23+
The device nodes should now be available in the Bonsai Toolbox and you can start using them in your workflows. See [Operators](./articles/operators.md) for examples of how to manipulate and control Harp devices.
24+
25+
## Next Steps
26+
27+
- [Logging](./articles/logging.md)
28+
- [Firmware](./articles/firmware.md)
29+
- [Data Interface](./articles/python.md)

0 commit comments

Comments
 (0)