Skip to content

Commit

Permalink
Typos and small changes for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
LivingSynthesis committed Aug 20, 2024
1 parent bbfad45 commit 9dcd646
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 deletions.
12 changes: 7 additions & 5 deletions docs/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ When a Vortex device is first turned on it will always start on the first [Mode]

You can think of a _mode_ as the colorful blinking pattern that is playing on the leds.

Some devices have more _modes_, some have less. But each device is able to cycle through the modes and enter menus all with just the _navigation buttons_.
Some devices have more _modes_ than others, but each device is able to access all the modes and enter menus using the _navigation buttons_.

Menus allow you to program your device, such as changing the colors, blinking patterns, brightness, or even transferring modes to other devices.

## Navigating
There is three ways to use the _navigation buttons_ on your device: **short clicks**, **long clicks**, and **holds**
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
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 a 2nd navigaion button. A **long click** on this button is like saying '_nevermind_', and returns to displaying modes.

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

Now that you understand the basics of controlling your vortex device, try **holding** the navigation button till the leds start alternating white blinks, then continue reading over at [The Menus](menus.html)
Now that you understand the basics of controlling your vortex device, try **holding** the navigation button till the leds start alternating white blinks. This is how the menus are opened, continue reading more over at [The Menus](menus.html)

6 changes: 3 additions & 3 deletions docs/gloves_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ There is also a very small <span style="color: #ff0000">reset button</span> for

## Navigating Modes

Short click the <span style="color: #00c6ff">navigation button</span> to forward through the 14 available modes.
Short click the <span style="color: #00c6ff">navigation button</span> to cycle forward through the 14 available modes.

To edit a mode, navigate to it then hold the navigation button to open the menus.
To edit a mode, navigate to it then hold the navigation button until the lights flash white to open the menus.

## Menus

Use short clicks to cycle through the following menu options, long click to enter a menu.
Once the menus are open, use short clicks to cycle through the following menu options, long click to enter a menu.

{% raw %}
<div class="menu-wrapper">
Expand Down
6 changes: 3 additions & 3 deletions docs/handles_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ To access the USB port or the reset button remove the outer handle cover by push

## Navigating Modes

Short click the <span style="color: #00c6ff">navigation button</span> to forward through the 14 available modes.
Short click the <span style="color: #00c6ff">navigation button</span> to cycle forward through the 14 available modes.

To edit a mode, navigate to it then hold the navigation button to open the menus.
To edit a mode, navigate to it then hold the navigation button until the lights flash white to open the menus.

## Menus

Use short clicks to cycle through the following menu options, long click to enter a menu.
Once the menus are open, use short clicks to cycle through the following menu options, long click to enter a menu.

{% raw %}
<div class="menu-wrapper">
Expand Down
12 changes: 5 additions & 7 deletions docs/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,24 +80,22 @@ has_children: true
</style>

# Menus
The menus provide a way to use the navigation buttons to customize your Vortex Device and manage its configuration.
The menus provide a way to customize your Vortex Device and manage its configuration.

Each Vortex Device offers the same menus, with the only differences in menu behaviour coming from the varying LED counts and orientations.
Each Vortex Device offers the same functionality and menus, with the only differences in menu behaviour coming from the varying LED counts and orientations.

## Using Menus
To enter a menu, switch to a mode you'd like to edit and then hold the navigation button until the LEDs blink white.
To enter a menu, cycle to the mode you'd like to edit and then hold the navigation button until the LEDs blink white. Using short clicks, navigate to the color that corresponds to the menu you'd like to open and long click to select it.

The <span style="color: #00ff00;">Color Select</span>, <span style="color: #3366ff;">Pattern Select</span>, <span style="color: #ffffff;">Randomizer</span>, and <span style="color: #00ffff;">Mode Sharing</span> menus will only affect this mode.

<span style="color: #ff0000;">Factory Reset</span> and <span style="color: #ffff00;">Global Brightness</span> will apply to the entire device.

Using short clicks, navigate to the color that corresponds to the menu you'd like and long click to select it.

## Selecting LEDs

Three menus allow you to choose specific LEDs: <span style="color: #00ff00;">Color Select</span>, <span style="color: #3366ff;">Pattern Select</span>, and <span style="color: #ffffff;">Randomizer</span>.
Three menus allow you to choose specific LEDs upon entering: <span style="color: #00ff00;">Color Select</span>, <span style="color: #3366ff;">Pattern Select</span>, and <span style="color: #ffffff;">Randomizer</span>.

Upon entering one of these menus, the first step is _LED selection_. You decide which LEDs the menu will affect when making changes.
After selecting the menu, you decide which LEDs the menu will affect when making changes.

- **Short click** to cycle through the available LED groups.
- **Long click** to confirm your selection and proceed into the menu.
Expand Down
6 changes: 3 additions & 3 deletions docs/orbit_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ There is also a very small <span style="color: #ff0000">reset button</span> for

## Navigating Modes

Short click the <span style="color: #00c6ff">navigation buttons</span> to cycle forward or backwards through the 14 available modes.
Short click the <span style="color: #00c6ff">navigation buttons</span> to cycle forward or backwards through the 14 available modes. The button closer to the outer edge goes forward, while the more central button goes backwards.

To edit a mode, navigate to it then hold the navigation button to open the menus.
To edit a mode, navigate to it then hold the outer navigation button until the lights flash white to open the menus.

## Menus

Use short clicks to cycle through the following menu options, long click to enter a menu.
Once the menus are open, use short clicks to cycle through the following menu options, long click the outer button to enter a menu.

{% raw %}
<div class="menu-wrapper">
Expand Down

0 comments on commit 9dcd646

Please sign in to comment.