Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lots of link/warning fixes #59

Merged
merged 1 commit into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ venv/
results/*.png
results/*.txt
processed_data/*.dat
.*.sw?
.*.sw?
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ sphinx-autobuild docs _build
## Building

```sh
sphinx-build docs _build
sphinx-build -a docs _build
```

Note, the -a flag will rebuild all files, regardless of if they have changed. This is useful so that warnings don't get cached. All warnings are preferred to be fixed rather than left, although in some cases (docs don't exist yet) the warnings are fine to leave.

## Adding a new top level page

If you are adding or editing an under construction top level page, make sure to
Expand Down
8 changes: 4 additions & 4 deletions docs/CharaChorder One.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,11 @@ 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<GenerativeTextMenu:Realtime feedback>` enabled, once you can see the highlighted text that reads
If you have :ref:`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<GenerativeTextMenu:Realtime feedback>` is enabled by default on new CharaChorder devices.
IMPORTANT: :ref:`Realtime feedback<GenerativeTextMenu:Realtime feedback>` is enabled by default on new CharaChorder devices.

Getting Started
*******************
Expand Down Expand Up @@ -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>` 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.
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://manager.charachorder.com/config/layout/>`__
#. Click “Connect”
Expand Down Expand Up @@ -454,7 +454,7 @@ layout has been optimized for writing in English by
:doc:`chentry<Glossary>` and :doc:`chording<Chords>`, some users may
choose to :doc:`remap<Glossary>` their device’s layout to better
suit their personal needs. For a thorough explanation on how remapping
works and how to remap your device, visit the :doc:`remapping section<Remapping>`
works and how to remap your device, visit the :ref:`remapping section<Device Manager:Remapping>`

Practice
~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions docs/CharaChorder Operating System (CCOS).rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ consistent performance across all devices and enhances the ability of our team
to introduce new features, fix bugs, as well as respond to feedback more
efficiently with a convergent and spearheaded approach. In addition to the
introduction of importable and exportable settings, inside your
:doc:`Generative Text Menu (GTM)<Generative Text Menu (GTM)>` you'll find new
:doc:`Generative Text Menu (GTM)<GenerativeTextMenu>` you'll find new
configurable settings including programmable debounce, arpeggiate tolerances,
and even a customizable scan rate. Specialized 'hard coded' chords which were
previously immutable can now be edited, including chords only available in
Expand Down Expand Up @@ -49,7 +49,7 @@ can adopt or build upon, with possibilities that are only limited by the human
imagination. Do you want to publish your own DataHand inspired
:doc:`CharaChorder One<CharaChorder One>` layout? Do you want to utilize fluid
chorded/character entry in tandem with layouts/theories developed for velotype
or stenography on your :doc:`CharaChorder Lite<CharaChorder Lite>`? Do you want
or stenography on your :doc:`CharaChorder Lite<CharaChorder_Lite>`? Do you want
to introduce the world's first 1-Dimensional keyboard layout designed for both
character entry and chorded entry? What about a creative combination of all of
the above which utilizes 100% custom hardware? No problem. This is all possible
Expand Down
24 changes: 12 additions & 12 deletions docs/CharaChorder X.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ additional software to work.

.. warning::
IMPORTANT: During your first time plugging your CharaChorder in,
and every time thereafter when you have :doc:`realtime feedback<Generative Text Menu (GTM)>`
and every time thereafter when you have :ref:`realtime feedback<GenerativeTextMenu:Realtime Feedback>`
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>`.

Take the male USB-A connector from your keyboard and plug it into the CharaChorder X's female USB-A port. After that, take the male USB'A connector on the CharaChorder X and plug it into a female USB-A port on your computer.

Expand All @@ -87,18 +87,18 @@ following things:

- Regardless of whether or not your cursor is somewhere where text can be entered: You will be able to see a small, red colored light inside the shell of the CharaChorder X.

If you have :doc:`realtime feedback<Generative Text Menu (GTM)>` enabled, once you can see the highlighted text that reads
If you have :ref:`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: :ref:`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
Expand Down Expand Up @@ -134,7 +134,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 :doc:`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 :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.

#. On a chromium based browser, such as Chrome, go to the CharaChorder `Device Manager <https://manager.charachorder.com/config/layout/>`__
#. Click “Connect”
Expand All @@ -155,7 +155,7 @@ site <https://www.charachorder.com/pages/update-your-firmware>`__.
At this point, your CharaChorder X will automatically reboot and the
CharaChorder drive will have disappeared. Congratulations! You have
successfully updated your device. You can check your device’s firmware
version by following the steps :ref:`here<Checking your Device’s Firmware>`.
version by following the steps :ref:`here<CharaChorder X:Checking your Device’s Firmware>`.

Understanding the Settings
--------------------------
Expand All @@ -165,15 +165,15 @@ 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>` the `ESC` key and the letter `g` **(G + ESC)** in 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.

.. warning::
**A bug currently exists on Windows 11 default Notepad app where chording doesn't load correctly. We are looking into this, but, for now, we recommend using a different app.**

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:


Expand All @@ -191,14 +191,14 @@ decrease these, you can use the up and down arrow keys on your keyboard.

``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>`.

The Layout
-------------

The CharaChorder X uses your keyboard's layout, so you don't have to learn a new one. The CharaChorder X reads the keycodes that your keyboard sends and makes use of them to produce outputs on your computer. The only drawback to this is that the CharaChorder X is unable to read keypresses that do not send a code. One common key that doesn't send a code is the Fn key. This key serves as a layer-access key, locally on your keyboard, that allows you to reach the F-keys. Although the CharaChorder X is unable to read the Fn keypress, the F-keys (F1-F24) will send out a keycode, and, thus, the CharaChorder X will send out that signal to the computer.

Additionally, the CharaChorder X enables you to make use of two extra layers as well. In order to reach those layers, you will have to :doc:`remap<Remapping>` your keyboard to include the layer access keys. Nonetheless, you can continue reading below to learn how the layers work on the CharaChorder X.
Additionally, the CharaChorder X enables you to make use of two extra layers as well. In order to reach those layers, you will have to :ref:`remap<Device Manager:Remapping>` your keyboard to include the layer access keys. Nonetheless, you can continue reading below to learn how the layers work on the CharaChorder X.

Layers
~~~~~~
Expand Down Expand Up @@ -268,7 +268,7 @@ Configurability
You can change the layout of your keyboard while it's connected to the CharaChorder X, which means that you can
:doc:`remap<Glossary>` almost all keys. Some users may
choose to :doc:`remap<Glossary>` their device’s layout to accommodate missing keys, such as the :doc:`DUP key<CharaChorder Keys>`. For a thorough explanation on how remapping
works and how to remap your device, visit the :doc:`remapping section<Remapping>`
works and how to remap your device, visit the :ref:`remapping section<Device Manager:Remapping>`

Practice
~~~~~~~~
Expand Down
10 changes: 5 additions & 5 deletions docs/CharaChorder_Lite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ When searching for switches that fit the CCL, make sure that the switches are la
.. _60% Keyboard Diagram:
.. image:: /assets/images/60%KB.jpg
:width: 1200
:alt: A diagram of a 60% Keyboard
:alt: A diagram of a 60% Keyboard

.. note::
Despite being a 60% keyboard, the CharaChorder Lite DOES have 4 arrow keys.
Expand Down Expand Up @@ -334,7 +334,7 @@ Learning the Layout
:width: 1200
:alt: Image showing the CharaChorder Lite default layout

The CharaChorder Lite's layout is mostly traditional QWERTY. All of the letters and numbers are where you would expect them on other keyboards. However, there are some keys that are moved around, and a couple of extra keys as well. We'll describe the Lite's layout below. Remember that you can always :ref:`remap<DeviceManager:Layout>` the keys to your liking on the `CharaChorder Device Manager <https://manager.charachorder.com>`__.
The CharaChorder Lite's layout is mostly traditional QWERTY. All of the letters and numbers are where you would expect them on other keyboards. However, there are some keys that are moved around, and a couple of extra keys as well. We'll describe the Lite's layout below. Remember that you can always :ref:`remap<Device Manager:Remapping>` the keys to your liking on the `CharaChorder Device Manager <https://manager.charachorder.com>`__.

Earlier, we explained that the CharaChorder Lite is a 60% keyboard. It's been named that because it's missing the navigation keys usually present on 65% keyboards, though it still has four arrow keys. Therefore, it is accurate to refer to the CCL as a 60%+6 keyboard, where the 6 refers to keys that aren't usually on a 60% keyboard. Additionally, the CCL has 67 keys, instead of the 61 keys that 60% keyboards traditionally have.

Expand Down Expand Up @@ -365,7 +365,7 @@ else. Your device will always be in the A1 layer upon boot.

While the A1 layer is active on the CharaChorder Lite by default, you can
map the A1 access key, which bears the name “KM_1_R” or “KM_1_L”, on the
:doc:`layout manager<Device Manager:layout>` site. There is no real need to map the A1 access keys.
:doc:`layout manager<Device Manager>` site. There is no real need to map the A1 access keys.

.. image:: /assets/images/LiteLayoutAlpha.png
:width: 1200
Expand Down Expand Up @@ -393,7 +393,7 @@ A3 Layer
^^^^^^^^

The A3 layer, sometimes referred to as the “function layer”, is
accessible with the :ref:`A3 access key<CharaChorder Keys>`. This key is not mapped by default on the CharaChorder Lite, but you can add it to your device by :ref:`remapping<Remapping>`. On the :ref:`CharaChorder Device Manager<Device Manager>`, this key is assignable by the names “KM_3_L” and “KM_3_R”.
accessible with the :ref:`A3 access key<CharaChorder Keys>`. This key is not mapped by default on the CharaChorder Lite, but you can add it to your device by :ref:`remapping<Device Manager:Remapping>`. On the :doc:`CharaChorder Device Manager<Device Manager>`, this key is assignable by the names “KM_3_L” and “KM_3_R”.

Once you've mapped the A3 layer access buttons, the A3 Layer is accessible by pressing and holding either
one of them. You do not have to hold them both in order to access
Expand Down Expand Up @@ -447,7 +447,7 @@ The CharaChorder Lite’s layout is configurable, which means that you can
:doc:`remap<Glossary>` all keys. Though the QWERTY layout is loved by many, some users may
choose to :doc:`remap<Glossary>` their device’s layout to better
suit their personal needs. For an explanation of how remapping
works and how to remap your device, visit the :ref:`remapping section<DeviceManager:Layout>`.
works and how to remap your device, visit the :ref:`remapping section<Device Manager:Remapping>`.

Practice
~~~~~~~~
Expand Down
Loading
Loading