From eef24a368ae91aba305558f02c36a81b896929de Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Wed, 14 Dec 2022 13:02:18 +0100 Subject: [PATCH] docs: add migration page Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com> --- docs/src/.vitepress/config.ts | 5 +++++ docs/src/migration/index.md | 21 +++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 docs/src/migration/index.md diff --git a/docs/src/.vitepress/config.ts b/docs/src/.vitepress/config.ts index 41f35209..e9ca57e9 100644 --- a/docs/src/.vitepress/config.ts +++ b/docs/src/.vitepress/config.ts @@ -122,6 +122,11 @@ export default defineConfigWithTheme({ link: '/examples/', activeMatch: '^/examples/', }, + { + text: 'Migration', + link: '/migration/', + activeMatch: '^/migration/', + }, { text: 'TypeDocs', link: '/typedocs/', diff --git a/docs/src/migration/index.md b/docs/src/migration/index.md new file mode 100644 index 00000000..28313857 --- /dev/null +++ b/docs/src/migration/index.md @@ -0,0 +1,21 @@ +# Migration Guide + +## Migrating to 1.6.0+ + +### Additional Components are now split into separate packages + +If you're using Vue Flow at 1.6.0, please avoid using the `@vue-flow/additional-components` package, as it will *not* +work with Vue Flow 1.6.0+. + +Instead, install the components from their respective packages. + +These packages include: + +- [`@vue-flow/background`](/guide/components/background) +- [`@vue-flow/controls`](/guide/components/controls) +- [`@vue-flow/minimap`](/guide/components/minimap) + +### Panel Component + +The `Panel` component has been moved into the `@vue-flow/core`package. +If you're using it, please update your imports accordingly.