Skip to content

Visualize Your Ideas With Code

docs: add migration guide for 12.1.0 (#136)

Jacob81cba5d39dca
diff --git a/packages/docs/docs/guides/migration/12.1.0.md b/packages/docs/docs/guides/migration/12.1.0.md
new file mode 100644
index 00000000..aae5e72e
--- /dev/null
+++ b/packages/docs/docs/guides/migration/12.1.0.md
@@ -0,0 +1,53 @@
+---
+title: v12.1.0
+---
+
+# Migrating to version 12.1.0
+
+:::tip
+
+If you're starting a new project, you can quickly scaffold it using:
+
+```bash
+npm init @motion-canvas
+```
+
+:::
+
+## Install the new version
+
+Update your packages:
+
+```bash
+npm update
+```
+
+## Update project file
+
+```diff title="src/project.tsx"
+- import {Project} from '@motion-canvas/core';
++ import {makeProject} from '@motion-canvas/core';
+
+import scene from './scenes/example.tsx';
+
+- export default new Project({
++ export default makeProject({
+ scenes: [scene],
+});
+```
+
+## Update imports
+
+`createSignal` and `createComputed` have been moved to a new module:
+
+```diff title="src/project.tsx"
+- import {createSignal, createComputed} from '@motion-canvas/core/lib/utils';
++ import {createSignal, createComputed} from '@motion-canvas/core/lib/signals';
+```
+
+`useRef` has been renamed to `createRef`:
+
+```diff title="src/project.tsx"
+- import {useRef} from '@motion-canvas/core/lib/utils';
++ import {createRef} from '@motion-canvas/core/lib/utils';
+```