Skip to content

Commit

Permalink
docs: add migration guide (#608)
Browse files Browse the repository at this point in the history
  • Loading branch information
webfansplz committed Sep 14, 2024
1 parent 0c53e89 commit 7891be1
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 8 deletions.
12 changes: 5 additions & 7 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -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[] = [
Expand All @@ -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' },
Expand Down Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/browser-extension.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
32 changes: 32 additions & 0 deletions docs/guide/migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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](https://chromewebstore.google.com/detail/vuejs-devtools-v5/hkddcnbhifppgmfgflgaelippbigjpjo).
:::

## 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

💡 By the way, we are looking for a balanced approach to re-enable it with better performance. You can follow the latest progress [here](https://github.com/vuejs/devtools-next/issues/609).

### 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).
Binary file added docs/public/features/pinia-timeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7891be1

Please sign in to comment.