Add guide dynamic libraries #105

duianto · 2025-08-22T14:58:09Z

No description provided.

CCMaverick · 2025-08-22T22:07:05Z

docs/Chords.rst

+
+The same chord input can have a unique output in each dynamic library.
+
+For example, the chord: ``ar`` can output:


I want to lean away from using 2 letter inputs as examples because we discourage common bigrams as chord inputs, but, I like this example. I see no issue with it, but, just a note for you

CCMaverick · 2025-08-22T22:07:41Z

docs/Chords.rst

+To switch between dynamic libraries, we add library chords in the device
+manager's library editor: https://charachorder.io/config/chords/
+
+First we add a base library chord. This exits any dynamic library.


Add a comma after "First"

CCMaverick · 2025-08-22T22:07:51Z

docs/Chords.rst

+* chord: ``lib``
+* output: ``{action: base library}base``
+
+Then we add a dynamic library chord.


Add a comma after "Then"

CCMaverick · 2025-08-22T22:09:26Z

docs/Chords.rst

+#. Add an impulse chord: ``i + DUP``
+#. At the impulse output prompt, type: ``arm``
+#. Press: ``enter``
+#. At the impulse input prompt, chord: ``ar``


Change the chord input to our chord notation, "a+r"

CCMaverick · 2025-08-22T22:09:48Z

docs/Chords.rst

+   on a new line. We'll make it easier to erase the library name in the
+   next section.
+
+#. Add an impulse chord: ``i + DUP``


MODIFY
"Open the impulse chord menu:"

CCMaverick · 2025-08-22T22:10:18Z

docs/Chords.rst

+   next section.
+
+#. Add an impulse chord: ``i + DUP``
+#. At the impulse output prompt, type: ``arm``


ADD
"... type your desired output:"

CCMaverick · 2025-08-22T22:10:48Z

docs/Chords.rst

+
+   .. note::
+
+      It doesn't overwrite an existing chord on the base library.


REVISE
"Adding a chord in a dynamic library doesn't overwrite..."

CCMaverick · 2025-08-22T22:11:18Z

docs/Chords.rst

+   .. note::
+
+      It doesn't overwrite an existing chord on the base library.
+      Because it adds the dynamic library chord as a prefix.


Join this sentence with the previous one.
"..on the base library because it adds..."

CCMaverick · 2025-08-22T22:11:42Z

docs/Chords.rst

+
+   Now, while we're in the dynamic library: ``lib1``
+
+   * when we chord: ``ar``


Chord notation, please "a+r"

CCMaverick · 2025-08-22T22:12:20Z

docs/Chords.rst

+   * when we chord: ``ar``
+   * it outputs: ``arm``
+
+#. Switch to the base library, with the chord: ``lib``


REVISE
"Switch to the base library by using the base library chord we created earlier:"

CCMaverick · 2025-08-22T22:12:45Z

docs/Chords.rst

+
+   Now, while we're on the base library: ``base``
+
+   * when we chord: ``ar``


Chording notation

CCMaverick · 2025-08-22T22:13:10Z

docs/Chords.rst

+Select the dynamic library name automatically
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This isn't required, but it's a convenience.


REVISE
"This step isn't required..."

CCMaverick · 2025-08-22T22:14:12Z

docs/Chords.rst

+When we switch between dynamic libraries, the library chord outputs the
+library name. It's an extra step to erase the library name manually.
+
+Instead, let's select the dynamic library name automatically, by adding


Remove the comma

There are two commas 😄

I'm guessing the second comma, since the previous suggestion: #105 (comment)
didn't have a comma before "by":
"Switch to the base library by using the base library chord we created earlier:"

CCMaverick

Easy to understand manual. I never took the time to learn this, but now I know how to do it lol. Minor changes

CCMaverick · 2025-08-29T21:58:46Z

docs/Chords.rst

+
+Dynamic Libraries
+~~~~~~~~~~~~~~~~~
+


I'm thinking we give a brief explanation of what Dynamic Libraries are.

