diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 1a38885d..f348ee3b 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -56,7 +56,10 @@ export default defineConfig({ sidebar: [ { text: 'Guide', - items: [{ text: 'Introduction', link: '/guide/' }], + items: [ + { text: 'Introduction', link: '/guide/' }, + { text: 'Migration from v3', link: '/guide/migrating-from-v3' }, + ], }, { text: 'Abstractions', diff --git a/docs/guide/migrating-from-v3.md b/docs/guide/migrating-from-v3.md new file mode 100644 index 00000000..3c1a08bc --- /dev/null +++ b/docs/guide/migrating-from-v3.md @@ -0,0 +1,94 @@ +# Migration Guide from v3 + +This guide is intended to help you migrate from Cientos v3 to v4 🤩✨. + +::: code-group + +```bash [pnpm] +pnpm update @tresjs/cientos +``` + +```bash [npm] +npm update @tresjs/cientos +``` + +```bash [yarn] +yarn upgrade @tresjs/cientos +``` + +::: + +## What's new? + +### Updated `defineExport` properties + +Since the beginning we exported our components' underlying `Three.js` instances using the name `value`. This created a very ambiguos situation with some components. When we access them using a `ref` in `