DOCUMENTATION AND EXAMPLES !!!!

[ikos2201]

Hi !

Guys, I really appreciate things you're doing. RichFaces is very powerful framework with many cool things.

But the resources are awful. We have 2 main resources for your framework

http://docs.jboss.org/richfaces/latest_3_3_X/en/devguide/html/rich_togglePanel.html

http://showcase.richfaces.org/richfaces/component-sample.jsf?demo=dataTable&sample=tableFiltering&skin=blueSky

(just links. the main idea is that we have DOCS and SHOWCASE where we can find any useful information )

The Documentation is ancient really. A lot of old features (components attributes, etc.) , features we can't use in RichFaces 4. No information about something new.

We have a lot of new propertiees in RichFaces 4

but we don't know what they are created for (I can only  guess) , we don't have any place to find out ! ( e.g. =)  I want to know - how to customize collapsiblePanel header but I have only simple example in showcases )

Don't forget about documentation please. You are doing an amazing things, but with no docs most of your work are useless .

P.S. maybe I was a little bit rough , please excuse me for that !

[jhuska]

Hello John,

firstly, thank you for your feedback.

I am not sure whether I understand everything correctly. Have you seen the docs for RichFaces 4 as well (you are referencing the 3.3)?

Here you can find all of them:

http://docs.jboss.org/richfaces/

What I found most interesting is combination of:

VDL doc: http://docs.jboss.org/richfaces/4.3.X/4.3.3.Final/vdldoc/

and component reference: http://docs.jboss.org/richfaces/4.3.X/4.3.3.Final/Component_Reference/en-US/html_single/

for a particular component.

I am not saying we do not have to do anything more. There is always something to do Documentation improvement is also one of the RichFaces 5 targets. Checkout https://github.com/richfaces/richfaces-docs

where we ported all the documentation into asciidoc. The documentation will be then more easily edited (edit button in github) and therefore hopefully will attrack more commiters from the community. With community help we will be able to build even better framework.

Have I helped you somehow or you have already seen those ? Additional feedback is welcomed.

[ikos2201]

Thanks a lot . You have really helped me ! )