These are all great suggestions.  If you can file them as jiras of type 
"documentation" that would be very helpful.

> On Dec 1, 2018, at 11:56 PM, Alex The Rocker <[email protected]> wrote:
> 
> 1.  This site must have navigation links, or better : breadcrumbs
> link, in all its pages.
>     Let me take an example: when I click on the link you gave as an
> example: http://tomee.apache.org/tomee-7.1/examples/application-composer.html,
> I arrive on a page which is missing the "context" : I should see that
> I am in a documentation page for TomEE version 7.1, subsection
> Examples, and I should be allowed to navigate from this page to "The
> root of all TomEE docs / The root of all TomEE 71 docs / The root of
> all Examples of TomEE 7.1 docs".
>     Alternative would be to show a TOC (Table Of Contents) next to
> all pages, but I personally find TOCs takes to much reading space,
> whereas breadcrumbs, if well designed (don't use too long identified
> for each "nesting") only take a short space, usual at the top of the
> displayed page (but under other navigation elements, like the Search
> bar, see #3 below).

We should definitely get that in there.  I'll be moving on to see if we can get 
javadoc in, but if someone wants to hack this is a great task.


> 2. It would be nice to have (not mandatory) a way to switch from
> version 7.1 of this page to 7.0 and 8.0.
> 
> 3. A missing feature is a Search bar  in the top of all pages,
> allowing to search documentation / examples on TomEE site.
> 
> 4. Would it be possible to add a "day / night switch button" ? (see
> the Sun/Moon icon at the top right hand side of this site:
> https://docs.influxdata.com/telegraf/v1.9/data_formats/template-patterns/),
> I love this one, but it's a  matter of taste here :)

Way out of my skill, but perhaps there's an enthusiastic developer out there :)

> 5. (hard) Access to the site from mobiles sucks, requires zooming.
> Ideally the styles should implement responsive web design to nicely
> fit pages in small displays.

We're using twitter bootstrap, which should be responsive except for tables.  
There's no way to make tables responsive as far as I know.

The margins look a little tight on the mobile version which should be tweaked, 
but other than that it looks responsive.  If you have a couple pages that don't 
look good (tables aside), that would be helpful.


-David
 

Reply via email to