Thanks for the first feedback. I did not check the spelling whatsoever, just wanted to get an idea on how you want to structure the documentation. In my impression, the cli page is simply not obvious but thats mainly what I wanted to check with you. I'll fix the spellings once you let me know if the suggested way is okay with you.

You mean whether update should go before or after FAQ? The only objection I have to the update document itself is that Git is essentially also shell, so I'm not too sure about the particular name.

Hey Frenzie,
let me try to re-phrase my proposal:

I wanted to improve the docu for all users and gather most of the information in one place - the documentation.

Why do I want to do that:
Even though I already contributed to FreshRSS and wrote an extension, I struggled to get my installation back up after a failed update ... just because I couldn't locate the docu.
Currently its simply unclear where the users should look for more infos.
There are at least 3 places currently:

• the main README
• the README in the cli directory
• the documentation
  Some of the documentation is not even really linked somewhere (like the FAQ or the cli/README.md with the update infos.

My questions:
As I currently can't see a strategy on where you want the documentation to be located - what do you think where users look for more infos first. Shall we move all the infos into one place and just place some strategic links, so users can help themself? I think by doing that, you can even save time when answering issues. Just drop the proper link and thats it.

Normally the project devs don't need the docu (or only to link to it from issues) and thats why they don't see the problems for end-users. Lets make it that way: I will re-arrange the docu in another PR and you have a look if that fits your ideas as well.

Hello @kevinpapst and thanks for helping 👍
The current strategy is to have a summary in the readme files, and a full, detailed documentation on https://freshrss.github.io/FreshRSS/ (which is generated from https://github.com/FreshRSS/FreshRSS/tree/master/docs ).

I think we should keep the readme files (maybe slightly reduce some sections), and add some more links from the readme files to the main documentation. The main documentation should indeed be very much improved, and help is welcome :-)

To be fair, there are 4 links from the main readme to the CLI readme ;-)

I have already added some more links from the readme to the documentation in the /dev version https://github.com/FreshRSS/FreshRSS/blob/dev/README.md but more would be needed when the corresponding sections are actually developed in the main documentation.

There is also a bit more substance in the issues themselves, often with the "Documentation" tag, which would need to be copied into the main documentation. https://github.com/FreshRSS/FreshRSS/issues?q=label%3ADocumentation

@kevinpapst Other than needing to look up some stuff in the French docs in the past, just going to the docs seemed mostly reasonably self-evident to me. :-)

Right on, thats what I wanted to read!
@Alkarex maybe it was really to late, as I couldn't find the links in the main README ;-)
@Frenzie to me as well, thats why it took so long for me to find the right infos.

Ok. Then I will create a new PR based on the dev branch and look through the open issues as well.
I'll leave this one open until then for discussion.