phoenicis icon indicating copy to clipboard operation
phoenicis copied to clipboard

Idea: add a FAQ tab

Open ImperatorS79 opened this issue 6 years ago • 6 comments

How it could look like: FAQ concept

The content could be a downloaded file so that we could update the FAQ whenever we want.

ImperatorS79 avatar Sep 06 '19 13:09 ImperatorS79

This could work. Here some additional questions:

  • how should Phoenicis react if no FAQ has been downloaded yet and it has no network connection?
  • should the FAQ be cached locally? If yes where?
  • in which format should it be provided? Markdown, HTML, some other format?

madoar avatar Sep 07 '19 08:09 madoar

  1. You say: "No connexion to download the FAQ"
  2. The FAQ should be a single file stored somewhere in .Phoenicis I guess
  3. A format which will not require more work that what is currently handled by phoenicis ^^.

ImperatorS79 avatar Sep 08 '19 15:09 ImperatorS79

Do you know other applications which handle it like this? I think normally there's only a link to a webpage, right?

plata avatar Sep 09 '19 17:09 plata

A lot of application have the docs alongside the app (hello LibreOffice). I also find it more ergonomic. But it is just an idea ^^.

ImperatorS79 avatar Sep 09 '19 17:09 ImperatorS79

I'm a bit afraid that we will duplicate the documentation/help.

plata avatar Sep 09 '19 17:09 plata

You can host the FAQ on github and provide it through phoenicis interface. (As a link somewhere, or as a tab). The choice is up to you ^^.

ImperatorS79 avatar Sep 09 '19 17:09 ImperatorS79