"Dynamic Libraries are a way with which you can store multiple different chord libraries on a device. You can switch between the different libraries by using a pre-defined chord. With Dynamic Libraries, you can use the same chord to produce different outputs, depending on what library is currently active."

CCMaverick · 2025-08-29T22:03:12Z

docs/Chords.rst

+* ``Eneot of Draconia`` in a library for Novel writing
+* ``OnePlus`` in a library for Cell Phone blogging
+
+Add dynamic library switching chords


Let's rename this to Dynamic Toggle Chords"
I think Dynamic toggle is pretty clear and unique enough that it won't be confused with other CC functions. You can add a note explaining this name immediately before the instructions in the section below. "We call these chords Dynamic Toggles." I kinda like your "library chords" but that can be confused with general chords in a library, which is how I was reading it until I really thought about it lol. I thought you meant to simply add a chord into the library, but then I realized that you're calling them Library chords... so, if I was confused I can imagine others may get confused as well.

CCMaverick · 2025-08-29T22:04:28Z

docs/Chords.rst

+To switch between dynamic libraries, we add library chords in the device
+manager's library editor: https://charachorder.io/config/chords/
+
+First, we add a base library chord. This exits any dynamic library.


REVISE:
"...base library chord. This is the Dynamic Toggle that we'll use to exit any dynamic library and return to the base library."

CCMaverick · 2025-08-29T22:07:52Z

docs/Chords.rst

+* chord: ``b+a+l+i``
+* output: ``{action: base library}base``
+
+Then, we add a work dynamic library chord.


Because we're dealing with new vocabulary that we're making up, we need to be careful with being extremely clear what each word means. "work dynamic library chord". Does that mean a working library? As in, simply a Dynamic library? Or does it mean something else? I propose revising to:
"Then, we add a Dynamic Toggle for a library used at work."

CCMaverick · 2025-08-29T22:14:44Z

docs/Chords.rst

+
+.. note::
+
+   Both the chords ``b+a+l+i`` and ``w+l+i+b``, and the dynamic library


In the spirit of being super clear, consider:
"The chords we used in the examples above (b+a+l+i and w+l+i+b) and their outputs (base and wlib) are merely examples; they don't have to be exactly that. You can make the chord inputs and their outputs whatever you want, as long as you include the dynamic library action in the chord output."

CCMaverick · 2025-08-29T22:15:54Z

docs/Chords.rst

+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Switch to the work library, by chording: ``w+l+i+b``
+#. It switches to the work library and outputs its name: ``wlib``


ADD: "in plain text." to the end of this last sentence.

CCMaverick · 2025-08-29T22:17:09Z

docs/Chords.rst

+
+#. Switch to the work library, by chording: ``w+l+i+b``
+#. It switches to the work library and outputs its name: ``wlib``
+#. You can ignore the name, erase it or just press ``enter`` to continue


In the spirit of keeping readable and consistent documentation, I like making any function keys and modifiers all caps. Idk how they appear on .io, but I really thing using all caps is a useful way to differentiate between modifiers and text. Thoughts?

Uppercase key names, modifiers, etc. #116

CCMaverick · 2025-08-29T22:18:06Z

docs/Chords.rst

+Add a chord in a dynamic library
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Switch to the work library, by chording: ``w+l+i+b``


Attempting to keep consistency, all of these should either have a period at the end, or not. I don't have a preference (I think), but we should be consistent.

The period was removed after the only list item with a period at the end.

CCMaverick · 2025-08-29T22:19:57Z

docs/Chords.rst

+#. Switch to the work library, by chording: ``w+l+i+b``
+#. It switches to the work library and outputs its name: ``wlib``
+#. You can ignore the name, erase it or just press ``enter`` to continue
+   on a new line. We'll make it easier to erase the library name in the


REVISE:
"...We'll get rid of the printed library name in the next section."

CCMaverick · 2025-08-29T22:23:21Z

docs/Chords.rst

+   * when we chord: ``r+a+l``
+   * it outputs: ``realtor@email.com``
+
+#. Switch to the base library by using the base library chord we


