Re: Zero Install documentation web-site

"Bastian Eicher" <[email protected]> Sun, 16 Sep 2018 16:43:17 +0200
Newsgroups gmane.comp.file-systems.zero-install.devel
Message-ID <[email protected]>
> The current site does indeed seem bad on mobile. Do people want to read it
on their phones?

I can't speak for anybody else but I have in fact done so on occasion. :D

> readthedocs seems a bit slow. Testing a refresh on one page at random:
> [...]
> It seems to add some tracking scripts and some adverts too :-/

We could fix these issues by using GitHub Pages hosting instead of
ReadTheDocs. The same setup used for https://github.com/0install/web-site
should work here: Keep the sources on the "master" branch and put the
generated HTML on "gh-pages".
The actual build process with MkDocs is a single command and should be
fairly easy to run on AppVeyor or Travis CI.

> I don't mind moving to markdown if people prefer that to HTML. It does
indeed give nicer previews on GitHub. On the other hand, I don't feel we
suffer from a lack of documentation at the moment.

The documentation for Zero Install on Linux is pretty good indeed,
especially your detailed tutorials!
My main motivation for this is to have a place I can easily merge in the
much sparser Windows docs over time. If I find the time, I'd also like to
add some tutorials on using the various language runtimes available on
http://repo.roscidus.com/.

> In general, some things seem a little better (editing, separately
scrolling navigation, mobile) and some a little worse (speed, tracking, ads,
losing the search feature, non-folding menu, lack of control over ordering).

MkDocs has a built-in search feature which I hadn't enabled yet. I've turned
it on for https://0install.readthedocs.io/ now.

MkDocs also allows page ordering to be controlled manually
(https://www.mkdocs.org/user-guide/configuration/#documentation-layout).
However, I kind of prefer being able to just add new files and directories
without having to list them in a central file.

The non-folding menu is indeed a bit ugly. Maybe somebody can help out there
with a little JavaScript voodoo?