Consolidate the documentation

[jtojnar]

At the moment documentation is spread between the README, website and wiki, often with information duplicated. We should move the documentation to the repository and generate the website from it and README.

[akash07k]

Really a great idea of consolidating the documentation indeed.
I'm wondering that why it got so delayed. :(

[jtojnar]

Like many other open-source software project, selfoss does not have many developers. And when we find some time to spare, we tend to spend it on fixing bugs or disentangling the whole jQuery spaghetti.

This is further complicated by the fact that we also need to redesign the website to accommodate for all these new pages.

[akash07k]

Ya bro, you are right. I'll try my best to write the documentation if you want.

…

On 10/5/19, Jan Tojnar ***@***.***> wrote: Like many other open-source software project, selfoss does not have many developers. And when we find some time to spare, we tend to spend it on fixing bugs or disentangling the whole jQuery spaghetti. This is also made complicated by the fact that we need to redesign the website to accommodate for all these new pages. -- You are receiving this because you commented. Reply to this email directly or view it on GitHub: #979 (comment)

[jtojnar]

The hardest part is not even writing the docs but coming up with a website structure.

I classified the sections on the current website based on how much it makes sense to me to include them:

Introduce selfoss, okay:

• features
• screenshots

Show how to set it up, not sure:

• requirements
• installing
• configuring
• importing

Show advanced usage, less sure:

• shortcuts
• updating
• list of configuration options – too long

For developers, probably not:

• Extending selfoss
• API

Credits and legal info, maybe still:

• License
• About

I based this mostly on the assumption that the main page should attract new users. It should not contain unnecessary details but it also should not be just huge scrolling wallpaper with no content (see Wallabag website).

Looking at websites of few other self-hosted apps for inspiration:

• https://miniflux.app/ – website not very shiny but documentation is divided into admin, user & developer sections
• https://tt-rss.org/ – not well structured, just a landing page + unstructured wiki
• https://freshrss.org/ – very nice landing page, content-wise close to something I had in mind; docs also split into admin, user & developer sections but navigation there is not very clear
• https://www.wallabag.org/en ­– main page lacks info, docs link is at the bottom, plus it brings scrollmageddon; docs in GitBook again with the same split
• https://vikunja.io/ – I love this site, especially the docs section is well structured, though maybe I would merge home and features
• https://matomo.org/ – looks too business oriented, with case studies