diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 9954dba0..ecff28d7 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,6 +1,5 @@ import { defineConfig } from 'vitepress' import type { DefaultTheme } from 'vitepress' -import { version } from '../../packages/core/package.json' import vite from './vite.config' const GETTING_STARTED: DefaultTheme.NavItemWithLink[] = [ @@ -17,6 +16,7 @@ const GUIDES: DefaultTheme.NavItemWithLink[] = [ ] const HELP: DefaultTheme.NavItemWithLink[] = [ + { text: 'Migration Guide', link: '/guide/migration' }, { text: 'Contributing', link: '/help/contributing' }, { text: 'FAQ', link: '/help/faq' }, { text: 'Troubleshooting', link: '/help/troubleshooting' }, @@ -60,14 +60,12 @@ export default defineConfig({ ], }, { - text: '💚️ Sponsor', - link: 'https://github.com/sponsors/webfansplz', + text: 'Migration Guide', + link: '/guide/migration', }, { - // text: `v${version}`, - // items: VERSIONS, - text: `v${version} (current)`, - link: 'https://github.com/vuejs/devtools-next/releases', + text: '💚️ Sponsor', + link: 'https://github.com/sponsors/webfansplz', }, { text: 'Playground', diff --git a/docs/guide/browser-extension.md b/docs/guide/browser-extension.md index 3a25cf74..e25028d1 100644 --- a/docs/guide/browser-extension.md +++ b/docs/guide/browser-extension.md @@ -1,7 +1,7 @@ # Browser Extension :::tip Compatibility Note -The v7 version of devtools only supports Vue3. If your application is still using Vue2, please install the [v6 version](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd?utm_source=ext_sidebar). +The v7 version of devtools only supports Vue3. If your application is still using Vue2, please install the [v6 version](https://chromewebstore.google.com/detail/vuejs-devtools/iaajmlceplecbljialhhkmedjlpdblhp?utm_source=ext_sidebar?utm_source=ext_sidebar). ::: ## Chrome diff --git a/docs/guide/migration.md b/docs/guide/migration.md new file mode 100644 index 00000000..c9ef28bf --- /dev/null +++ b/docs/guide/migration.md @@ -0,0 +1,30 @@ +# Migration Guide + +:::tip Compatibility Note +The v7 version of devtools only supports Vue3. If your application is still using Vue2, please install the [v6 version](https://chromewebstore.google.com/detail/vuejs-devtools/iaajmlceplecbljialhhkmedjlpdblhp?utm_source=ext_sidebar?utm_source=ext_sidebar). If you're still using v5 version, you can install it [here](). +::: + +## Features Improvements + +In v7, we've made some feature-level adjustments compared to v6. You can view the v7 feature overview in the [Features](/getting-started/features). Here, we mainly mention some of the main feature changes. + +### Deprecated Features + +Due to high performance costs and potential memory leak risks, we have removed some features in v7. These features are: + +- `Performance` Timeline +- `Component Events` Timeline + +### Feature Adjustments + +- Timeline Tab + +In v7, we moved the timeline tab to be managed within each plugin's menu. Here is a screenshot of the pinia devtools plugin: + +![pinia-timeline](/features/pinia-timeline.png) + +## Plugin API + +In v7, we are fully compatible with the v6 plugin API (Except type). You can check out the [v6 Plugin API documentation](https://devtools-v6.vuejs.org/plugin/api-reference.html) here. + +Additionally, we have introduced some new plugin APIs. You can find more details [here](/plugins/api). diff --git a/docs/public/features/pinia-timeline.png b/docs/public/features/pinia-timeline.png new file mode 100644 index 00000000..b1ef9a18 Binary files /dev/null and b/docs/public/features/pinia-timeline.png differ