On Tue, 23 Mar 2021 05:32:16 GMT, Jonathan Gibbons <[email protected]> wrote:
> Please review an update to the structure and some of the content of the
> generated Help page, focussed on the following:
>
> * A new section at the top of the Help page headed "Navigation", providing an
> overview of how to navigate around the docs.
> * The HELP button in the top navbar for each kind of generated page now links
> to the corresponding section in the help page. This implies the need for some
> additional sections, which are now provided.
>
> Given other ongoing work, it is likely that there will be additional
> improvements to the content still to come.
>
> We have talked about reordering the buttons in the navbar. At the same time,
> we might want to consider the order of sections in the page (as a separate
> issue.)
This is an excellent upgrade to the help page, Jon.
The only problem I found is a wrong link in the Index section at the bottom.
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
line 250:
> 248: doclet.help.index.body=\
> 249: The {0} contains an alphabetic index of all classes, interfaces,
> constructors, methods, \
> 250: and fields in the documentation, as well as summary pages such as
> {0}.
The link at the end of the sentence is the same as the one at the beginning of
the sentence, which is the main index page. I think you probably meant to link
to one of the summary pages.
-------------
Marked as reviewed by hannesw (Reviewer).
PR: https://git.openjdk.java.net/jdk/pull/3144
