Skip to content

Commit

Permalink
Changes to getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
LivingSynthesis committed Jan 16, 2025
1 parent 4cc02a4 commit d0d0fa3
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 51 deletions.
31 changes: 2 additions & 29 deletions docs/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,10 @@ parent: Vortex Engine
---

# Basic Usage
While all Vortex devices work nearly indentically, each device has slightly different features. Check a devices page to better understand it's unique features.

- [Spark Orbit](Spark_Orbit_guide.html)
- [Spark Handle](Spark_Handle_guide.html)
- [Chromadeck](Chromadeck_guide.html)
- [Duo](duo_guide.html)
- [Vortex Orbit](orbit_guide.html)
- [Omega Handle](handles_guide.html)
- [Vortex Glove](gloves_guide.html)
The Vortex Engine is a powerful and versatile platform that can be loaded onto many devices to drive their LEDs. To learn how to use the Vortex Engine for any Vortex device, familiarize yourself with these terms and concepts.

# Inputs

## Power Switch
Most devices can be powered on or off by toggling the power switch. The Duo is powered on and off with its navigation button.

## Buttons
Each device has at least 1 button.

There are three ways to use the _navigation buttons_ on your device: **short clicks**, **long clicks**, and **holds**

1. A **short click** is like saying '_next please_', to cycle through options
2. A **long click** is like saying '_this one please_', to select an option
3. And finally, **holds** are primarily used to open the menus

Some devices have 2 or 3 buttons. These allow for more options while navigating the menus.

Almost everything can be achieved with only **short** and **long** clicks.

Those are the basics of controlling a Vortex Device.

Next, try opening the menus by **holding** the navigation button till the leds blink white, then continue reading more over at [The Menus](menus.html)
If you'd like to get hands on with a specific device, learn how to use [specific vortex devices](vortex_devices.html).

# Key Terminology

Expand Down
39 changes: 18 additions & 21 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,32 @@ has_children: true

# Getting Started

If this is your first time with a Vortex Device then congratulations and welcome to the Vortex Engine tutorial.
Each device is slightly different than the others. Look at your device's page to learn it's specifics.
- Get started with the [Lastest Devices](getting_started_latest_devices.html) - **Spark Orbit, Spark Handles, Chromadeck**.
- Get started with the [Duo](getting_started_duo.html).
- Get started with the [Classic Devices](getting_started_classic_devices.html).

Regardless of which device you have most devices work and function almost entirely the same.
# Inputs

You can expect to find <span style="color: #00c6ff">navigation buttons</span> and a small <span style="color: #00ff00">power switch</span> on any device.
All devices have some combination of buttons and a power switch. This is an overview of what these inputs do on all device.

## Spark Orbit - Spark Handles - Chromadeck
## Power Switch
Most devices can be powered on or off by toggling the power switch. The Duo is powered on and off with its navigation button instead.

<img width="220" height="220" class="device-icon" src="assets/images/spark-orbit-render-square-512.png" alt="Spark Orbit">
<img width="220" height="220" class="device-icon" src="assets/images/spark-handle-render-square-512.png" alt="Spark Handle">
<img width="220" height="220" class="device-icon" src="assets/images/chromadeck-render-square-512.png" alt="Chromadeck">
## Buttons
Each device has at least 1 button.

## Duo
<p>The Duo's navigation button also doubles as its power switch.</p>
<div style="text-align: center;">
<img class="engine-icon" style="margin: 0 auto; width: 9%; height: auto;" src="assets/images/duo-logo-button-square-512.png" alt="Duo">
</div>
There are three ways to use the _navigation buttons_ on your device: **short clicks**, **long clicks**, and **holds**

1. A **short click** is like saying '_next please_', to cycle through options
2. A **long click** is like saying '_this one please_', to select an option
3. And finally, **holds** are primarily used to open the menus

## Next Steps
Some devices have 2 or 3 buttons. These allow for more options while navigating the menus.

To begin learning how to use your device head over to [Basic Usage](basic_usage.html) where we will explore navigating modes, and utilizing the on-device menus.
Almost everything can be achieved with only **short** and **long** clicks.

If your device is new then it will already be up to date, but if you have an older device or would like to learn how to upgrade your device head over to [Upgrade Guides](upgrade_guides.html)
Those are the basics of controlling a Vortex Device.

## Quick Guides
Next, try opening the menus by **holding** the navigation button till the leds blink white, then continue reading more over at [The Menus](menus.html)

If you really just want to jump into things as fast as possible, be sure to check out the [Quick Guides](guides.html)

## Classic Devices

See [Classic Devices](getting_started_classic_devices.html) if you're looking for information on the **Vortex Orbit, Omega Handles, or Vortex gloves**
2 changes: 1 addition & 1 deletion docs/getting_started_classic_devices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Getting Started (Classic)
nav_order: 0
nav_order: 2
parent: Getting Started
has_children: true
---
Expand Down
39 changes: 39 additions & 0 deletions docs/getting_started_duo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
title: Getting Started (Duo)
nav_order: 1
parent: Getting Started
has_children: true
---
<style>
.device-icon {
margin: 0px;
width: 17%;
height: 17%;
}
.duo-icon {
margin: 0px;
width: 7%;
height: 7%;
}
</style>

# Getting Started (Duo)

The Duo's <span style="color: #00c6ff">navigation buttons</span> doubles as it's <span style="color: #00ff00">power switch</span>.


<div style="text-align: center;">
<img class="engine-icon" style="margin: 0 auto; width: 20%; height: auto;" src="assets/images/duo-logo-button-square-512.png" alt="Duo">
</div>


## Next Steps

To begin learning how to use your device head over to [Basic Usage](basic_usage.html) where we will explore navigating modes, and utilizing the on-device menus.

If your device is new then it will already be up to date, but if you have an older device or would like to learn how to upgrade your device head over to [Upgrade Guides](upgrade_guides.html)

## Quick Guides

If you really just want to jump into things as fast as possible, be sure to check out the [Quick Guides](guides.html)
43 changes: 43 additions & 0 deletions docs/getting_started_latest_devices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: default
title: Getting Started (Latest Devices)
nav_order: 0
parent: Getting Started
has_children: true
---
<style>
.device-icon {
margin: 0px;
width: 20%;
height: 20%;
}
</style>

# Getting Started

If this is your first time with a Vortex Device then congratulations and welcome to the Vortex Engine tutorial.

Regardless of which device you have most devices work and function almost entirely the same.

You can expect to find <span style="color: #00c6ff">navigation buttons</span> and a small <span style="color: #00ff00">power switch</span> on any device.

## Spark Orbit - Spark Handles - Chromadeck

<img width="220" height="220" class="device-icon" src="assets/images/spark-orbit-render-square-512.png" alt="Spark Orbit">
<img width="220" height="220" class="device-icon" src="assets/images/spark-handle-render-square-512.png" alt="Spark Handle">
<img width="220" height="220" class="device-icon" src="assets/images/chromadeck-render-square-512.png" alt="Chromadeck">


## Next Steps

To begin learning how to use your device head over to [Basic Usage](basic_usage.html) where we will explore navigating modes, and utilizing the on-device menus.

If your device is new then it will already be up to date, but if you have an older device or would like to learn how to upgrade your device head over to [Upgrade Guides](upgrade_guides.html)

## Quick Guides

If you really just want to jump into things as fast as possible, be sure to check out the [Quick Guides](guides.html)

## Classic Devices

See [Classic Devices](getting_started_classic_devices.html) if you're looking for information on the **Vortex Orbit, Omega Handles, or Vortex gloves**

0 comments on commit d0d0fa3

Please sign in to comment.