Tiki Wiki For LLVM ?

Project Infrastructure LLVM Dev List Archives
1

As I've been reviewing the LLVM documentation, I noticed several typos
or things that could be explained in more detail. My compulsion was to
just go and fix it, but I can't do that because I have no access to the
sources.

Has there been any thought of putting up a Tiki Wiki for LLVM?

If you're not familiar with Tiki Wiki, its a PHP/MySQL based content
management system. It's pretty powerful and has a huge number of
features that would be very useful for documenting/discussing LLVM. Tiki
Wiki allows you to write documentation in plain text but displays it as
HTML. You can quickly organize pages into hierarchical structures and
automatically generate tables of contents. Each page can have a comments
section at the bottom. There are blogs, discussion forums, directories
of topics, galleries, FAQs, quizes, trackers, surveys, newletters, etc.
ad nauseum. It can be set up in about a day. Content can be imported
from HTML. For end users it is like using an information portal .. very
powerful.

If you'd like to go this way, I'd help you set it up. All you need is a
1/2 decent Linux machine, MySQL, Apache, and TikiWiki -- all free. You
can find out more about TikiWiki here:

http://tikiwiki.org/TikiWiki

Note that that site is itself a TikiWiki. Browse around to discover
what's possible. It looks like a lot, but its _incredibly_ simple to set
up.

Reid.

2

As I've been reviewing the LLVM documentation, I noticed several typos
or things that could be explained in more detail. My compulsion was to
just go and fix it, but I can't do that because I have no access to the
sources.

You should have the primary documentation in your llvm tree under
llvm/docs. The web page is currently in a private CVS tree, but if there
was interest, I guess we could open it up. *shrug* We *welcome* doc
patches. :slight_smile: (they should be sent to the llvm-bugs list)

Has there been any thought of putting up a Tiki Wiki for LLVM?

Not much. I don't really have a strong opinion on LLVM using them, but I
tend to dislike them in general. Overall, we're planning on moving the
"formal" documentation to docbook slowly, and I think that's the right
approach. A wiki might be a decent way to set up some specialized
discussion groups or as a way to hold informal discussions.

Personally I tend to be very worklist driven from my inbox. If the wiki
could be set up to email me when something happens, I wouldn't mind it in
particular. I do strongly think that the official documentation should be
in a more structured format, and under CVS (though I know that wiki's are
"version controlled").

Just my $.02,

-Chris