RFR: cover the documentation linking options in release notes
Jesper Wilhelmsson
jwilhelm at openjdk.org
Thu Dec 18 16:32:20 UTC 2025
On Thu, 18 Dec 2025 14:43:24 GMT, Roger Calnan <duke at openjdk.org> wrote:
> added an explanation on the support of JavaDoc like links and the automatic linking of JBS IDs
src/guide/release-notes.md line 74:
> 72: As well as the standard [CommonMark link types](https://spec.commonmark.org/0.31.2/#links) the following custom links are supported:
> 73:
> 74: **Linking of JBS issues**
Please use actual headers (###) instead of **bold text** for these three sub-sections.
src/guide/release-notes.md line 76:
> 74: **Linking of JBS issues**
> 75:
> 76: * any JBS ID of the form `JDK-NNNNNNN` will be linked
Please use complete sentences with capital letter and period in all bullets.
src/guide/release-notes.md line 81:
> 79:
> 80: * the linking options defined in JavaDoc [MarkDown](https://openjdk.org/jeps/467#Links) are supported.
> 81: * links to the JDK tools is supported. To differentiate between `[JarSigner]` the class, and `[jarsigner]` the tool, the tool reference should be in all lowercase.
I think it would be nice if "JDK tools" was a link to the tools page. I know it's version specific, but the JDK 25 page should be good enough for a few years :-)
-------------
PR Review Comment: https://git.openjdk.org/guide/pull/167#discussion_r2631742403
PR Review Comment: https://git.openjdk.org/guide/pull/167#discussion_r2631748436
PR Review Comment: https://git.openjdk.org/guide/pull/167#discussion_r2631754342
More information about the guide-dev
mailing list