Hi, Jeremy I've been spending some time reading through the changes you've been making, but have been a little swamped to take time to provide good feedback. Hopefully, I can provide more feedback later this week!
On the whole, the changes are indeed on the right track and I saw evidence of several points being addressed, which is great. I'm trying to think more from a whole picture perspective while also recalling some of my earlier struggles while reading through these changes and hope to provide some well-considered feedback. One bit of feedback I do have with regards to Virtual Rows documentation, that is also somewhat symptomatic of some of the other pages. The new format breaks things up a bit and thus is a little less dense, but its still dense. I think the main reason is simply that Virtual Rows isn't really defined up front. Three questions come to mind just about anytime I show somebody virtual rows or try to tell 'em what it is (and I still don't do a good job at it): "what are virtual rows?" "why do virtual rows exist?" and then finally, the bit you do have well documented with the last submissions: "how do you use virtual rows?" Just a quick shout out for now... Michael On Mon, Apr 19, 2010 at 4:20 PM, Jeremy Evans <[email protected]>wrote: > On Apr 14, 12:16 pm, Michael Lang <[email protected]> wrote: > > That last one actually brings up an idea....what about some documentation > > that takes a tutorial approach to demonstrating Sequel's usage. > > You'll have to be a bit more specific about what you want in this > case. I think you might be referring to something like the SteamCode > blog entries on Sequel and Ramaze, but I'm not sure. I'm OK with the > idea of tutorials in general, but there would need to be a pretty > strong focus on teaching Sequel usage as opposed to just solving a > usually contrived problem. I guess this is an area where I'd probably > judge each proposed addition on it's own merits. > > > One other thing, although there's lots of documentation on the main site, > > going from one theme to another is disorienting. So finding a way to > make > > generated rdocs, and hand-written docs a bit more alike would help a lot. > > If the hand-written docs had hrefs back to the rdocs (or vice versa) to > aid > > jumping to/from pages/sections, that would be very beneficial to > exploring > > the docs more. When I get lost in the docs, I drop back to Google and > hunt > > for stuff rather than staying within the documentation pages and trying > to > > click the many auto-generated links. > > Hopefully > http://github.com/jeremyevans/sequel/commit/4bcf03412f9af88fc147e3521f0740ebecdc1a3d > does a good job on tying the guides to the class/method RDocs. > There's probably more places in the class/method RDocs where I should > link to the guides, feel free to send patches if you find any. > > Thanks, > Jeremy > > -- > You received this message because you are subscribed to the Google Groups > "sequel-talk" group. > To post to this group, send email to [email protected]. > To unsubscribe from this group, send email to > [email protected]<sequel-talk%[email protected]> > . > For more options, visit this group at > http://groups.google.com/group/sequel-talk?hl=en. > > -- http://codeconnoisseur.org -- You received this message because you are subscribed to the Google Groups "sequel-talk" 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/sequel-talk?hl=en.