REVISE:
"...using the base Dynamic Toggle that we created earlier:"

CCMaverick · 2025-08-29T22:23:56Z

docs/Chords.rst

+   * when we chord: ``r+a+l``
+   * it outputs: ``really``
+
+Select the dynamic library name automatically


How about we make this a dropdown?

With the last section as a dropdown.

The last section might be overlooked.
The dropdown box with a right arrow on the right side, might be seen as just another navigation button, like the previous and next buttons below it.

And if a link to the last section, is added in the previous section:

We’ll get rid of the printed library name in the next section

Clicking on the link scrolls us to the bottom of the page, but it isn't obvious that the link is referring to the dropdown at the bottom of the page.

Without a dropdown.

You can't miss the there's another section when scrolling down the page.

Clicking the link: next section
Scrolls the section header: Select the dynamic library name automatically
to the top of the page.

CCMaverick · 2025-08-29T22:25:21Z

docs/Chords.rst

+library name. It's an extra step to erase the library name manually.
+
+Instead, let's select the dynamic library name automatically by adding
+these actions to the end of the library chord output.


REVISE:
"...end of the Dynamic Toggle chord output."

CCMaverick · 2025-08-29T22:27:05Z

docs/Chords.rst

+   {release_next}{left_shift}
+
+The number of ``{arrow left}`` actions should match the number of
+characters in the base and dynamic library names, in this case we used


REVISE:
"...in the dynamic library's name; in this case, we used..."

CCMaverick

Some comments for your consideration.

- Replaced the two letter chord with a three letter chord - Changed the image format from .webp to .png, because GitHubs diff doesn't support webp, with png the images are visible while reviewing a PR on GitHub.

Added an introduction. Changed: Dynamic Library Switching Chords And: Library Chords To: Dynamic Toggles Uppercased key names: ENTER, BACKSPACE Added images: Base Library Action Dynamic Library Action Dynamic Toggle chords without selecting the library names

duianto · 2025-08-31T14:57:57Z

Ready for review

CCMaverick reviewed Aug 22, 2025

View reviewed changes

docs/Chords.rst Outdated

Now, while we're on the base library: ``base``

* when we chord: ``ar``

Copy link

Collaborator

CCMaverick Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chording notation

CCMaverick reviewed Aug 22, 2025

View reviewed changes

CCMaverick requested changes Aug 22, 2025

View reviewed changes

duianto force-pushed the add-guide-dynamic-libraries branch from d44cd7c to 959e2d6 Compare August 25, 2025 17:32

CCMaverick reviewed Aug 29, 2025

View reviewed changes

Add guide dynamic libraries

b22b225

duianto added 3 commits August 31, 2025 12:17

chords, dyn lib, review suggestions

9a1f974

chords, dyn lib, change examples, and update screenshots

1589eb3

- Replaced the two letter chord with a three letter chord - Changed the image format from .webp to .png, because GitHubs diff doesn't support webp, with png the images are visible while reviewing a PR on GitHub.

duianto force-pushed the add-guide-dynamic-libraries branch from 959e2d6 to 7d5f2b2 Compare August 31, 2025 14:56


		The same chord input can have a unique output in each dynamic library.

		For example, the chord: ``ar`` can output:


		.. note::

		It doesn't overwrite an existing chord on the base library.


		Now, while we're in the dynamic library: ``lib1``

		* when we chord: ``ar``


		Now, while we're on the base library: ``base``

		* when we chord: ``ar``


		.. note::

		Both the chords ``b+a+l+i`` and ``w+l+i+b``, and the dynamic library

Add guide dynamic libraries #105

Are you sure you want to change the base?

Add guide dynamic libraries #105

Uh oh!

Conversation

duianto commented Aug 22, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CCMaverick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

With the last section as a dropdown.

Without a dropdown.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CCMaverick left a comment

Choose a reason for hiding this comment

Uh oh!

duianto commented Aug 31, 2025

Uh oh!

Reviewers

Assignees

Labels