> There is somewhat of a wiki: > http://en.wikibooks.org/wiki/Ruby_Programming [it's even linked to from > deep within the nether-reaches of the ruby-lang.org website]. I suppose one option would be to put tutorials into said wiki, then add a link to them within the rdocs in core. > I did notice from http://webri.tigerops.org/ that many classes [ex: > BigDecimal] already have tutorial like information in the class > description. For some reason that information isn't in the rdocs I'm > not sure why [1]. I suppose that means that an option is to put all > tutorial information into the class' rdocs... Example if I go into trunk/ext/bigdecimal and run "rdoc" in that directory, shouldn't the generated rdoc's have BigDecimal's description somewhere? [they don't seem to, at least with 2.4.3] Is this expected? > [1] might be related to this: > http://rubyforge.org/tracker/index.php?func=detail&aid=26410&group_id=627&atid=2472 So assuming that those tutorials "are there" (and this is a temporary bug) this means that some classes have tutorial info already so...to me it would seem to make sense that, if you add more tutorial info, you want to add it into the rdoc base somehow, so that it can be a sibling to the existing tutorials and not split them up. I think I finally understand Robert's original objection--it is that "if it's a tutorial, shouldn't it be basically in some tutorial section somehow, not mixed in ad hoc with the rdoc's?" One way to attempt to not "mix them in together" might be to create the tutorials are in a sub folder, i.e. trunk/doc/tutorials, then one can generate "tutorial only" rdocs by running rdoc from within that subfolder. It wouldn't (easily) contain backlinks to the class description themselves, but it would give you all the tutorials in a single rdoc. Would that help? The other thought is "if it's not a wiki, it's not user editable". I'm not sure of an easy way around that one...maybe have a "staging wiki" for the tutorials that people can edit, that has a maintainer who tracks changes and submits "good ones" to core? Thoughts? =r -- Posted via http://www.ruby-forum.com/.