Skip to content

Add missing chapter references to command list #41

@Ununp3ntium115

Description

@Ununp3ntium115

Add Missing Chapter References to Command List

Problem Summary

The command list table in the documentation has inconsistent chapter references. Some commands have chapter references (e.g., <<RGB LED Color Processing>>), while others are missing them. This makes navigation more difficult for users trying to find detailed information about specific commands.

Current State

Location: doc/AbletonPush2MIDIDisplayInterface.asc, lines 237-265

Commands Missing Chapter References:

  • 0x04 - Get LED Color Palette Entry
  • 0x05 - Reapply Color Palette
  • 0x07 - Get LED Brightness
  • 0x15 - Get LED White Balance
  • 0x19 - Set Touch Strip LEDs
  • 0x21 - Get Pad Velocity Curve Entry
  • 0x29 - Get Selected Pad Settings
  • 0x31 - Set Pedal Curve Limits
  • 0x32 - Set Pedal Curve Entries

Commands WITH References (for comparison):

  • 0x03 - Set LED Color Palette Entry .3+|<>
  • 0x06 - Set LED Brightness .2+|<>
  • 0x09 - Get Display Brightness .2+|<>
  • 0x1A - Request Statistics |<>

Impact

  • Priority: Low (documentation enhancement)
  • User Experience: Makes it harder to navigate to command details
  • Consistency: Improves documentation consistency

Proposed Fix

Add chapter references to all commands that are missing them. The references should point to the appropriate sections where each command is described in detail.

Code Fix

--- a/doc/AbletonPush2MIDIDisplayInterface.asc
+++ b/doc/AbletonPush2MIDIDisplayInterface.asc
@@ -237,7 +237,7 @@ arguments are avoided.
 |+0x03+ | |Set LED Color Palette Entry .3+|<<RGB LED Color Processing>>
-|+0x04+ |yes|Get LED Color Palette Entry
+|+0x04+ |yes|Get LED Color Palette Entry |<<RGB LED Color Processing>>
 |+0x05+ | |Reapply Color Palette
+|+0x05+ | |Reapply Color Palette |<<RGB LED Color Processing>>
 |+0x06+ | |Set LED Brightness .2+|<<Global LED Brightness>>
-|+0x07+ |yes|Get LED Brightness
+|+0x07+ |yes|Get LED Brightness |<<Global LED Brightness>>
 |+0x08+ | |Set Display Brightness .2+|<<Display Backlight>>
 |+0x09+ |yes|Get Display Brightness .2+|<<Display Backlight>>
 |+0x0A+ |yes|Set MIDI Mode |<<MIDI Mode>>
 |+0x0B+ | |Set LED PWM Frequency Correction |<<PWM Frequency>>
 |+0x13+ |yes|Sample Pedal Data |<<Pedal Sampling>>
 |+0x14+ | |Set LED White Balance .2+|<<White Balance>>
-|+0x15+ |yes|Get LED White Balance
+|+0x15+ |yes|Get LED White Balance |<<White Balance>>
 |+0x17+ | |Set Touch Strip Configuration .3+|<<Touch Strip>>
 |+0x18+ |yes|Get Touch Strip Configuration
+|+0x18+ |yes|Get Touch Strip Configuration |<<Touch Strip>>
-|+0x19+ | |Set Touch Strip LEDs
+|+0x19+ | |Set Touch Strip LEDs |<<Touch Strip>>
 |+0x1A+ |yes|Request Statistics |<<Statistics>>
 |+0x1B+ | |Set Pad Parameters |<<Pad Parameters>>
 |+0x1D+ |yes|Read 400g Pad Values From Flash |<<Individual Pad Calibration>>
 |+0x1E+ | |Set Aftertouch Mode .2+|<<Aftertouch>>
 |+0x1F+ |yes|Get Aftertouch Mode
+|+0x1F+ |yes|Get Aftertouch Mode |<<Aftertouch>>
 |+0x20+ | |Set Pad Velocity Curve Entry .2+|<<Velocity Curve>>
-|+0x21+ |yes|Get Pad Velocity Curve Entry
+|+0x21+ |yes|Get Pad Velocity Curve Entry |<<Velocity Curve>>
 |+0x22+ | |Set Temporary 400g Pad Values |<<Individual Pad Calibration>>
 |+0x23+ |yes|Flash LED White Balance|<<White Balance>>
 |+0x28+ | |Select Pad Settings .2+|<<Pad Settings>>
-|+0x29+ |yes|Get Selected Pad Settings
+|+0x29+ |yes|Get Selected Pad Settings |<<Pad Settings>>
 |+0x30+ | |Configure Pedal .3+|<<Pedal Configuration>>
-|+0x31+ | |Set Pedal Curve Limits
+|+0x31+ | |Set Pedal Curve Limits |<<Pedal Configuration>>
-|+0x32+ | |Set Pedal Curve Entries
+|+0x32+ | |Set Pedal Curve Entries |<<Pedal Configuration>>
 |===

Verification Steps

  1. Verify all chapter references exist in the document
  2. Test that AsciiDoc cross-references resolve correctly
  3. Build documentation and verify links work
  4. Check that format matches existing entries

Additional Notes

  • This is a documentation enhancement, not a bug fix
  • Improves consistency and navigation
  • Low risk change
  • Should be verified against actual chapter IDs in the document

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions