I'd like to know what plans, prospects, and/or wishes folks have for Rails 3 documentation. I'm assuming that YK et al will add some of Merb's documentation goodness:
* method headers with Real Information (TM) * public / plugin / private flags However, other things may be in prospect; for example, there was talk a while back about the possibility of using YARD as a new foundation for Merb API docs. Is this idea still being considered? Inquiring minds need to know... I would also be interested in collecting feedback on RDoc- based doc tools, as used by Merb, Rails, and Ruby. In support of this, I have created a few wiki pages: * http://wiki.merbivore.com/documentation This is a start on a documentation summary page. It includes the main page of the merbivore wiki by reference and goes on from there. * http://wiki.merbivore.com/documentation/rdoc This page summarizes information on RDoc, as applied to Merb, Rails, and Ruby. * http://wiki.merbivore.com/documentation/wish_list These items include bug reports, enhancement requests, and more. They are gathered together here as fuel for discussion. (Feel free to file them with the relevant sites and/or development projects. :-) By way of full disclosure, I am considering using the Rails 3 API as a use case for Ontiki, a wiki I am developing. So, I need to know what folks think is bad and good about RDoc, etc. I would be particularly interested in hearing about which RDoc- based sites (see http://wiki.merbivore.com/documentation/rdoc) folks like, and why. What GUI features rock/fail, what needed info is missing or hard to find, etc. -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 --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "merb" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/merb?hl=en -~----------~----~----~----~------~----~------~--~---
