Documentation restructure: Main structure

[tigert]

There is need to revise documentation for MobiFlight. The current set of docs is both out of date and also spread between the website and the Mobiflight wiki.

Here is a structure I pulled from the top of my head as to what we should do - there is a clear need for a well structured user guide that consists of the following. Feel free to comment below if you think something is missing or could be organized differently, and I can edit the entry based on feedback.

Also, MobiFlight is a community, and to have great documentation to support the growing user community, we are calling for help from the more experienced users and those who have an interest in improving the situation. MobiFlight would not be what it is today without you!

For the docs we could have:

• Quickstart guide / introduction to MobiFlight

  • Flight simulator connection: MSFS+WASM / XPlane, sim status menu
  • Arduino:
    • Connected devices,
    • Firmware flashing
    • Adding a switch and led, wiring. Maybe a link to some good electronics 101 guide?
    • Parking brake switch and led tutorial (MSFS)
  • Joysticks and MIDI:
    • Setting up, making sure support is enabled, how to find controls in MF
    • Parking brake example with both basic Joystick and Midi (Xtouch?) (MSFS)
  • XPlane and FSUIPC connections - quick overview
  • WinWing / MiniFCU / Other off the shelf panels
    • Pointers to FAQ / wiki pages
    • Links to Flightsim.to / Xplane.to for profiles / @otyq profile list on github

• The feature guide

  • The feature walkthrough Sebastian linked above, explaining every feature,
    can be linked to via help button from MF UI

• Hardware guides

  • General page about setting up device, with links to a page each for each supported hardware device, wiring, how to use in configs. These could be linked to from the GUI as well.
    • Output devices
      • LED / Output
      • LED / 7-segment
      • Servos
      • Stepper motors
      • LCD display
      • Output shift registers
    • Input devices
      • Button / switch (also describe rotary switches)
      • Encoders
      • Analog input - potentiometers, hall sensors (analog)
      • Input shift registers
  • Power and wiring guide
  • Using led output for more power hungry devices: FETs and relays, led strips

• How to do logic in MF

  • NCalc and RPN, which one to use, and where
  • Few concrete examples utilising preconditions, config references, MF variables
    • Light and power logic, backlight dimmer
    • Transponder with one rotary

• Additional stuff

  • Link to Neil's blog posts to look up events
  • Troubleshooting guide
  • Intro to using LUA for x-plane
  • Extending MobiFlight: Custom output devices