[nhusers] Re: How could we enhance NH's documentation?

2009-05-27 Thread robert23
great idea stefan ! I just can say samples, samples, samples nothing explains better than short sample. Not only the xml source but also the .net code. I will help if I can. On 20 Mai, 13:05, Nexus wrote: > I volunteer to help on the documentation process > > On May 19, 3:51 pm, x97mdr wrot

[nhusers] Re: How could we enhance NH's documentation?

2009-05-20 Thread Nexus
I volunteer to help on the documentation process On May 19, 3:51 pm, x97mdr wrote: > If I may throw in my two cents as a user of NHibernate ... > > The Docbook is well-written and organized but sometimes you just want > to see how a specific method call works or what a particular class is > for.

[nhusers] Re: How could we enhance NH's documentation?

2009-05-19 Thread x97mdr
If I may throw in my two cents as a user of NHibernate ... The Docbook is well-written and organized but sometimes you just want to see how a specific method call works or what a particular class is for. Maybe an HTML Help file based on XML Comments from the source code would be beneficial? The

[nhusers] Re: How could we enhance NH's documentation?

2009-05-19 Thread rhartzog
I agree with the assessments noted here. It's not bad documentation, but finding it (especially finding what is relevent to which version) is a daunting task for a new NHibernate user. I started down the NHibernate path about 3 or 4 times before actually getting to the point of being able to imp

[nhusers] Re: How could we enhance NH's documentation?

2009-05-18 Thread Stefan Steinegger
@Fabio, I already wrote you a mail with some questions about where and how to write the documentation. I think it is very important. @Humberto: That's exactly what I mean. The documentation is mentioning many features and one can not understand what it is good for. Sometimes I struggled to find a

[nhusers] Re: How could we enhance NH's documentation?

2009-05-18 Thread Fabio Maulo
The doc available with sources is using DocBookhttp://www.docbook.org/ To have a WYSIWYG version a conversion to the last DocBook format is needed and, after that, you can use oXyGen (http://www.oxygenxml.com/). If somebody know a better way to have all things working Probably the wiki is no

[nhusers] Re: How could we enhance NH's documentation?

2009-05-18 Thread Humberto Marchezi
Documentation of a not-so-trivial tool like NHibernate is definitely an important issue. Provided of good documentation NH can become even more popular. I think there are some gaps to be filled such as: - More detailed explanation about collections. There are sets, maps, lists and bags but what a

[nhusers] Re: How could we enhance NH's documentation?

2009-05-18 Thread James Gregory
The NH docs are actually pretty damn good, sure there are some holes for the more complex features, but it's still considerably better than the majority of OSS projects out there. New users tend to have the initial problem of actually finding the central location, but once they're there I think it'

[nhusers] Re: How could we enhance NH's documentation?

2009-05-18 Thread Stefan Steinegger
Thanks, Sidar for your response and willingness to help. I'm a bit disappointed that nobody else answered to my questions. So I ask the other way around: - Are you quite happy with the NH documentation? - Do you find complete documentation about the features, and understand how to use it? If so

[nhusers] Re: How could we enhance NH's documentation?

2009-05-15 Thread Sidar Ok
Starting from the last: 1 - I would contribute as much as I can. I wholeheartedly agree that we need a structure and empty pages to fill in, this way contribution will be made easier as well. If I bump into a problem and solve it and feel it is valuable, I'll know I have to go under Frequent Prob