RichFaces 4.0 ALPHA2 Documentation Status

Version 5

    Current Status

     

    • Migration Guide ~70%
    • Developers Guide ~20%
    • Component Reference ~50%
    • Component Development Kit Guide ~10%

     

     

    Near Term Tasks

     

    Longer Term Tasks

     

    Requirements for ALPHA2

    • All components included into A2 are documented. This can be a rough version of documentation, explaining how to put components to work. At least the following is necessary:
      • VDL documentation - should be generated with the help of CDK
        • Supported attributes
        • Supported behavior events
        • Supported facets
      • JavaScript docs - where applicable; should describe client-side API and also provide table of supported events and their attributes & properties (e.g. cancelable)
      • Existing CSS classes
      • JavaDoc
    Some user guide/manual (pure text & images) would be good to have also.

     

    Estimation on Effort and Time

    • Dependent on the number of components required for Alpha2
      • Approximately 1/2 to 1 day per component

     

    Communication