Is there already a place for documentation?

Over time, when the project grows, there will be the need for a structured project documentation.

Are there plans where this documentation will be stored? Is Github's Wiki any good? I always found it a little crappy and difficult to use, but I haven't really spent much time with it so the assessment can be unfair.

If there is need for it, and the project doesn't mind using non-Python tools, I can offer setting up and, if desired, also hosting a DokuWiki installation.

Hi Pekka,

Well thanks for motivating me :) and for your offer too - I have a whole server to play with, so hosting is not an issue. Link to the wiki is at the top.

I've installed Mediawiki - something I'm familiar with. The two sites will have separate account systems until we build a robust single sign-on system.

Next up is project site - I want to try Jekyll for that.

Cheers.

13.2k

Evgeny

updated 2010-04-27 12:24:51 -0600, answered 2010-04-27 12:23:15 -0600

edit flag offensive 0 remove flag delete link

Comments

@Evgeny aah great, hadn't seen the link. Good stuff! Let me know if you need a hand with filling the Wiki, e.g. from text files in the git repo.

Pekka (2010-04-27 12:59:43 -0600) edit

@Pekka, all documentation stuff is in forum/documentation. I've just installed wiki after reading your question. Feel free to edit - there are no dogs guarding it :).

Evgeny (2010-04-27 13:41:28 -0600) edit

add a comment see more comments

Is there already a place for documentation? edit

Comments

1 Answer

Comments

Is there already a place for documentation?