From e0f2ae5e40b98732db9efa31c991638fed6099db Mon Sep 17 00:00:00 2001 From: Ostrzyciel Date: Fri, 23 Aug 2024 13:31:35 +0200 Subject: [PATCH] Docs: add links to release notes --- docs/docs/index.md | 7 ++++++- docs/docs/user/compatibility.md | 6 ++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/docs/index.md b/docs/docs/index.md index 57e218ab..498d74b1 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -51,7 +51,7 @@ The following table shows the compatibility of the Jelly-JVM implementation with | ----- | ----------- | ---- | ----- | ----------- | ------------ | | **1.0.x (current)** | 3.3.x (LTS)
2.13.x[^1] | 11+ | 4.x.x | 4.x.x | 1.0.x | -See the **[compatibility policy](user/compatibility.md)** for more details. +See the **[compatibility policy](user/compatibility.md)** for more details and the **[release notes on GitHub](https://github.com/Jelly-RDF/jelly-jvm/releases)**. ## Documentation @@ -65,9 +65,14 @@ Below is a list of all documentation pages about Jelly-JVM. You can also browse - [Reactive streaming](user/reactive.md) - [gRPC](user/grpc.md) - [Useful utilities](user/utilities.md) + - [Compatibility policy](user/compatibility.md) + - [Scala 2.13 builds](user/scala2.md) - Developer guide - [Releases](dev/releases.md) - [Implementing Jelly for other libraries](dev/implementing.md) +- [Contributing to Jelly-JVM](contributing.md) +- [License and citation](licensing.md) +- [Release notes on GitHub](https://github.com/Jelly-RDF/jelly-jvm/releases) - [Main Jelly website]({{ proto_link( '' ) }}) – including the Jelly protocol specification and explanation of the various stream types. diff --git a/docs/docs/user/compatibility.md b/docs/docs/user/compatibility.md index 7dae0d0b..665a069b 100644 --- a/docs/docs/user/compatibility.md +++ b/docs/docs/user/compatibility.md @@ -6,7 +6,7 @@ Jelly-JVM follows [Semantic Versioning 2.0.0](https://semver.org/), with MAJOR.M The current version of Jelly-JVM is compatible with Java 11 and newer. Java 11, 17, and 21 are tested in CI and are guaranteed to work. We recommend using a recent release of [GraalVM](https://www.graalvm.org/) to get the best performance. -Jelly is built with [Scala 3 LTS releases](https://www.scala-lang.org/blog/2022/08/17/long-term-compatibility-plans.html). +Jelly is built with [Scala 3 LTS releases](https://www.scala-lang.org/blog/2022/08/17/long-term-compatibility-plans.html), however, [Scala 2.13-compatible builds are available as well](scala2.md). ## RDF libraries @@ -26,5 +26,7 @@ Auto-generated classes in the `jelly-core` module, `eu.ostrzyciel.jelly.core.pro ## See also -- [Contributing to Jelly-JVM](../contributing.md) +- [Scala 2.13 builds](scala2.md) +- [Release notes on GitHub](https://github.com/Jelly-RDF/jelly-jvm/releases) - [Making Jelly-JVM releases](../dev/releases.md) +- [Contributing to Jelly-JVM](../contributing.md)