feat(midi): add documentation for v1.7 midi functions (#416)

Author: ArthurGibert

configurator/src/components/manual/Configurator.tsx

@@ -253,6 +253,34 @@ export const Configurator = () => (
     </List>
     <p>Refer to each app's manual to check if it uses the global quantizer.</p>
 
+    <H4>MIDI</H4>
+    <p>
+      Here you can configure which MIDI data is transmitted to each MIDI output,
+      essentially allowing Faderpunk to function as a MIDI router. You can also
+      choose whether the clock—configured in the <strong>CLOCK</strong>{" "}
+      section—is sent to each output.
+    </p>
+
+    <List>
+      <li>
+        <strong>None</strong>
+      </li>
+      No MIDI is sent to this output.
+      <li>
+        <strong>Local</strong>
+      </li>
+      Only MIDI generated by the <strong>apps</strong> is sent to this output.
+      <li>
+        <strong>MIDI Thru</strong>
+      </li>
+      Only MIDI received from the selected source is forwarded to this output.
+      <li>
+        <strong>MIDI Merge</strong>
+      </li>
+      Both MIDI generated by the <strong>apps</strong> and MIDI received from
+      the selected source are sent to this output.
+    </List>
+
     <H4>I²C Configuration</H4>
     <p>
       Faderpunk can operate as either a <strong>Leader</strong> or{" "}

configurator/src/components/manual/Interface.tsx

@@ -333,50 +333,74 @@ export const Interface = () => (
     <H3>Back Connectors</H3>
     <p>
       Faderpunk features a set of connectors on the rear panel, designed to
-      support power, communication, and integration with other gear:
+      support power, communication, and integration with other gear. The ability
+      to route and filter <strong>MIDI</strong> signals from inputs to output as
+      well as the ability to assign the <strong>apps</strong> to specific
+      physical <strong>IN/OUTs</strong> makes Faderpunk a very powerfull{" "}
+      <strong>MIDI router</strong>.
     </p>
     <List>
       <li>
         <strong>USB</strong>
         <br />
-        This port provides power to the unit and enables MIDI data transmission
-        as well as connection to the online Configurator.
+        This port powers the unit and enables bi‑directional MIDI communication
+        as well as connection to the online Configurator. It can transmit all
+        MIDI data generated by the <strong>apps</strong> (LFOs, envelopes,
+        modulation sources, etc.) and can also receive external{" "}
+        <strong>MIDI</strong> that can be routed internally using the{" "}
+        <strong>MIDI</strong> settings in the <strong>Configurator</strong>{" "}
+        section.
       </li>
+
       <li>
         <strong>I²C</strong>
         <br />
-        I²C is a digital communication protocol used by various modules such as
-        the Orthogonal Devices ER-301, Monome Teletype, and Expert Sleepers
-        Disting EX.
+        I²C is a digital communication protocol used by modules such as the
+        Orthogonal Devices ER‑301, Monome Teletype, and Expert Sleepers Disting
+        EX.
         <br />
         Faderpunk can operate as either a <strong>Leader</strong> or{" "}
-        <strong>Follower</strong> on the I²C bus. You can configure this
-        behavior in the <strong>Settings</strong> section of the Configurator.
+        <strong>Follower</strong> on the I²C bus, and can send or receive
+        parameter changes depending on the selected routing mode.
+        <br />
       </li>
+
       <li>
         <strong>MIDI In</strong>
         <br />
         A 3.5mm stereo jack that accepts incoming MIDI data.
         <br />
-        This connector is <strong>polarity agnostic</strong>, supporting both
+        This connector is <strong>polarity agnostic</strong> and supports both
         Type A and Type B MIDI standards.
+        <br />
+        Incoming data from this port can be routed to the outputs (MIDI out 1 &
+        2 as well as USB) according to the settings in the <strong>
+          MIDI
+        </strong>{" "}
+        section of the <strong>Configurator</strong>.
       </li>
+
       <li>
-        <strong>MIDI Out 1 & Out 2</strong>
+        <strong>MIDI Out 1 &amp; Out 2</strong>
+        <br />
+        These 3.5mm stereo jacks transmit MIDI data from Faderpunk.
         <br />
-        These 3.5mm stereo jacks transmit MIDI data from the Faderpunk.
+        The data sent depends on the selected routing mode:
+        <strong>Local</strong> (apps only), <strong>MIDI Thru</strong> (external
+        input only),
+        <strong>MIDI Merge</strong> (combined), or <strong>None</strong>.
         <br />
-        Both outputs send the <strong>same MIDI stream</strong>, as defined by
-        the active apps.
+        This configuration is independent for each output.
         <br />
-        When Faderpunk is set to use its <strong>internal clock</strong>, MIDI
-        clock signals are also sent through these outputs.
+        When using Faderpunk’s <strong>internal clock</strong>, MIDI Clock is
+        sent through these outputs as well if enabled in the clock routing
+        settings.
         <br />
         These connectors follow the <strong>Type A</strong> MIDI standard.
       </li>
     </List>
 
-    <H3>Rear Connectors Overview</H3>
+    <H3>Internal Connectors Overview</H3>
     <p>
       On the back of the Faderpunk PCB, you'll find a set of user-accessible
       connectors designed to expand functionality and integration:
@@ -392,23 +416,22 @@ export const Interface = () => (
         <strong>IO Expander (IO EXP)</strong>
         <br />
         Connects to the IO board located at the rear of the Faderpunk case, or
-        to compatible IO boards found in Intellijel or Befaco cases. This
-        provides USB and MIDI connectivity for seamless integration with
-        external gear.
+        to compatible IO boards found in Intellijel or Befaco cases.
       </li>
       <li>
         <strong>I²C Connector</strong>
         <br />
         Enables communication with I²C-compatible devices while Faderpunk is
-        mounted inside a case. This supports modular expansion and interaction
-        with devices like Monome Teletype, ER-301, and others.
+        mounted inside a case. This allows interaction with devices like Monome
+        Teletype, ER-301, and others.
       </li>
       <li>
         <strong>Programming Header (SWD, GND, SWCLK)</strong>
         <br />
         Used for firmware flashing and debugging via a compatible debug probe
         (e.g., Raspberry Pi Debug Probe), allowing for faster development and
-        troubleshooting cycles.
+        troubleshooting cycles. Please note that the labels on the PCB are
+        inverted (SWD is SWCLK and SWCLK is SWD)
       </li>
       <li>
         <strong>24-Pin Flat Flex Connector</strong>

configurator/src/components/manual/UpdateGuide.tsx

@@ -6,20 +6,20 @@ import { H2, H3, List } from "./Shared";
 
 export const UpdateGuide = () => (
   <>
-    <H2 id="download">Download firmware update</H2>
-    <ButtonPrimary
-      as="a"
-      href={`https://github.com/ATOVproject/faderpunk/releases/download/faderpunk-v${FIRMWARE_LATEST_VERSION}/faderpunk-v${FIRMWARE_LATEST_VERSION}.uf2`}
-    >
-      Download v{FIRMWARE_LATEST_VERSION}
-    </ButtonPrimary>
     <H2 id="update">Firmware Update Guide</H2>
+
     <p>
       This guide will walk you through updating your Faderpunk's firmware. Don't
       worry—it's simpler than it sounds! You'll essentially be copying a file to
       your device while it's in a special update mode.
     </p>
-
+    <H3 id="download">Download latest firmware</H3>
+    <ButtonPrimary
+      as="a"
+      href={`https://github.com/ATOVproject/faderpunk/releases/download/faderpunk-v${FIRMWARE_LATEST_VERSION}/faderpunk-v${FIRMWARE_LATEST_VERSION}.uf2`}
+    >
+      Download v{FIRMWARE_LATEST_VERSION}
+    </ButtonPrimary>
     <H3>What You'll Need</H3>
     <List>
       <li>Your Faderpunk</li>