Skip to content

Commit

Permalink
docs: improve migration guides
Browse files Browse the repository at this point in the history
  • Loading branch information
pionxzh committed Sep 15, 2024
1 parent 62824f9 commit 1f3f85f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 23 deletions.
8 changes: 2 additions & 6 deletions docs/pages/migration/migration-v3.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Migrating from v2 to v3

### Updating your dependencies

The very first thing you will need to do is to update your dependencies.

#### Update version
### Update version

```bash
npm install @textea/json-viewer@^3.0.0
Expand All @@ -19,7 +15,7 @@ Starting from v3, these dependencies are no longer included in the package's dep
npm install @mui/material @emotion/react @emotion/styled
```

### Handling breaking changes
### Breaking changes

#### Check browser compatibility

Expand Down
22 changes: 5 additions & 17 deletions docs/pages/migration/migration-v4.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,15 @@
# Migrating from v3 to v4

### Updating your dependencies

- Update `@mui/material` to `^6.0.0`

For `MUI` users, you can also check the [MUI v6 migration guide](https://mui.com/material-ui/migration/upgrade-to-v6/).

#### Update version
### Update version

```bash
npm install @textea/json-viewer@^4.0.0
npm install @mui/material@^6.0.0
```

#### Install peer dependencies

This package is using [Material-UI](https://mui.com/) as the base component library, so you need to install it and its peer dependencies.
Starting from v3, these dependencies are no longer included in the package's dependencies.

```bash
npm install @mui/material @emotion/react @emotion/styled
```
For `MUI` users, you should also check the [MUI v6 migration guide](https://mui.com/material-ui/migration/upgrade-to-v6/).

### Handling breaking changes
### Breaking changes

#### Check browser compatibility

Expand All @@ -38,4 +26,4 @@ The minimum supported version of TypeScript has been increased from `v3.5` to `v

`createDataType` has been deprecated in v3 and removed in v4. Use `defineDataType` instead.

For more information, please refer to [V3 migration guide](/migration/migration-v3#use-definedatatype-instead-of-createdatatype).
For more information, please refer to [V3 Migration Guide](/migration/migration-v3#use-definedatatype-instead-of-createdatatype).

0 comments on commit 1f3f85f

Please sign in to comment.