Add v2.1.2 release notes

RiptideNetworking · Dec 10, 2023 · e7138e2 · e7138e2
1 parent 5b02cc6
commit e7138e2
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/Docs/manual/overview/installation.md b/Docs/manual/overview/installation.md
@@ -15,7 +15,7 @@ There are a number of ways to install Riptide, depending on what you're working
 1. In your Unity project, open the Package Manager (Window > Package Manager).
 2. Click the `+` (plus) button in the top left corner of the window.
 3. Select the *Add package from git URL...* option.
-4. Enter the following URL: `https://github.com/RiptideNetworking/Riptide.git?path=/Packages/Core#2.1.1`. To install a version other than v2.1.1, replace the `2.1.1` after the `#` with your chosen version number.
+4. Enter the following URL: `https://github.com/RiptideNetworking/Riptide.git?path=/Packages/Core#2.1.2`. To install a version other than v2.1.2, replace the `2.1.2` after the `#` with your chosen version number.
 5. Click 'Add' and wait for Riptide to be installed.
 
 If you have errors in your project after installation or intellisense isn't working for Riptide's classes, go to Edit > Preferences > External Tools, make sure the box next to *Git packages* is checked, and then click *Regenerate project files*.

diff --git a/Docs/manual/toc.yml b/Docs/manual/toc.yml
@@ -18,6 +18,8 @@
         href: updates/release-notes/v2.1.0.md
       - name: v2.1.1
         href: updates/release-notes/v2.1.1.md
+      - name: v2.1.2
+        href: updates/release-notes/v2.1.2.md
     - name: Upgrade Guides
       items:
       - name: Updating to v2

diff --git a/Docs/manual/updates/release-notes/v2.1.2.md b/Docs/manual/updates/release-notes/v2.1.2.md
@@ -0,0 +1,18 @@
+---
+_description: Release notes for Riptide v2.1.2.
+---
+
+# v2.1.2 Release Notes
+
+Install this version with Unity's Package Manager using the following URL ([step-by-step instructions](~/manual/overview/installation.md#option-1-unity-package-manager)):
+```plaintext
+https://github.com/RiptideNetworking/Riptide.git?path=/Packages/Core#2.1.2
+```
+
+It can also be installed a number of [other ways](~/manual/overview/installation.md#net-projects) for use outside of Unity, including as a [NuGet package](https://www.nuget.org/packages/RiptideNetworking.Riptide).
+
+For a full list of source code changes, check out the [version comparison](https://github.com/RiptideNetworking/Riptide/compare/v2.1.1...v2.1.2) on GitHub.
+
+## Fixes
+
+- Fixed <code><xref:Riptide.Message.AddBytes*></code> not resetting data segments, which could cause the data from previous messages to bleed over ([#124](https://github.com/RiptideNetworking/Riptide/issues/124)).