Uploaded image for project: 'Causeway'
  1. Causeway
  2. CAUSEWAY-3505

The help page automatically created by docgen could be improved

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 2.0.0-RC1
    • 2.2.0
    • Core
    • None

    Description

      Observations:

      • all the content is on one very long page called "Welcome".  I feel this is too long.  Suggest:
        • one page for the menubars
        • a separate page for each object, as a "reference".
          • perhaps grouped as in a telephone directory, "A", "B", "C", ...
      • de-emphasis the diagrams ... at the moment they are the first thing that one clicks on, and they would be very technical to an end-user
          • perhaps provide a way to disable them globally
      • the spacing in the welcome page is uneven

      Also

      • there are some places where a bullet is shown within no text against it, eg in the demo app:

       

      and

       

      Attachments

        1. image-2023-06-27-06-54-52-226.png
          46 kB
          Daniel Keir Haywood
        2. image-2023-06-27-06-55-42-984.png
          49 kB
          Daniel Keir Haywood

        Activity

          People

            Unassigned Unassigned
            danhaywood Daniel Keir Haywood
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: