-
Notifications
You must be signed in to change notification settings - Fork 4
Wiki style Manual
I’ve had an idea for a wiki manual. This would allow people to contribute to the manual easily.
The question is: is this really necessary? Perhaps we should just split the manual into easier-to-edit files.
Post any comments/criticism here:
devyn: post new comments at the bottom.
ultrasaurus: Currently, the Shoes manual is well-crafted documentation. Wikis almost by definition are not. I think it is important that the manual be thoughtfully edited and that changes can be carefully tracked. Therefore, I would not advise wiki editing of the manual.
devyn: I realize, but I could make some kind of wiki2git script, so we could choose what changes get pulled into the manual…
The point is, I think that many people are more comfortable editing Textile in a browser than on the command line. We could have git2wiki too, so the formats are inter-convertible…
Git + the command line is not great for people who are just learning how to program, and might scare them away from helping out with the project.
devyn: I want to bring this up again, this time with a little proof on my side. http://love2d.org/wiki/ is very nice documentation. I think we should do something like this.
zak: Firstly, this discussion belongs in github issues, or on the mailing list, as I’m sure some of the other members would like to participate in the discussion.
I’ve added this to the issue tracker with the existing discussion above and my comments here: http://github.com/shoes/shoes/issues/#issue/58