feat(migrating from v4): new section

olets · Nov 13, 2022 · 108c903 · 108c903 · vercel · Nov 13, 2022
1 parent a87d298
commit 108c903
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -201,6 +201,7 @@ export default {
             "/reference/performance.md",
           ],
         },
+        "/migrating-from-v4.md",
         {
           text: "Contributing",
           link: "/contributing/",

diff --git a/docs/migrating-from-v4.md b/docs/migrating-from-v4.md
@@ -0,0 +1,20 @@
+---
+prev:
+  text: Performance
+  link: /performance
+---
+
+# Migrating from v4
+
+:::danger
+These docs are for the not-yet-released v5.  
+For v4 docs see <https://github.com/olets/zsh-abbr>
+:::
+
+- Before upgrading, you may want to back up your user abbreviations file.
+
+    ```shell
+    cp $ABBR_USER_ABBREVIATIONS_FILE ~/path/to/the/new/user-abbreviations.bk
+    ```
+
+- zsh-syntax-highlighting users who highlight abbreviations will need to update their snippets. Follow the [Reference&nbsp;>&nbsp;Advanced&nbsp;>&nbsp;Syntax highlighting](/reference/advanced.html#syntax-highlighting) instructions.
diff --git a/docs/reference/performance.md b/docs/reference/performance.md
@@ -1,7 +1,7 @@
 ---
 next:
-  text: Contributing
-  link: /contributing/
+  text: Migrating from v4
+  link: /migrating-from-v4/
 ---
 
 # Performance