Add v4->v5 upgrade guide to the docs

mzur · Oct 11, 2023 · 870a66e · 870a66e
1 parent b8a9a4d
commit 870a66e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/upgrade-guide.md → docs/upgrade-guide-v3-v4.md b/docs/upgrade-guide.md → docs/upgrade-guide-v3-v4.md
@@ -1,4 +1,4 @@
-# Upgrade Guide
+# Upgrade Guide v3->v4
 
 There are a few breaking changes between Uniform v3 and v4. Mainly these were introduced to better fit new features and principles of Kirby 3. This guide lists all changes you have to make to your existing Uniform v3 code to make it work with Uniform v4 and Kirby 3.
 

diff --git a/docs/upgrade-guide-v4-v5.md b/docs/upgrade-guide-v4-v5.md
@@ -0,0 +1,9 @@
+# Upgrade Guide v4->v5
+
+There are only the following breaking changes between Uniform v4 and v5:
+
+- Form data is now HTML-escaped by default in the Dump, Email, Log and Webhook actions. Set the new `escapeHtml` option to `false` to disable escaping.
+
+- The `data()` method of the form now HTML-escapes form data by default. Set the new third argument to `false` to disable escaping.
+
+That's it!
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -31,7 +31,8 @@ nav:
         - AJAX: examples/ajax.md
         - Dynamic Fields: examples/dynamic.md
     - Answers: answers.md
-    - 'Upgrade Guide': upgrade-guide.md
+    - 'Upgrade Guide v4->v5': upgrade-guide-v4-v5.md
+    - 'Upgrade Guide v3->v4': upgrade-guide-v3-v4.md
 theme: readthedocs
 markdown_extensions:
     - toc: