From d876e7e41ef8a7447be569f0a75a63ab5456a23c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tam=C3=A1s=20G=C3=A1lffy?= <ezittgtx@gmail.com>
Date: Sun, 18 Feb 2024 14:54:49 +0100
Subject: [PATCH] doc: Upgrading

---
 README.md         |  5 +++++
 docs/upgrading.md | 36 ++++++++++++++++++++++++++++++++++++
 mkdocs.yml        |  1 +
 3 files changed, 42 insertions(+)
 create mode 100644 docs/upgrading.md

diff --git a/README.md b/README.md
index 67623b09..05f329b4 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,11 @@ After adding *netfox* to your project, make sure to enable the addons in your
 project settings. Otherwise, Godot will present you with errors about
 undeclared identifiers.
 
+## Upgrading
+
+If you're upgrading from an older version of netfox, refer to the [upgrade
+guide](docs/upgrading.md).
+
 ## Usage
 
 See the [docs](https://foxssake.github.io/netfox/).
diff --git a/docs/upgrading.md b/docs/upgrading.md
new file mode 100644
index 00000000..c7d64837
--- /dev/null
+++ b/docs/upgrading.md
@@ -0,0 +1,36 @@
+# Upgrading netfox
+
+Improvements are fixes are added to netfox with time, based on user feedback,
+resulting in newer versions. This page is inteded to help you with upgrading
+your game to a newer netfox version.
+
+## General advice
+
+### Have a backup
+
+**Make sure to have a backup** of your project before upgrading. While most
+often an addon update should be harmless, it is a good practice to backup your
+project regularly, and specifically before risky changes.
+
+### Disable the addon(s)
+
+Before upgrading, disable the netfox addon(s) in your project, in Project
+Settings. After the upgrade, enable the addon(s) again.
+
+This helps with cases where an autoload or a project setting is changed.
+
+## Version-specific steps
+
+This section has version-specific entries where extra actions might be
+necessary. Versions where the general advice holds are left out.
+
+Make sure to apply all the steps between the versions, e.g. if you're updating
+from 1.0.0 to 1.3.0, refer to the sections between the two versions, in this
+case v1.1.1. If there are no sections here for your version range, that means
+that the upgrade should need no extra action, aside from replacing the old
+netfox addon(s) with the new one(s).
+
+### v1.1.1
+
+* Remove `Interpolators` from the project autoloads, it's a static class now.
+
diff --git a/mkdocs.yml b/mkdocs.yml
index c9db0804..8214587a 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -2,6 +2,7 @@ site_name: netfox
 theme: readthedocs
 nav:
   - 'index.md'
+  - 'upgrading.md'
   - netfox:
     - Tutorials:
       - 'netfox/tutorials/responsive-player-movement.md'