Merge pull request #82 from CharaChorder/update-instructions

Updates docs that covers changes made to ccio

Author: jdestgermain

docs/CCOS.rst

@@ -76,7 +76,7 @@ Part I - Back up chord library and update device
 #. Click ‘Export Library’ to export a .csv file to your machine (The file should be called: “CharaChorder_ChordLibrary.csv”)
 #. Once you are absolutely sure your library is exported properly, and ALL of your chords are present in the file, click the ‘Delete All Chords’’ button.
 #. Refresh the page, reconnect your device via steps 2-3, and click the ‘Bootloader’ button. A file explorer window should open on Windows. On Mac you may need to find your device as an external drive
-#. Download your update file from this site: `<https://www.charachorder.com/pages/update-your-firmware>`__
+#. Proceed with updating your device by visiting this site, choosing which device you are updating, and then proceed with Step 4. It will open a file explorer where you can find the mounted device as an external drive.  `<https://charachorder.io/ccos/>`__
 
     .. warning::
         You'll notice that there are two different versions of the CharaChorder 
@@ -93,8 +93,7 @@ Part I - Back up chord library and update device
         Additionally, the file name is case-sensitive; all letters must be
         capitalized.
 
-#. Drag the UF2 file into the file explorer window and confirm that you would like to replace the existing file.
-#. The file explorer window should automatically close
+#. After saving, your device should successfully reboot and have CCOS.
 
 
 

docs/CharaChorder Keys.rst

@@ -207,27 +207,25 @@ Updating your Device
    instructions on how to upgrade your device to our new CCOS :ref:`here<CCOS:Upgrade to CCOS>`. If your device is not running    :doc:`CCOS<CCOS>`, you will be unable to follow the
    steps below to update your device.
 
-.. _charachorder-one-checking-your-devices-firmware:
-
 Checking your Device’s Firmware
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can check your device’s current firmware by following the steps
 below: 
 
 #. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://charachorder.io/config/layout/>`__ (Linux users see :ref:`this link<serialportaccess>` for more information about configuring serial port access.)
-#. Click “Connect” 
+#. Click “Connect” at the bottom middle of the page
 #. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the blue “connect” button
 
 After following the above steps, you can find your
-firmware version right above the “Connect” button. It will read
+firmware version in the bottom left of your screen. It will read
 something like this:
 
-``CHARACHORDER ONE M0 --- Version 1.1.3``
+``CCOS 1.1.4``
 
 .. _Firmware Check:
 .. image:: /assets/images/DMFW.png
-  :width: 347
+  :width: 1200
   :alt: Checking the firmware on Device Manager
 
 Updating the Firmware
@@ -236,31 +234,21 @@ Updating the Firmware
 If you find that your device is not running the latest firmware version,
 you can follow the steps below to update your device. You can check
 which is the latest firmware release by visiting `this
-site <https://www.charachorder.com/pages/update-your-firmware>`__. 
+site <https://charachorder.io/ccos/>`__. 
 
 .. warning::
-   IMPORTANT: Before performing the below steps, please make sure that you have a :ref:`backup of your layout<Device Manager:Backups>` as well as a :ref:`backup of your chord library<Device Manager:Backups>` and a :ref:`backup of your GTM settings<Device Manager:Backups>`. The update might reset those, so it's important that you    keep backup files handy. For instructions on how to restore backed up files, visit the :ref:`Backups<Device Manager:Restoring from a Backup>`    section.
+   IMPORTANT: Before performing the below steps, please make sure that you have a :ref:`backup of your layout<Device Manager:Backups>` as well as a :ref:`backup of your chord library<Device Manager:Backups>` and a :ref:`backup of your GTM settings<Device Manager:Backups>`. The update might reset those, so it's important that you keep backup files handy. For instructions on how to restore backed up files, visit the :ref:`Backups<Device Manager:Restoring from a Backup>` section.
 
 #. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://charachorder.io/config/layout/>`__ 
-#. Click “Connect”
+#. If not auto-connected, click “Connect”
 #. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the blue “connect” button
-#. _`Click` “Boot Menu” (the power icon) followed by “Bootloader”. Your CharaChorder will now appear as an external storage device on your computer’s file explorer or Finder app. It might be named one of the following: “Arduino”, “Seeduino”, or “CharaChorder One”.
-#. Download your update file from this site: `<https://www.charachorder.com/pages/update-your-firmware>`__
-
-.. warning::
-   IMPORTANT: Make sure that the file you download is named exactly
-   like this: CURRENT.UF2 . If there are any other characters in the
-   file name, the file will not work. “CURRENT.UF2(1)” will NOT work.
-   Additionally, the file name is case sensitive; all letters must be
-   capitalized.
-
-6. Copy the CURRENT.UF2 file that you just downloaded and paste it into the CharaChorder drive that we found in :ref:`step 4<Click>`
-7. When your computer asks you how you would like to resolve the issue of two files with the same name, select “Replace file”.
+#. Click on the CCOS version on the bottom left of the page
+#. You will see a list of available versions along with their release date. Click on the one you want.
+#. Follow the steps on screen to update your device.
 
-At this point, your CharaChorder One will automatically reboot and the
-CharaChorder drive will have disappeared. Congratulations! You have
+At this point, your device will automatically reboot. Congratulations! You have
 successfully updated your device. You can check your device’s firmware
