Improving Flatpak documentation

[Jorge García]

Hi,

> 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

> Are there any options for search?

My changes are based on Middleman's website [3]. 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.

Best regards,
Jorge


[1]
https://github.com/flatpak/flatpak.github.io/pull/119/commits/20d1598bb9e943241c39f01a8f150b51f9692a41
[2] https://github.com/flatpak/flatpak.github.io/pull/120
[3] https://middlemanapp.com/basics/install/
[4] https://github.com/middleman/middleman-guides/pull/593


On Fri, Jan 6, 2017 at 6:16 PM, Allan Day <allanpday at gmail.com> wrote:

> On Fri, Jan 6, 2017 at 5:09 PM, Jorge García <jgarciao at gmail.com> wrote:
> ...
>
>> Another option could be adding the section in the current flatpak.org
>> website.
>>
>> I sent a PR some days ago with a proposal and working code some days ago
>>
>> https://github.com/flatpak/flatpak.github.io/pulls
>>
>
> Yes I saw that - thanks for doing it! I was hoping to use some of the docs
> whatever happens.
>
> How do the changes to the site work? Are they just static pages? Are there
> any options for search?
>
> Allan
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/flatpak/attachments/20170106/f6d7bb92/attachment.html>