Shaarli: Improve documentation

[nodiscc]

Moving https://github.com/shaarli/Shaarli/wiki/TODO here

• [ ] add more screenshots
• [ ] improve developer documentation: storage architecture, classes and functions, security handling...
• [x] add server configuration examples: lighthttpd _WONTFIX_
• [x] Deduplicate/merge info from https://github.com/shaarli/Shaarli/blob/master/README.md

Other documentation related issues can be found at https://github.com/shaarli/Shaarli/labels/documentation

[virtualtam]

add more screenshots

• [x] Could be worth adding a _Shaarli installation 101_ page with concise, step-by-step instructions on how to get Shaarli running under a common configuration (Debian, Apache, PHP 5.6). This guide could then point to the existing pages for further details.

improve developer documentation: storage architecture, classes and functions, security handling...

• code: there's a lot of inline (docstrings) documentation for code that has been refactored, i.e. everything under application
  
  
  
  • reference documentation can be generated using Doxygen: make doxygen
  
  
• maintainer/developer: some pages are dedicated to Shaarli dev and maintenance, improvements may happen there

add server configuration examples: lighthttpd

I'll take care of this one ;-)

[virtualtam]

lighthttpd

• [x] I'm not sure whether it's actually used to run Shaarli? Most setups might rely on Apache HTTPD, Nginx, or the Docker image behind a reverse proxy.

more screenshots

It's actually unclear what Shaarli does by only reading the repository's README and the documentation's landing page. Both should provide information about the core feature(s) at a quick glance:

• [ ] concise description of the project (e.g. "Shaarli in a nutshell")
• [ ] a couple screenshots to see what the application looks like
• [x] links to other documentation pages: Getting Started, Installation, etc.

[nodiscc]

a couple screenshots to see what the application looks like

Are these ok?