summaryrefslogtreecommitdiff
path: root/website/src/docs/reference
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-08-05 20:59:07 +0900
committerGitHub <noreply@github.com>2026-08-05 20:59:07 +0900
commit8396304c01dce8e0a07cdcd647dfd35293019050 (patch)
tree66d615f6ca0b7a4bc5885cce59651d02baf9def1 /website/src/docs/reference
parentce1a6123f7d48100ba3b216746127ba269fe21fb (diff)
parent54c369939455bcfd7b66faa9d0a18aff901c05b0 (diff)
downloadLunaticChat-8396304c01dce8e0a07cdcd647dfd35293019050.tar.gz
LunaticChat-8396304c01dce8e0a07cdcd647dfd35293019050.tar.bz2
LunaticChat-8396304c01dce8e0a07cdcd647dfd35293019050.zip
Merge pull request #268 from m1sk9/fix/download-and-compatibility-versions
fix: Show the actual plugin versions on the download and compatibility pages, and mark feature-short pairs
Diffstat (limited to 'website/src/docs/reference')
-rw-r--r--website/src/docs/reference/compatibility.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/website/src/docs/reference/compatibility.md b/website/src/docs/reference/compatibility.md
index 23274ab..2adcea6 100644
--- a/website/src/docs/reference/compatibility.md
+++ b/website/src/docs/reference/compatibility.md
@@ -18,7 +18,7 @@ The **plugin version** (e.g., Paper v1.2.0) and the **protocol version** (e.g.,
## Compatibility Matrix
-Each cell indicates whether the corresponding Paper × Velocity combination can connect. Data is fetched from GitHub Releases automatically.
+Each cell indicates how far the corresponding Paper × Velocity combination works: ✓ where every feature is available, ⚠ where the pair connects but the older side cannot answer what the newer one adds, and ✗ where the handshake is rejected. Data is fetched from GitHub Releases automatically.
<CompatibilityMatrix />
@@ -42,7 +42,7 @@ The rules (from Velocity's perspective) are:
| Level | Example Change | Compatibility | Deployment Order |
|-------|---------------|---------------|------------------|
-| **PATCH** (1.0.0 → 1.0.1) | Adding optional fields, new sub-channels | Fully compatible (safe with `ignoreUnknownKeys=true`) | Any order, anytime |
+| **PATCH** (1.0.0 → 1.0.1) | Adding optional fields, new sub-channels | Connects (safe with `ignoreUnknownKeys=true`), but the older peer ignores the new sub-channel, so the feature behind it stays unavailable | Any order, anytime |
| **MINOR** (1.0.x → 1.1.0) | Adding required fields, changing existing sub-channel semantics | Backward compatible within `MIN_SUPPORTED_MINOR` range | **Update Velocity first** → then update each Paper server |
| **MAJOR** (1.x.x → 2.0.0) | Wire format changes, removing/renaming sub-channels | Incompatible | **Simultaneous deployment of all servers** |