Not sure if this is the kind of input you're looking for, but my $0.02 fwiw...
I'm relatively new to merb, and I find that apart from the rdocs, most of the documentation around the web - on the wiki and various blogs, falls into the category of "how to" information. This is great and I certainly appreciate people sharing their experience, but I find that often as soon as I want to do something a little different from what others have described, I need a little deeper understanding of how merb actually works under the covers. The only way I've been able to do this, as many often recommend, is to start reading code. Well this is certainly educational, but it's pretty time-consuming, especially since this is not (yet) my day job. What I would find really helpful is a little more architectural documentation with some supporting visuals that would make the code a little more approachable. I'm certainly happy to make some contributions of this kind myself, but it will be a little while before I have enough momentum with the projects I have underway to be able to free up some time. Mark. On Feb 23, 3:44 pm, Rich Morin <[email protected]> wrote: > 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 (seehttp://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 Morinhttp://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 -~----------~----~----~----~------~----~------~--~---
