Docs: Add hint to @comet/upgrade

vivid-planet · Jan 30, 2024 · e3a772d · e3a772d
1 parent a903075
commit e3a772d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/docs/docs/migration/index.md b/docs/docs/migration/index.md
@@ -2,3 +2,17 @@
 title: Migration
 sidebar_position: 12
 ---
+
+Codemods for automated updates, such as renames, are available at [@comet/upgrade](https://github.com/vivid-planet/comet-upgrade).
+
+Example usage for upgrading from v4 to v5 (each major version should be upgraded separately):
+
+```
+npx @comet/upgrade v5
+```
+
+:::caution
+
+Codemods are designed to ensure that upgrades are as smooth as possible, so their use is highly recommended.
+
+:::