Improving Flatpak documentation

Allan Day allanpday at gmail.com
Mon Jan 9 11:38:42 UTC 2017


On Fri, Jan 6, 2017 at 6:53 PM, Jorge GarcĂ­a <jgarciao at gmail.com> wrote:
...

> > How do the changes to the site work? Are they just static pages?
>
> The minimal changes required are in PR119 [1]:  If the page starts with
> /docs the layout adds the docs_nav partial that renders the docs navigation
> tree on the left (see screenshot at PR120 [2] ).
> All the actual docs regular haml.markdown files
>

Cool, thanks for the information!


>
> > Are there any options for search?
>
> My changes are based on Middleman's website [3].
>

That looks nice!


> They have implemented search using DocSearch[4], but I haven't looked yet
> at this part.
>
> If you are interested I can try to see how it works. I also like the
> ReadTheDocs option, so whatever you think is best.
>

I'd be happy with either solution also. It's really up to the people
writing the docs and maintaining the website - meaning Alex and Jakub.
Jakub's expressed a preference for ReadTheDocs, since it means less
maintenance on the website.

Allan
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/flatpak/attachments/20170109/76a7bf3c/attachment.html>


More information about the xdg-app mailing list