On Thu, Oct 01, 2020 at 11:03:00PM +0200, Ralf Hemmecke wrote:
> I have now converted (not yet completely perfect) some files to
> reStructuredText format so that they can be shown nicely on
> fricas.github.io.
>
> FAQ --> src/doc/sphinx/source/faq.rst
> INSTALL --> src/doc/sphinx/source/install.rst
> README --> README.rst
>
> While the README.rst now shows (with links) on the initial github page
>
> https://github.com/hemmecke/fricas/tree/rstdoc
> (my rstdoc branch as example)
>
> the other files look like this:
>
> https://hemmecke.github.io/fricas/faq.html
> https://hemmecke.github.io/fricas/install.html
>
> That would make it easier to point users to the exact place when someone
> asks on the mailing list.
>
> Somebody against integrating FAQ and install description into the web
> documentation?
In lynx current INSTALL shows nicer than the new version. INSTALL
should be readable as plain text and it is in toplevel directory
so that users can find it easily. Similarly README. FAQ is less
critical but also deserves to be at top level. AFAICS web servers
have no trouble showing text files. So only potential gain
is due to added links. However README is pretty short and
INSTALL is rather easy to navigate using text search, so
IMO gain from links is marginal.
The .rst files when viewed as plain text do not look bad,
however in total this change for me looks like unnecessary
complication.
--
Waldek Hebisch
--
You received this message because you are subscribed to the Google Groups
"FriCAS - computer algebra system" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/fricas-devel/20201001215423.GA19643%40math.uni.wroc.pl.
