Arti - mechanized docs for Rails
Rich Morin <[email protected]> Mon, 12 Mar 2007 03:07:02 -0800
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <p06230976c21adcc1f537@[192.168.1.205]> |
I've been working on a mechanized documentation system, called Arti, that harvests information from a Rails app and presents it as a set of (Rails) web pages. Although the system is still quite young, I think I'm getting some useful and interesting results from it. My first venture was an "embedded" version of Arti, running in the context of the Cheating Hangman app. http://hangman.cfcl.com I then decided to grab a substantial, well-known Rails app (Mephisto) to try documenting. This time, I opted to run Arti in "remote" mode. That is, Arti operates as a completely separate app, accessing the "target" app only as needed to gather information. I am reasonably happy with the results so far. Arti is able to display File, RDoc, and Stats listings, as well as a Plot for each View. With some help, I'll be able to generate some useful "View Linkage Summary" plots (akin to those seen in the Cheating Hangman). Anyway, I'd like some feedback on the current program, as well as the aforementioned help on knowing what to put into the View Linkage Summary plot(s). http://mephisto-ar.cfcl.com -r -- http://www.cfcl.com/rdm Rich Morin http://www.cfcl.com/rdm/resume [email protected] http://www.cfcl.com/rdm/weblog +1 650-873-7841 Technical editing and writing, programming, and web development