[Nitro] Documentation (was: Nitro/OG examples that show recommended...)

Peter Abrahamsen rainhead at gmail.com
Thu Sep 1 14:14:25 EDT 2005

I would expand on this to say that, IMHO, Nitro+Og+... s in desperate  
need of good documentation. The rdoc and walkthroughs are valuable,  
but they don't replace real documentation. Real documentation would  
have a bunch of best practices for all common tasks, as well as  
listings of all the tools you have in different contexts. Some of  
this could be built into the rdoc, but there ought to be several  
starting points outside of the source code or module structure.

It's been frustrating trying to learn how things work browsing either  
the source or the rdoc modules list. I can only find the information  
I'm looking for once I understand how the code works and is laid out,  
and even then it's spread out between too many files and modules. I  
don't think I should have to do that.

The constant stream of good, new features is impressive, but I think  
that some excellent documentation would do a lot to bring more people  
on to the project. Maybe that's where you're heading already, maybe  
you're waiting for the API to settle more before 1.0, I don't know.

I feel like it'll be some time before I understand Nitro well enough  
to write best practices or reference docs, but maybe there's  
something I can do to help. Let me know.


On Sep 1, 2005, at 6:32 AM, Walter wrote:

> I am new to Nitro/OG and am looking for examples that show the  
> recommended way of doing :
> 1.) Passing data to/from controller variables/form fields.
> I am assuming there are predefined "controls" that can take the  
> form data and validate it against certain constraints,  
> automatically convert the data to the desired format, and if there  
> is an error automatically populate the appropriate error list that  
> can be used to send the page back to the same page with error  
> messages. (similar to what Rails does with validation errors for an  
> AR object).
> Ideally this would also work with non OG managed classes as well????
> 2.) Is there a recommended directory layout for views/controllers.   
> If I have 3 controllers and they all have an index.xhtml page, is  
> there a recommend place to put these different files.
> 3.) An example of OG using compound primary keys, especially with  
> belongs_to, or other relations, especially when dealing with a  
> legacy database via an ODBC driver.
> 4.) An example of OG using sub-objects i.e. Person is an OG managed  
> class and it has an Address(line1, line2, city, st, zip).  So you  
> could have Person.find_something[0].address.city.  Is this even  
> possible with OG
> Overall it looks very promising, I would like to make sure I wrap  
> my ahead around the Nitro/OG concepts the way they were intended.   
> Something that puts it all together would be great.  Don't get me  
> wrong, the couple of blog examples are great, but it would be nice  
> to see more real world examples.  Is there anything I can be  
> directed to, to see something like this?
> Thanks,
> Walt
> -- 
> No virus found in this outgoing message.
> Checked by AVG Anti-Virus.
> Version: 7.0.344 / Virus Database: 267.10.17/85 - Release Date:  
> 8/30/2005
> _______________________________________________
> Nitro-general mailing list
> Nitro-general at rubyforge.org
> http://rubyforge.org/mailman/listinfo/nitro-general

More information about the Nitro-general mailing list