some work on docs

StoneOrbits · Jul 14, 2024 · d460018 · d460018
1 parent f73facd
commit d460018
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 34 deletions.
diff --git a/docs/basic_usage.md b/docs/basic_usage.md
@@ -0,0 +1,14 @@
+---
+layout: default
+title: Basic Usage
+nav_order: 3
+parent: Vortex Engine
+---
+
+# Basic Usage
+
+ have one primary button while a few others sport a secondary button.  The primary (or main) button on all devices will behave the same and the secondary button will have varying functionality across menus.
+
+Most devices have a hardware switch to control power, find this switch on your device and turn it on.
+
+Once the vortex device is running, the primary button will cycle through the various [modes](modes.html). The 'modes' that come with the device are the defaults and they can be restored at any time.
diff --git a/docs/colorsets.md b/docs/colorsets.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Colorsets
-nav_order: 5
+nav_order: 7
 parent: Vortex Engine
 ---
 

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -7,8 +7,28 @@ parent: Vortex Engine
 
 # Getting Started
 
-Here is a getting started guide from StoneOrbits:
+Below is an animated guide provided by StoneOrbits:
 
 {% raw %}
-<iframe src="https://docs.google.com/presentation/d/e/2PACX-1vRLsq6i3h9JlYHX0wS3SG9eDZ1vzIsRIU8GAZ9C2QW80uRoexr6_MAmvv_RAu7yuKxZiHy0dH9s2c3q/embed?start=false&loop=false&delayms=3000" frameborder="0" width="100%" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
-{% endraw %}
+<xiframe src="https://docs.google.com/presentation/d/e/2PACX-1vRLsq6i3h9JlYHX0wS3SG9eDZ1vzIsRIU8GAZ9C2QW80uRoexr6_MAmvv_RAu7yuKxZiHy0dH9s2c3q/embed?start=false&loop=false&delayms=3000" frameborder="0" width="100%" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
+{% endraw %}
+
+Continue reading
+
+# Getting to Know the Device
+
+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, Orbit, Handles, Wired Gloves, or others, most devices work and function almost entirely the same.
+
+The first thing you should do is connect your device to the PC and install updates to avoid any potential known bugs or problems, continue reading below for instructions to do this.
+
+However, if you'd rather live life on the edge and want to jump straight into things then head over to [Basic Usage](basic_usage.html) to start using your device now.
+
+# Connecting Your Device
+
+All Vortex Devices (except the duo) have a USB plug that can be used to connect the device to the computer.
+
+_It is important that a data-capable USB cable is used_ otherwise the device will not be able to connect.
+
+Continue reading the [Upgrade Guide](upgrade_guide.html) to perform the upgrade.
diff --git a/docs/menus.md b/docs/menus.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Menus
-nav_order: 5
+nav_order: 8
 parent: Vortex Engine
 has_children: true
 ---

diff --git a/docs/modes.md b/docs/modes.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Modes
-nav_order: 4
+nav_order: 5
 parent: Vortex Engine
 ---
 

diff --git a/docs/patterns.md b/docs/patterns.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Patterns
-nav_order: 4
+nav_order: 6
 parent: Vortex Engine
 ---
 

diff --git a/docs/savefile_format.md b/docs/savefile_format.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Savefiles
-nav_order: 7
+nav_order: 9
 parent: Vortex Engine
 ---
 

diff --git a/docs/upgrade_guide.md b/docs/upgrade_guide.md
@@ -5,4 +5,18 @@ nav_order: 2
 parent: Vortex Engine
 ---
 
-# Upgrading a Device to Latest Vortex 
+# Upgrade Guide
+
+This guide will cover upgrading a Vortex Device to the latest version of Vortex Engine
+
+## Connecting the Device
+
+After the device is connected to the computer, often followed by a 'new connection' sound from the PC, a red light near it's plug will indicate charging is taking place.
+
+Navigate in your browser to the the downloads page of [Vortex Community](https://vortex.community/downloads)
+
+
+
+
+
+# Upgrading a Device
diff --git a/docs/vortex_devices.md b/docs/vortex_devices.md
@@ -26,30 +26,6 @@ The four devices currently available include:
 
 You can read more about the Vortex Devices [here](vortex_devices.html).
 
-## The Vortex Editors
-
-Vortex Engine doesn't just power embedded lightshow devices. The software can also be built for desktop computers to implement 'virtual Vortex Devices'.  A 'virtual Vortex Device', although sounding complicated, is actually the best way to provide a PC-based savefile editor for Vortex devices.
-
-The best example of a 'virtual Vortex Device' is the website [lightshow.lol](https://lightshow.lol), here you see the output of a single-led 'virtual device' with a series of controls to edit the pattern and colorset in realtime.
-
-Another example of a , a Windows-only desktop software that can connect to Vortex Devices and program them via USB.
-
-The editor allows for configurations that are otherwise unobtainable through the device menus. You can read more about the editor [here](editor.html).
-
-## The Vortex Community and Ecosystem
-
-All Vortex Devices can transmit and receive their configurations in some way. This allows for an ecosystem where users device configurations can transfer to other devices to create matching patterns and colorsets.
-
-Explore the official Vortex Community Hub where you can upload and share configurations and modes with friends and other lightshow artists.
-
-[Visit Vortex Community Hub](https://vortex.community)
-
-Join the Vortex Community Discord to share your experiences, enhance your use of the Vortex Engine, and discuss Vortex with other enthusiasts.
-
-[Join Vortex Community Discord](https://discord.gg/FnbKjPgy)
-
-
-
 # Vortex Devices
 
 This page aims to cover the main differences and similaries of each Vortex Device.

diff --git a/docs/vortex_engine.md b/docs/vortex_engine.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: The Engine
-nav_order: 3
+nav_order: 4
 parent: Vortex Engine
 ---