RFR: 8294074: Make other specs more discoverable from the API docs [v2]
Iris Clark
iris at openjdk.org
Wed Jul 30 18:56:54 UTC 2025
On Wed, 30 Jul 2025 12:06:49 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
>> make/Docs.gmk line 251:
>>
>>> 249: the Java virtual machine, and various tools, protocols, and file formats pertaining \
>>> 250: to the Java platform.</p> \
>>> 251: #
>>
>> @hns Is this wording that is agreed elsewhere or are you open to suggestions on how this should be worded?
>
> This wording is what we came up with in internal discussion, but certainly open to suggestions. I created this PR to make the process more transparent.
Minimally, I would not refer to the narrative specs which are part of the platform as "Related documents" since that makes them sound weakly advisory/informational. Perhaps something like "[Additional specifications][../specs/index.html] for the Java language...".
Also, if you're going to provide a link to the narrative specs, I'd also consider adding a reference to the external spec page (https://download.java.net/java/early_access/jdk25/docs/api/external-specs.html).
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/26547#discussion_r2243602685
More information about the build-dev
mailing list