-
Notifications
You must be signed in to change notification settings - Fork 80
Description
Add Missing Cross-References in Documentation
Problem Summary
Several sections in the documentation mention related concepts or commands but don't include cross-references (AsciiDoc <<Chapter Name>> links) to help users navigate to the relevant sections. This makes the documentation harder to navigate.
Current State
Locations with Missing Cross-References:
-
Issue Animations not running correctly in User mode #26 fix (User mode animation, line ~690):
- Mentions "Port 2" and "User mode" but doesn't link to <> section
-
Issue How to translate Max For Live colors to Palette Color Index ? #22 fix (RGB conversion, line ~450):
- Mentions "Get LED Color Palette Entry" command (0x04) but doesn't link to its description
- Mentions "Set LED Color Palette Entry" command (0x03) but doesn't link to its description
- Mentions "Reapply Color Palette" command (0x05) but doesn't link to its description
-
Issue Post the default RGB color palette in its entirety (only a subset is displayed now in the docs). #27 fix (Full palette, line ~505):
- Mentions "Get LED Color Palette Entry" sysex command (0x04) but doesn't link to <> chapter
Impact
- Priority: Low (usability improvement)
- User Experience: Makes navigation more difficult
- Consistency: Other parts of the documentation use cross-references extensively
Proposed Fix
Add cross-references using AsciiDoc syntax <<Chapter Name>> to link to relevant sections.
Code Fix
Fix 1: Issue #26 - User Mode Animation Section
--- a/doc/AbletonPush2MIDIDisplayInterface.asc
+++ b/doc/AbletonPush2MIDIDisplayInterface.asc
@@ -687,6 +687,11 @@ After a MIDI stop message (+0xFC+), the animations continue to run at the
last received tempo. If the host never sent a MIDI start message, the animations
run at a tempo of 120 bpm.
-NOTE: In User mode, MIDI system real time messages (start, stop, continue, clock)
+NOTE: In <<MIDI Mode,User mode>>, MIDI system real time messages (start, stop, continue, clock)
must be sent on Port 2, as Port 1 MIDI messages are ignored in User mode.
If no MIDI start message has been received on the active port, animations
may not run at the default 120 bpm tempo until a MIDI start message is sent.Fix 2: Issue #22 - RGB Conversion Section
--- a/doc/AbletonPush2MIDIDisplayInterface.asc
+++ b/doc/AbletonPush2MIDIDisplayInterface.asc
@@ -444,6 +444,29 @@ Reply: ++[F0 00 21 1D 01 01 **04 7D 00 00 00 00 7F 01 7E 00** F7]++ = entry 125
Converting RGB Values to Color Palette Indices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Push 2 LEDs do not accept direct RGB values. Colors must be specified using
color palette indices (0-127). To convert an arbitrary RGB color to the closest
available palette index:
1. Retrieve the complete color palette by querying all 128 entries (0-127)
- using the "Get LED Color Palette Entry" command (0x04).
+ using the "Get LED Color Palette Entry" command (0x04) (see <<RGB LED Color Processing>>).
2. For each palette entry, calculate the distance between your target RGB
color and the palette entry's RGB values. Common distance metrics include:
@@ -461,6 +461,6 @@ available palette index:
-Alternatively, you can modify the palette to add custom colors by using the
-"Set LED Color Palette Entry" command (0x03) to overwrite existing palette
+Alternatively, you can modify the palette to add custom colors by using the
+"Set LED Color Palette Entry" command (0x03) (see <<RGB LED Color Processing>>) to overwrite existing palette
entries with your desired RGB values. After modifying palette entries, send
-the "Reapply Color Palette" command (0x05) to apply the changes.
+the "Reapply Color Palette" command (0x05) (see <<RGB LED Color Processing>>) to apply the changes.Fix 3: Issue #27 - Full Palette Note
--- a/doc/AbletonPush2MIDIDisplayInterface.asc
+++ b/doc/AbletonPush2MIDIDisplayInterface.asc
@@ -501,6 +501,12 @@ will be retained, most likely.
|7 |127 |white
|===
NOTE: The table above shows only a subset of the RGB color palette values.
-To retrieve the complete default RGB color palette (all 128 entries from index 0 to 127),
-use the "Get LED Color Palette Entry" sysex command (0x04) described in the
-<<RGB LED Color Processing>> chapter. Query each color index from 0 to 127 to
+To retrieve the complete default RGB color palette (all 128 entries from index 0 to 127),
+use the "Get LED Color Palette Entry" sysex command (0x04) described in the
+<<RGB LED Color Processing>> chapter. Query each color index from 0 to 127 to
obtain the full palette with RGB and white values for each entry.(Note: Fix 3 already has the cross-reference, but we can verify it's correct)
Verification Steps
- Verify all chapter IDs exist in the document
- Test that AsciiDoc cross-references resolve correctly when documentation is built
- Check that links work in the generated documentation
- Ensure format matches existing cross-references in the document
Additional Notes
- Cross-references improve document navigation significantly
- AsciiDoc syntax:
<<Chapter ID,Display Text>>or just<<Chapter ID>> - Should verify chapter IDs match exactly (case-sensitive)
- Low risk change, high usability benefit