[general] Documentation for project
Open, HighPublic

Description

In general Plasma Mobile is project is lacking the required documentation, this is the biggest complaint we receive from the users. This is meta task for tracking documentation needs.

Various things we need to document,

  • General Architecture
  • How to contribute
    • Applications
    • Testing
    • Documentation
  • Deploying Plasma Mobile (for distributions)
    • Requirements for libhybris
    • Requirements for KWin wayland
    • Various important repositories
  • Porting Plasma Mobile to device
  • Installation
    • We currently support two methods of installaiton, one is full installation and other is MultiROM based installation, which is documented at KDE community wiki. Someone needs to review it and if something is not clear, it needs to be updated.
  • Project Status and short term, as well long term goals
    • I believe this Plasma Mobile phabricator board can be great resource for that, but one needs to document long term plans in wiki page however.
  • FAQ
    • Someone needs to prepare the list of FAQ, then I can write the answers for it.