ja-rule icon indicating copy to clipboard operation
ja-rule copied to clipboard

User Manual Documentation

Open nomis52 opened this issue 10 years ago • 2 comments

This can be the tracking bug for the user manual. Things we need to cover include:

  • [ ] Introduction (move over from the dev manual main page)
  • [x] Accessing the USB console ( move over from dev manual: https://docs.openlighting.org/ja-rule/doc/latest/usb-logging.html )
  • [ ] Controller mode
    • [ ] what the LEDs mean
    • [ ] Resistor Biasing
  • [ ] Responder mode
    • [ ] What the LEDs mean (mute, identify etc.)
    • [ ] Resistor Biasing
    • [ ] Explanation of each different 'model'. There is existing text in each of the X_model.h files , follow the links from https://docs.openlighting.org/ja-rule/doc/latest/group__rdm__models.html
    • [x] How to switch between models (move over from dev manual: https://docs.openlighting.org/ja-rule/doc/latest/rdm-models.html )
  • [ ] Upgrading the firmware
    • [ ] Linux
    • [ ] Mac (should be similar to Linux)
    • [ ] Windows

nomis52 avatar Sep 09 '15 14:09 nomis52

Some progress in https://github.com/OpenLightingProject/ja-rule/pull/256 .

peternewman avatar Feb 17 '16 22:02 peternewman

More in https://github.com/OpenLightingProject/ja-rule/pull/259 .

peternewman avatar Feb 17 '16 23:02 peternewman