Merge pull request #23 from CharaChorder/GTM

Initial draft of GTM section

README.md

@@ -15,4 +15,52 @@ sphinx-build docs _build
 ## Adding a new top level page
 
 If you are adding or editing an under construction top level page, make sure to 
-add it to index.rst if you'd like to have it shown on the left side bar.
+add it to index.rst if you'd like to have it shown on the left side bar.
+
+## Linking
+.. _Slow Speed: = Anchor to same section in same doc
+:ref:`slow speed <Slow Speed>` = link to anchor
+
+## Tables
+.. csv-table::
+    :header: "Device", "Default", "Min. Value", "Max. Value", "Increments"
+
+    "CharaChorder One", ""
+    "CharaChorder Lite", ""
+    "CharaChorder X", ""
+    "CharaChorder Engine", ""
+
+## Dropdown
+.. dropdown:: Title of the Dropdown, visible with the DD closed.
+
+    Text inside the dropdown should skip a line then indent once (4 spaces).
+
+## Images
+.. _Reference Name:
+.. image:: /assets/images/PATH-TO-IMAGE.jpg
+  :width: 1200
+  :alt: Alt text for screen readers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

docs/CharaChorder One.rst

@@ -169,11 +169,11 @@ the way in, otherwise, the CharaChorder might not function as intended.
 
 .. warning::
    IMPORTANT: During your first time plugging your CharaChorder in,
-   and every time thereafter when you have :doc:`realtime feedback<Generative Text Menu (GTM)>` enabled, it’s
+   and every time thereafter when you have :doc:`realtime-feedback<GenerativeTextMenu>` enabled, it’s
    recommended that you have your cursor in a blank typing space. The 
    CharaChorder has a welcome message that can send instructions to your 
    computer that are not intended by the user. This feature can be disabled in
-   the :doc:`GTM<Generative Text Menu (GTM)>`. 
+   the :doc:`GTM<GenerativeTextMenu>`. 
 
 After making sure that all the cables on the CharaChorder are properly
 plugged in, connect the USB-A side of the :ref:`power cable<power cable>` into
@@ -185,18 +185,18 @@ whether or not your cursor is somewhere where text can be entered… - You
 will be able to see a small, lime colored light inside the space that
 holds the USB-C port on the left half of the CharaChorder One.
 
-If you have :doc:`realtime feedback<Generative Text Menu (GTM)>` enabled, once you can see the highlighted text that reads
+If you have :doc:`realtime feedback<GenerativeTextMenu:Realtime feedback>` enabled, once you can see the highlighted text that reads
 “CCOS is ready”, your device is ready to be used.
 
 .. note::
-   IMPORTANT: :doc:`Realtime feedback<Generative Text Menu (GTM)>` is enabled by default on new CharaChorder devices.
+   IMPORTANT: :doc:`Realtime feedback<GenerativeTextMenu:Realtime feedback>` is enabled by default on new CharaChorder devices.
 
 Getting Started
 *******************
 
 There are a few steps that you’ll likely want to take if this is your
 first time using your CharaChorder device. In the following section, we
-will update your device, explain navigation in the :doc:`GTM<Generative Text Menu (GTM)>`, and demonstrate the default layout on your new
+will update your device, explain navigation in the :doc:`GTM<GenerativeTextMenu>`, and demonstrate the default layout on your new
 device.
 
 Updating your Device
@@ -240,7 +240,7 @@ which is the latest firmware release by visiting `this
 site <https://www.charachorder.com/pages/update-your-firmware>`__. 
 
 .. warning::
-   IMPORTANT: Before performing the below steps, please make sure that you have a :doc:`backup of your layout<Backups>`      as well as a :doc:`backup of your chord library<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 :doc:`Backups<Backups>`    section. The update might also reset some of your :ref:`GTM<Generative Text Menu (GTM)>` settings. Be sure to write    down settings before you update.
+   IMPORTANT: Before performing the below steps, please make sure that you have a :doc:`backup of your layout<Backups>`      as well as a :doc:`backup of your chord library<Backups>` and a :doc:`backup of your GTM settings<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 :doc:`Backups<Backups>`    section.
 
 #. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://manager.charachorder.com/config/layout/>`__ 
 #. Click “Connect”
@@ -271,12 +271,12 @@ device is plug-and-play, you don’t need any software to edit the
 device’s settings; all you need is a place to type text. We call these
 settings the Generative Text Menu, or GTM for short.
 
-You can access the :doc:`GTM<Generative Text Menu (GTM)>` by
+You can access the :doc:`GTM<GenerativeTextMenu>` by
 :doc:`chording<Chords>` both pinkies `north`_ on any space that
 allows text entry such as a notepad app. For an explanation on chords
 and how to perform them, visit the :doc:`Chords<Chords>` section.
 
-Once you perform the chord to call up the :doc:`GTM<Generative Text Menu (GTM)>`, your CharaChorder will type out the menu and its options.
+Once you perform the chord to call up the :doc:`GTM<GenerativeTextMenu>`, your CharaChorder will type out the menu and its options.
 It will look something like this:
 
 
@@ -294,7 +294,7 @@ decrease these, you can use the arrow keys on your CharaChorder One.
 
 ``CharaChorder > Chording > Press Tolerance [ Use up/down arrow keys to adjust: 25ms ]``
 
-You can read an explanation on all of the settings on your CharaChorder device :doc:`here<Generative Text Menu (GTM)>`.
+You can read an explanation on all of the settings on your CharaChorder device :doc:`here<GenerativeTextMenu>`.
 
 Learning the Layout
 -------------------
@@ -378,7 +378,7 @@ while the target key is pressed.
 
 .. note::
    EXAMPLE: On the CC English layout, you can access the F1 key by
-   pressing and holding either pinky down, into the device.
+   pressing and holding either pinky down, into the device, and adding the letter ``a`` or ``r`` (location of number 1 on the default layout) to it.
 
 Shift Modifier
 ^^^^^^^^^^^^^^

docs/Chords.rst

@@ -26,6 +26,7 @@ of those is and how they affect chords on your CharaChorder device
 below. Throughout this guide, we might use the term “perform” when
 talking about carrying out a chord. 
 
+.. _Chord Input:
 Chord Input
 ~~~~~~~~~~~~~~~~~~