search

rufuspollock-okfn / bubbletree

Radial Bubble Tree Visualization
http://okfnlabs.org/bubbletree
152 stars 69 forks source link

Move documentation into wiki pages #4

Closed gka closed 12 years ago

gka commented 12 years ago

..and refine it thereby.

rufuspollock commented 12 years ago

Is it worth it compared to using proper pages?

gka commented 12 years ago

I found wiki pages easier to edit at the time I opened this issue. Of course, with the inline edit feature of github, it is now as easy to edit pages. However, I still find that wiki pages are the better place for documentation because they are (a) rendered in a clean and nice way, (b) more community friendly and (c) faster to setup and maintain than gh-pages. In fact, since github wikis are normal git repositories you can even edit and locally test wiki pages in the same way you can edit and test jekyll pages.

gka commented 12 years ago

Just changed my mind. Looking at the long list of open issues of the wiki engine it seems that nobody at github is really interested in that wiki feature anymore. Getting gollum to run locally is a pain in the ass since the latest version isn't compatible to the latest version of all dependent gems etc.

Instead I agree to keep the docs in the gh-pages branch, but we should make this a proper jekyll site instead of having our own site generator script (which I wrote without knowing about jekyll).