1 Reply Latest reply on Jun 12, 2013 3:31 PM by bleathem

    Push Components' Reference Data out of RF5 Docs

    lfryc

      Hey guys,

       

      I have noticed each of the components in Component Reference contains referecen data:

       

       

      3.5.2. Reference data

       

       

       

      Similarly, VDL doc contains same information:

       

       

      Tag Information
      Component typeorg.richfaces.CommandLink
      Tag Namea4j:commandLink
      Renderer Typeorg.richfaces.CommandLinkRenderer
      Handler ClassNone

       

       

       

      The advantage of VDL doc is that it is automatically generated and so it doesn't need to be updated manually everytime something is changed.

       

      On the other hand, those are also not information which are used regularly - they are intented for advanced users and use cases.

       

      Thus I suggest to remove the Reference Data from Components Reference.

        • 1. Re: Push Components' Reference Data out of RF5 Docs
          bleathem

          Yes, either remove it, or pull it in dynamically from the vdl doc.

           

          Once 5.0.0.Alpha2 is underway, I'd like to hash out a re-stucture for the docs as we did for the build.  Starting with user stories so we can all agree what we are trying to get out of the docs.

           

          Brian