documentation/wiki

[leissa]

Add documentation in the wiki.
See also issue AnyDSL/thorin#63

[klaasb]

Maybe we should just use this: https://github.com/blog/2233-publish-your-project-documentation-with-github-pages
There also seem to be documentation themes available for Jekyll.

[leissa]

This is how this looks like:
https://anydsl.github.io/impala/
Using:
https://github.com/AnyDSL/impala/tree/master/docs

[klaasb]

This: http://idratherbewriting.com/documentation-theme-jekyll/ seems to be a documentation theme for Jekyll that includes semi-automagic sidebars and search with "as-you-type".

[leissa]

What I like about the impala/docs solution is that the documentation is bundled with impala's repo.

[leissa]

To sum it up, here are the feature requests from my side:

• sidebar/TOC should be at least semi-automatic
• search bar with preferably 'find-as-you-type'
• markdown with syntax-highlighting for Impala (this means: it should be possible to define our own lexer)

Some features that would be nice but not necessarily a must-have from my side:

• hosted on github
• simple git push - no invoking of third-party tools
• theme maintenance of the theme by the theme's maintainers (in other words: no copy&paste of the theme into our repo)

github-docs with jekyll's documentation-theme seems to support all these feature except the last one.