-version by following the steps :ref:`here<charachorder-one-checking-your-devices-firmware>`.
+version by following the steps :ref:`here<CharaChorder One:Checking your Device’s Firmware>`.
 
 Understanding the Settings
 --------------------------

docs/CharaChorder One.rst

@@ -210,7 +210,7 @@ Updating the Firmware
 If you find that your device is not running the latest firmware version,
 you can follow the steps below to update your device. You can check
 which is the latest firmware release by visiting `this
-site <https://www.charachorder.com/pages/update-your-firmware>`__. 
+site <https://charachorder.io/ccos/>`__. 
 
 .. warning::
    IMPORTANT: Before performing the below steps, please make sure that you have a :ref:`backup of your layout<Device Manager:Backups>` as well as a :ref:`backup of your chord library<Device Manager:Backups>` and a :ref:`backup of your GTM settings<Device Manager:Backups>`. The update might reset those, so it's important that you keep backup files handy. For instructions on how to restore backed up files, visit the :ref:`Backups<Device Manager:Restoring from a Backup>` section.
@@ -222,7 +222,7 @@ site <https://www.charachorder.com/pages/update-your-firmware>`__.
 #. You will see a list of available versions along with their release date. Click on the one you want.
 #. Click "Apply Update"
 
-At this point, your CC2 will automatically reboot. Congratulations! You have
+At this point, your device will automatically reboot. Congratulations! You have
 successfully updated your device. You can check your device’s firmware
 version by following the steps :ref:`here<charachorder-two-checking-your-devices-firmware>`.
 

docs/CharaChorder Two.rst

@@ -111,18 +111,18 @@ You can check your device’s current firmware by following the steps
 below: 
 
 #. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://charachorder.io/config/layout/>`__ (Linux users see :ref:`this link<serialportaccess>` for more information about configuring serial port access.)
-#. Click “Connect” 
+#. Click “Connect” at the bottom middle of the page
 #. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the blue “connect” button
 
 After following the above steps, you can find your
-firmware version right above the “Connect” button. It will read
+firmware version in the bottom left of your screen. It will read
 something like this:
 
-``CHARACHORDER X S2 --- Version 1.1.3``
+``CCOS 1.1.4``
 
-.. _CCX Firmware Check:
-.. image:: /assets/images/DMFW-CCX.png
-  :width: 295
+.. _Firmware Check:
+.. image:: /assets/images/DMFW.png
+  :width: 1200
   :alt: Checking the firmware on Device Manager
 
 Updating the Firmware
@@ -131,29 +131,19 @@ Updating the Firmware
 If you find that your device is not running the latest firmware version,
 you can follow the steps below to update your device. You can check
 which is the latest firmware release by visiting `this
-site <https://www.charachorder.com/pages/update-your-firmware>`__. 
+site <https://charachorder.io/ccos/>`__. 
 
 .. warning::
-   **IMPORTANT**: Before performing the below steps, please make sure that you have a :ref:`backup of your layout<Device Manager:Backups>`      as well as a :ref:`backup of your chord library<Device Manager:Backups>`. The update might reset those, so it's important that you    keep backup files handy. For instructions on how to restore backed up files, visit the :ref:`Backups<Device Manager:Restoring from a Backup>`    section. The update might also reset some of your :doc:`GTM<GenerativeTextMenu>` settings. Be sure to write    down settings before you update.
+   IMPORTANT: Before performing the below steps, please make sure that you have a :ref:`backup of your layout<Device Manager:Backups>` as well as a :ref:`backup of your chord library<Device Manager:Backups>` and a :ref:`backup of your GTM settings<Device Manager:Backups>`. The update might reset those, so it's important that you keep backup files handy. For instructions on how to restore backed up files, visit the :ref:`Backups<Device Manager:Restoring from a Backup>` section.
 
 #. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://charachorder.io/config/layout/>`__ 
-#. Click “Connect”
+#. If not auto-connected, click “Connect”
 #. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the blue “connect” button
-#. _`Click` “Boot Menu” (the power icon) followed by “Bootloader”. Your CharaChorder will now appear as an external storage device on your computer’s file explorer or Finder app. It might be named one of the following: “TinyUSB”, “TinyUSB CDC”, or “CharaChorder X”.
-#. Download your update file from this site: `<https://www.charachorder.com/pages/update-your-firmware>`__
-
-.. warning::
-   **IMPORTANT**: Make sure that the file you download is named exactly
-   like this: CURRENT.UF2 . If there are any other characters in the
-   file name, the file will not work. “CURRENT.UF2(1)” will NOT work.
-   Additionally, the file name is case sensitive; all letters must be
-   capitalized.
-
-6. Copy the CURRENT.UF2 file that you just downloaded and paste it into the CharaChorder drive that we found in :ref:`step 4<Click>`
-7. When your computer asks you how you would like to resolve the issue of two files with the same name, select “Replace file”.
+#. Click on the CCOS version on the bottom left of the page
+#. You will see a list of available versions along with their release date. Click on the one you want.
+#. Click "Apply Update"
 
-At this point, your CharaChorder X will automatically reboot and the
-CharaChorder drive will have disappeared. Congratulations! You have
+At this point, your device will automatically reboot. Congratulations! You have
 successfully updated your device. You can check your device’s firmware
 version by following the steps :ref:`here<CharaChorder X:Checking your Device’s Firmware>`.